frp 客户端的详细配置说明。

基础配置

参数类型说明默认值可选值备注

server_addrstring连接服务端的地址0.0.0.0

server_portint连接服务端的端口7000

nat_hole_stun_serverstringxtcp 打洞所需的 stun 服务器地址stun.easyvoip.com:3478

connect_server_local_ipstring连接服务端时所绑定的本地 IP

dial_server_timeoutint连接服务端的超时时间10

dial_server_keepaliveint和服务端底层 TCP 连接的 keepalive 间隔时间，单位秒7200负数不启用

http_proxystring连接服务端使用的代理地址格式为 {protocol}://user:passwd@192.168.1.128:8080 protocol 目前支持 http、socks5、ntlm

log_filestring日志文件地址./frpc.log如果设置为 console，会将日志打印在标准输出中

log_levelstring日志等级infotrace, debug, info, warn, error

log_max_daysint日志文件保留天数3

disable_log_colorbool禁用标准输出中的日志颜色false

pool_countint连接池大小0

userstring用户名设置此参数后，代理名称会被修改为 {user}.{proxyName}，避免代理名称和其他用户冲突

dns_serverstring使用 DNS 服务器地址默认使用系统配置的 DNS 服务器，指定此参数可以强制替换为自定义的 DNS 服务器地址

login_fail_exitbool第一次登陆失败后是否退出true

protocolstring连接服务端的通信协议tcptcp, kcp, quic, websocket, wss

quic_keepalive_periodintquic 协议 keepalive 间隔，单位: 秒10

quic_max_idle_timeoutintquic 协议的最大空闲超时时间，单位: 秒30

quic_max_incoming_streamsintquic 协议最大并发 stream 数100000

tls_enablebool启用 TLS 协议加密连接true

tls_cert_filestringTLS 客户端证书文件路径

tls_key_filestringTLS 客户端密钥文件路径

tls_trusted_ca_filestringTLS CA 证书路径

tls_server_namestringTLS Server 名称为空则使用 server_addr

disable_custom_tls_first_byteboolTLS 不发送 0x17true当为 true 时，不能端口复用

tcp_mux_keepalive_intervalinttcp_mux 的心跳检查间隔时间60单位：秒

heartbeat_intervalint向服务端发送心跳包的间隔时间30建议启用 tcp_mux_keepalive_interval，将此值设置为 -1

heartbeat_timeoutint和服务端心跳的超时时间90

udp_packet_sizeint代理 UDP 服务时支持的最大包长度1500服务端和客户端的值需要一致

startstring指定启用部分代理当配置了较多代理，但是只希望启用其中部分时可以通过此参数指定，默认为全部启用

meta_xxxmap附加元数据会传递给服务端插件，提供附加能力

权限验证

参数类型说明默认值可选值备注

authentication_methodstring鉴权方式tokentoken, oidc需要和服务端一致

authenticate_heartbeatsbool开启心跳消息鉴权false需要和服务端一致

authenticate_new_work_connsbool开启建立工作连接的鉴权false需要和服务端一致

tokenstring鉴权使用的 token 值需要和服务端设置一样的值才能鉴权通过

oidc_client_idstringoidc_client_id

oidc_client_secretstringoidc_client_secret

oidc_audiencestringoidc_audience

oidc_scopestringoidc_scope

oidc_token_endpoint_urlstringoidc_token_endpoint_url

oidc_additional_xxxmapOIDC 附加参数map 结构，key 需要以 oidc_additional_ 开头

UI

参数类型说明默认值可选值备注

admin_addrstring启用 AdminUI 监听的本地地址0.0.0.0

admin_portint启用 AdminUI 监听的本地端口0

admin_userstringHTTP BasicAuth 用户名

admin_pwdstringHTTP BasicAuth 密码

asserts_dirstring静态资源目录AdminUI 使用的资源默认打包在二进制文件中，通过指定此参数使用自定义的静态资源

pprof_enablebool启动 Go HTTP pproffalse用于应用调试