客户端配置

配置文件格式

frpc 支持多种配置文件格式

TOML（推荐，并在示例中使用）
YAML
JSON

自 v0.52.0 起，INI 格式已被弃用，并将最终移除。新功能仅在 TOML、YAML 或 JSON 格式中可用。

来源：README.md476-483

基本配置结构

客户端配置包含两个主要组件

通用配置：适用于所有代理的全局设置
代理配置：单独的代理定义

下面是一个展示客户端配置结构的图表

来源：pkg/config/v1/client.go25-78 pkg/config/v1/proxy.go31-83

常用配置选项

下表列出了必需的通用配置选项

选项	描述	默认
`serverAddr`	frps 服务器的地址	"0.0.0.0"
`serverPort`	frps 服务器的端口	7000
`user`	将作为所有代理名称前缀的用户名	""
`loginFailExit`	登录失败时是否退出	true
`auth.method`	认证方法（“token”或“oidc”）	"token"
`auth.token`	认证令牌	""
`transport.protocol`	通信协议（“tcp”、“kcp”、“quic”、“websocket”、“wss”）	"tcp"
`transport.tls.enable`	是否使用 TLS 加密	true（自 v0.50.0 起）
`log.to`	日志文件路径或“console”	"console"
`log.level`	日志级别（trace, debug, info, warn, error）	"info"
`includes`	要包含的其他配置文件	[]

来源：conf/frpc_full_example.toml1-147 pkg/config/v1/client.go24-92

示例基本配置

这是一个最简的客户端配置示例

来源：conf/frpc.toml1-3 README.md156-161

身份验证

frp 支持两种认证方式

令牌认证

最简单的认证方法。客户端和服务器必须具有相同的 token

来源：README.md609-613

OIDC 认证

使用 OpenID Connect 进行更高级别的安全

来源：README.md630-637 pkg/config/v1/client.go175-211

传输选项

传输配置控制 frpc 如何与 frps 通信

协议选择

frpc 支持多种传输协议

对于 KCP（基于 UDP 的可靠协议）

对于 QUIC（基于 UDP 的现代多路复用传输）

来源：README.md825-877 pkg/config/v1/client.go94-154

TLS 配置

启用 TLS 加密（自 v0.50.0 起默认启用）

来源：README.md655-684 pkg/config/v1/client.go156-173

连接池与多路复用

来源：README.md816-822 README.md879-897 pkg/config/v1/client.go94-154

代理配置

代理在配置的 proxies 部分定义。每个代理指定了一个应通过 frps 服务器公开的本地服务。

通用代理设置

所有代理类型都共享这些基本设置

选项	描述
`名称`	代理的唯一名称
`类型`	代理类型（tcp、udp、http、https、stcp、xtcp、tcpmux、sudp）
`localIP`	要代理到的本地 IP 地址或主机名
`localPort`	要代理到的本地端口
`transport.useEncryption`	是否加密通信（可选）
`transport.useCompression`	是否压缩通信（可选）
`transport.bandwidthLimit`	带宽限制，例如“1MB”（可选）
`metadatas`	自定义元数据（可选）

来源：pkg/config/v1/proxy.go31-167

代理类型

frp 支持多种代理类型以适应不同的用例

来源：pkg/config/v1/proxy.go219-229 README.md142-474

TCP 代理示例

这将通过 frps 服务器上的 6000 端口暴露本地 SSH 服务（22 端口）。

来源：README.md161-168 pkg/config/v1/proxy.go253-269

UDP 代理示例

来源：README.md291-297 pkg/config/v1/proxy.go271-289

HTTP/HTTPS 代理示例

HTTP 和 HTTPS 代理支持附加选项

选项	描述
`customDomains`	HTTP/HTTPS 服务的自定义域名
`subdomain`	HTTP/HTTPS 服务的子域名
`locations`	URL 路径路由规则
`httpUser`	Basic Auth 用户名
`httpPassword`	Basic Auth 密码
`hostHeaderRewrite`	重写 Host 头
`requestHeaders.set`	要添加的自定义请求头
`responseHeaders.set`	要添加的自定义响应头