frp内网穿透客户端frpc.ini各配置参数详解

网络技术4年前 (2020)发布 fdadmin

7,760 0 0

【上面用于总体对接frps服务端各参数，下面的用于客户端穿透各应用的配置参数。】

对应穿透服务名称
[name]
建立每个穿透服务，都需要命名一个此服务的名称，不能和其他已建立的相同。
穿透协议类型
type = tcp
可选：tcp，udp，http，https，stcp，xtcp
你要穿透什么应用要搞清楚，此应用是用什么协议的。
本地监听IP
local_ip = 127.0.0.1
可以是本地的局域网IP，也可以是本机的127.0.0.1 IP，
例如你的局域网是互通的，你可以在本设备建立穿透局域网其他IP的应用。
本地监听端口
local_port = 22
用于监听本地设备需要穿透的端口，比如我要穿透到本机的SSH端口，而SSH端口为22，则这样理解。
远程监听端口
remote_port = 6001
用于frps服务端的，分配建立穿透到内网对应应用的公网端口。
需要frps服务端已开放此端口给frpc客户端允许对接使用。
例如我可以连接到此(frps服务端IP：端口)，则可以穿透到我的内网对应应用服务。
穿透通讯加密
use_encryption = false
可选：false,true
默认为false则不开启，或者不填此参数，为true则开启frps服务端和frpc客户端之间通讯加密。
穿透通讯压缩
use_compression = false
可选：false,true
默认为false则不开启，或者不填此参数，为true则开启frps服务端和frpc客户端之间通讯压缩。
分配自定义域名访问穿透服务
custom_domains = demo.com
用于你的穿透服务的唯一访问域名，假如没有域名，则此处请填为frps服务端的服务器(IP)
自己有多个域名，可以配置不同穿透应用服务，用不同域名，只需要将对应域名解析到frps服务端的服务器(IP)既可。
也支持泛解析识别，例如将(demo.com)域名已经泛解析到frps服务端的服务器(IP)
而想通过(abc123.demo.com)访问到对应穿透服务
则在对应穿透服务，custom_domains参数中填abc123.demo.com
分配对应穿透应用服务唯一的子域名，用于访问
subdomain = abc123
假如frps服务端已经配置了subdomain_host参数域名，并且已经泛(*)解析到frps服务端的服务器(VPS)IP，则可以使用此参数，否则不能用。
例如已经泛解析(demo.com)域名并且frps服务端配置好的，使用此subdomain参数，只需要填子域名，而不需要填(demo.com)
subdomain = 填abc123，则可以通过(abc123.demo.com)访问
为HTTP协议，添加HTTP用户名和密码安全认证
http_user = admin
自定义用户名
http_pwd = admin
自定义密码
仅支持http,https类型协议。
例如我的WEB页面，访问前，需要进行验证，才可以访问。可以添加此参数。
安全地暴露内网服务
对于某些服务来说如果直接暴露于公网上将会存在安全隐患。
sk = abcdefg
可自定义
此参数用于进一步验证，本地访问穿透服务的安全连接，需要双方frpc客户端都需要配置，仅适用于stcp和xtcp协议类型。

修改 Host Header
通常情况下 frp 不会修改转发的任何数据。但有一些后端服务会根据 http 请求 header 中的 host 字段来展现不同的网站，例如 nginx 的虚拟主机服务，启用 host-header 的修改功能可以动态修改 http 请求中的 host 字段。该功能仅限于 http 类型的代理。
frpc.ini
[web]
type = http
local_port = 80
custom_domains = test.yourdomain.com
host_header_rewrite = dev.yourdomain.com
原来 http 请求中的 host 字段 test.yourdomain.com 转发到后端服务时会被替换为 dev.yourdomain.com。
URL 路由
frp 支持根据请求的 URL 路径路由转发到不同的后端服务。
通过配置文件中的 locations 字段指定一个或多个 proxy 能够匹配的 URL 前缀(目前仅支持最大前缀匹配，之后会考虑正则匹配)。例如指定 locations = /news，则所有 URL 以 /news 开头的请求都会被转发到这个服务。
frpc.ini
[web01]
type = http
local_port = 80
custom_domains = web.yourdomain.com
locations = /
[web02]
type = http
local_port = 81
custom_domains = web.yourdomain.com
locations = /news,/about
按照上述的示例配置后，web.yourdomain.com 这个域名下所有以 /news 以及 /about 作为前缀的 URL 请求都会被转发到 web02，其余的请求会被转发到 web01。
通过代理连接 frps
在只能通过代理访问外网的环境内，frpc 支持通过 HTTP PROXY 和 frps 进行通信。
可以通过设置 HTTP_PROXY 系统环境变量或者通过在 frpc 的配置文件中设置 http_proxy 参数来使用此功能。
仅在 protocol = tcp 时生效
frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
http_proxy = http://user:pwd@192.168.1.128:8080
插件
默认情况下，frpc 只会转发请求到本地 tcp 或 udp 端口。
插件模式是为了在客户端提供更加丰富的功能，目前内置的插件有 unix_domain_socket、http_proxy、socks5。
通过 plugin 指定需要使用的插件，插件的配置参数都以 plugin_ 开头。使用插件后 local_ip 和 local_port 不再需要配置。
使用 http_proxy 插件的示例:
frpc.ini
[http_proxy]
type = tcp
remote_port = 6000
plugin = http_proxy
plugin_http_user = abc
plugin_http_passwd = abc
plugin_http_user 和 plugin_http_passwd 即为 http_proxy 插件可选的配置参数。
范围端口映射
在 frpc 的配置文件中可以指定映射多个端口，目前只支持 tcp 和 udp 的类型。
这一功能通过 range: 段落标记来实现，客户端会解析这个标记中的配置，将其拆分成多个 proxy，每一个 proxy 以数字为后缀命名。
例如要映射本地 6000-6005, 6007 这6个端口，主要配置如下：
frpc.ini
[range:test_tcp]
type = tcp
local_ip = 127.0.0.1
local_port = 6000-6006,6007
remote_port = 6000-6006,6007