[common]
公共配置段(所有代理共用)
配置项 | 说明 |
---|---|
server_addr | frps 的服务器地址。IPv6 可直接写 [::1] 。 |
server_port | frps 服务监听的端口,默认是 7000 。 |
log_file | 日志文件路径,./frpc.log 表示当前目录下。 |
log_level | 日志等级:trace 、debug 、info 、warn 、error 。建议设为 info 或更高。 |
log_max_days | 日志最大保存天数。 |
disable_log_color | 禁用控制台日志颜色,false 表示启用颜色。 |
authenticate_heartbeats | 是否在心跳包中添加认证 token,需和 frps 配置一致。默认 false 。 |
authenticate_new_work_conns | 是否在新建连接时带上认证 token。默认 false 。 |
token | 客户端和服务器通信使用的认证 token。需与 frps 配置一致。 |
admin_addr | frpc 的 HTTP 管理界面监听地址。 |
admin_port | 管理界面监听端口,供 API 调用,例如 reload 。 |
admin_user/admin_pwd | 访问管理界面的认证用户名和密码。 |
pool_count | 提前建立多少连接池,默认 0,性能优化用。 |
user | 代理名前缀,例如代理名为 ssh ,配置了此项后为 your_name.ssh 。 |
login_fail_exit | 登录 frps 失败是否退出,默认 true 。 |
protocol | 和 frps 通信使用的协议,支持 tcp , kcp , websocket 。默认 tcp 。 |
connect_server_local_ip | 本地绑定 IP,用于连接 frps。 |
tls_enable | 是否启用 TLS 加密传输,需与 frps 同时开启。 |
disable_custom_tls_first_byte | 禁用 TLS 自定义首字节,用于兼容特殊网络。 |
meta_var1/meta_var2 | 自定义元信息,可在服务端查看标识。 |
udp_packet_size | UDP 包大小(单位字节),需与 frps 配置一致,默认 1500 。 |
includes | 引入其他配置文件,例如分模块存放多个代理配置。 |
pprof_enable | 是否启用 Golang 的性能分析接口(需启用 admin 端口)。 |
示例代理配置段说明
[ssh]
:ssh 端口代理
配置项 | 说明 |
---|---|
type | 代理类型,此处为 tcp 。 |
local_ip | 本地服务监听地址(frpc 所在机器)。 |
local_port | 本地监听端口(此处为 SSH 的 22 端口)。 |
bandwidth_limit | 限制带宽,如 1MB 。 |
remote_port | frps 上监听的端口。 |
group/group_key | 分组与密钥,用于负载均衡。 |
health_check_* | 健康检查配置。类型 tcp ,间隔 10s ,超时 3s ,失败 3 次视为宕机。 |
meta_var* | 元信息,供 frps 识别。 |
[ssh_random]
:使用随机远程端口
配置项 | 说明 |
---|---|
remote_port = 0 | 表示由 frps 自动分配随机端口。 |
[range:tcp_port]
:一组 TCP 端口映射
配置项 | 说明 |
---|---|
local_port/remote_port | 范围映射如 6010-6020,6022,6024-6028 。 |
range: 前缀 | 表示是一个端口段配置。frpc 会生成多个条目。 |
[dns]
:UDP 类型代理(DNS)
配置项 | 说明 |
---|---|
type = udp | 表示 UDP 类型代理。 |
local_ip = 114.114.114.114 | 指向 DNS 服务器地址。 |
remote_port | 在 frps 上的端口号。 |
[web01]
:HTTP 网站代理
配置项 | 说明 |
---|---|
type = http | HTTP 类型代理。 |
http_user/http_pwd | 设置 HTTP Basic 认证。 |
subdomain/custom_domains | 指定访问域名,如 web01.frps.com 。 |
locations | 指定 URI 路由,如 /,/pic 。 |
health_check_* | HTTP 检查 /status 返回 2xx 表示正常。 |
[web02]
:HTTPS 代理
配置项 | 说明 |
---|---|
type = https | HTTPS 代理。 |
proxy_protocol_version = v2 | 透传客户端信息,用于负载均衡。 |
插件代理
这些代理使用 plugin
字段内置功能:
名称 | 插件功能说明 |
---|---|
plugin_unix_domain_socket | 访问 UNIX Socket(如 Docker) |
plugin_http_proxy | 提供 HTTP 代理功能 |
plugin_socks5 | 提供 Socks5 代理功能 |
plugin_static_file | 提供静态文件服务 |
plugin_https2http | 把 HTTPS 转为本地 HTTP |
plugin_https2https | 终端到终端的 HTTPS 转发 |
plugin_http2https | 把 HTTP 转为本地 HTTPS |
内网穿透(stcp/xtcp)
[secret_tcp]
和 [secret_tcp_visitor]
:stcp 安全内网穿透
配置项 | 说明 |
---|---|
sk | 共享密钥,用于加密连接。 |
role = visitor | 表示该客户端为访问端。 |
[p2p_tcp]
和 [p2p_tcp_visitor]
:xtcp 点对点穿透
配置项 | 说明 |
---|---|
type = xtcp | 使用 UDP hole punching 技术实现点对点。 |
sk | 共享密钥,需一致。 |
[tcpmuxhttpconnect]
:HTTP CONNECT 多路复用代理
配置项 | 说明 |
---|---|
type = tcpmux | 多路复用类型代理。 |
multiplexer = httpconnect | 使用 HTTP CONNECT 多路复用协议。 |