frp.ini 配置文件翻译 0.51.3 旧版 + 旧中文文档

HankNovic

已于 2024-02-14 20:05:11 修改

阅读量945

点赞数

文章标签：网络

于 2024-02-14 19:53:15 首次发布

原文链接：https://github.com/fatedier/frp/releases/tag/v0.51.3

版权

因为作者最近对 FRP 进行了大幅改变，导致很多之前的配置方法已经不适用。在此提供了 FRP 0.51.3 旧版本的 `frpc_full.ini` 和 `frps_full.ini` 配置文件机翻和更旧的中文文档(末尾)。

frpc

# [common] 是整体部分
[common]
# IPv6 的文字地址或主机名必须用方括号括起来，例如 "[::1]:80"，"[ipv6-host]:http" 或 "[ipv6-host%zone]:80"
# 对于单个的 "server_addr" 字段，不需要方括号，如 "server_addr = ::"。
server_addr = 0.0.0.0
server_port = 7000

# 用于帮助穿透 NAT 地址的 STUN 服务器。
# nat_hole_stun_server = stun.easyvoip.com:3478

# 拨号到服务器等待连接完成的最大时间。默认值为 10 秒。
# dial_server_timeout = 10

# dial_server_keepalive 指定 frpc 和 frps 之间的活动网络连接的保持活动探测之间的间隔。
# 如果为负数，则禁用保持活动探测。
# dial_server_keepalive = 7200

# 如果您想通过 HTTP 代理、SOCKS5 代理或 NTLM 代理连接到 frps，您可以在这里或全局环境变量中设置 http_proxy
# 它仅在协议为 tcp 时有效
# http_proxy = http://user:passwd@192.168.1.128:8080
# http_proxy = socks5://user:passwd@192.168.1.128:1080
# http_proxy = ntlm://user:passwd@192.168.1.128:2080

# 控制台或真实的 logFile 路径，例如 ./frpc.log
log_file = ./frpc.log

# trace, debug, info, warn, error
log_level = info

log_max_days = 3

# 当心跳被发送到 frps 时，authenticate_heartbeats 指定是否在心跳中包含认证令牌。默认值为 false。
authenticate_heartbeats = false

# authenticate_new_work_conns 指定是否在新的工作连接中包含认证令牌。默认值为 false。
authenticate_new_work_conns = false

# 认证令牌
token = 12345678

authentication_method =

# oidc_client_id 指定 OIDC 认证中用于获取令牌的客户端 ID（如果 AuthenticationMethod == "oidc"）。
# 默认情况下，此值为 ""。
oidc_client_id =

# oidc_client_secret 指定 OIDC 认证中用于获取令牌的客户端密钥（如果 AuthenticationMethod == "oidc"）。
# 默认情况下，此值为 ""。
oidc_client_secret =

# oidc_audience 指定 OIDC 认证中令牌的受众（如果 AuthenticationMethod == "oidc"）。
# 默认情况下，此值为 ""。
oidc_audience =

# oidc_scope 指定 OIDC 认证中令牌的权限范围（如果 AuthenticationMethod == "oidc"）。
# 默认情况下，此值为 ""。
oidc_scope =

# oidc_token_endpoint_url 指定实现 OIDC Token Endpoint 的 URL。
# 如果 AuthenticationMethod == "oidc"，则将用于获取 OIDC 令牌。默认情况下，此值为 ""。
oidc_token_endpoint_url =

# oidc_additional_xxx 指定要发送到 OIDC Token Endpoint 的其他参数。
# 例如，如果要指定 "audience" 参数，则可以设置如下。
# frp 将添加 "audience=<value>" 和 "var1=<value>" 到其他参数中。
# oidc_additional_audience = https://dev.auth.com/api/v2/
# oidc_additional_var1 = foobar

# 为控制 frpc 的操作设置管理员地址，例如重新加载
admin_addr = 127.0.0.1
admin_port = 7400
admin_user = admin
admin_pwd = admin
# 管理员资产目录。默认情况下，这些资产与 frpc 捆绑在一起。
# assets_dir = ./static

# 预先建立连接的数量，默认值为零
pool_count = 5

# 如果使用了 tcp 流多路复用，默认值为 true，它必须与 frps 一致
# tcp_mux = true

# 指定 tcp mux 的保持活动间隔。
# 仅在 tcp_mux 为 true 时有效。
# tcp_mux_keepalive_interval = 60

# 当连接到服务器时设置客户端绑定 ip，默认为空。
# 仅在协议为 tcp 或 websocket 时，该值才会被使用。
connect_server_local_ip = 0.0.0.0

# quic 协议选项
# quic_keepalive_period = 10
# quic_max_idle_timeout = 30
# quic_max_incoming_streams = 100000

# 如果 tls_enable 为 true，则 frpc 将通过 tls 连接到 frps。
# 自从 v0.50.0 以来，默认值已更改为 true，并且默认情况下启用了 tls。
tls_enable = true

# tls_cert_file = client.crt
# tls_key_file = client.key
# tls_trusted_ca_file = ca.crt
# tls_server_name = example.com

# 指定一个 dns 服务器，这样 frpc 将使用这个 dns 服务器而不是默认的
# dns_server = 8.8.8.8

# 用逗号分隔的要启动的代理名称
# 默认为空，表示所有代理
# start = ssh,dns

# 心跳配置，不建议修改默认值
# heartbeat_interval = 30
# heartbeat_timeout = 90

# 客户端的其他元信息
meta_var1 = 123
meta_var2 = 234

# 指定 udp 数据包大小，单位为字节。如果未设置，则默认值为 1500。
# 这个参数应该在客户端和服务器之间相同。
# 它影响 udp 和 sudp 代理。
udp_packet_size = 1500

# 包含其他代理的配置文件。
# includes = ./confd/*.ini

# 如果 disable_custom_tls_first_byte 设置为 false，则 frpc 将使用第一个自定义字节与 frps 建立连接时。
# 自从 v0.50.0

以来，默认值已更改为 true，并且默认情况下禁用了第一个自定义字节。
disable_custom_tls_first_byte = true

# 在管理员侦听器中启用 golang pprof 处理程序。
# 必须首先设置管理员端口。
pprof_enable = false

# 'ssh' 是唯一的代理名称
# 如果 [common] 部分中的用户不为空，则将其更改为 {user}.{proxy}，例如 'your_name.ssh'
[ssh]
# tcp | udp | http | https | stcp | xtcp，默认为 tcp
type = tcp
local_ip = 127.0.0.1
local_port = 22
# 限制此代理的带宽，单位为 KB 和 MB
bandwidth_limit = 1MB
# 限制带宽的位置，可以是 'client' 或 'server'，默认为 'client'
bandwidth_limit_mode = client
# true 或 false，如果为 true，则消息将被加密，默认为 false
use_encryption = false
# 如果为 true，则消息将被压缩
use_compression = false
# frps 将为同一组中的代理负载均衡连接
group = test_group
# 组应该具有相同的组密钥
group_key = 123456
# 为后端服务启用健康检查，现在支持 'tcp' 和 'http'
# frpc 将连接到本地服务的端口以检测其是否健康
health_check_type = tcp
# 健康检查连接超时
health_check_timeout_s = 3
# 如果连续失败了 3 次，则该代理将从 frps 中移除
health_check_max_failed = 3
# 每 10 秒将执行一次健康检查
health_check_interval_s = 10
# 每个代理的其他元信息
meta_var1 = 123
meta_var2 = 234

[ssh_random]
type = tcp
local_ip = 127.0.0.1
local_port = 22
# 如果 remote_port 为 0，则 frps 将为您分配一个随机端口
remote_port = 0

# 如果要公开多个端口，请在部分名称前加上 'range:' 前缀
# frpc 将生成多个代理，如 'tcp_port_6010'、'tcp_port_6011' 等。
[range:tcp_port]
type = tcp
local_ip = 127.0.0.1
local_port = 6010-6020,6022,6024-6028
remote_port = 6010-6020,6022,6024-6028
use_encryption = false
use_compression = false

[dns]
type = udp
local_ip = 114.114.114.114
local_port = 53
remote_port = 6002
use_encryption = false
use_compression = false

[range:udp_port]
type = udp
local_ip = 127.0.0.1
local_port = 6010-6020
remote_port = 6010-6020
use_encryption = false
use_compression = false

# 将您的域名解析到 [server_addr]，这样您就可以使用 http://web01.yourdomain.com 浏览 web01，使用 http://web02.yourdomain.com 浏览 web02
[web01]
type = http
local_ip = 127.0.0.1
local_port = 80
use_encryption = false
use_compression = true
# http 用户名和密码是 http 协议的安全认证
# 如果未设置，则可以在没有认证的情况下访问这些自定义域名
http_user = admin
http_pwd = admin
# 如果 frps 的域名是 frps.com，则您可以通过 URL http://web01.frps.com 访问 [web01] 代理
subdomain = web01
custom_domains = web01.yourdomain.com
# locations 仅适用于 http 类型
locations = /,/pic
# 如果 http basic auto 用户为 abc，则将请求路由到该服务
# route_by_http_user = abc
host_header_rewrite = example.com
# 带有前缀 "header_" 的参数将用于更新 http 请求头
header_X-From-Where = frp
health_check_type = http
# frpc 将发送一个 GET http 请求 '/status' 到本地 http 服务
# 当它返回 2xx 的 http 响应代码时，http 服务是活动的
health_check_url = /status
health_check_interval_s = 10
health_check_max_failed = 3
health_check_timeout_s = 3

[web02]
type = https
local_ip = 127.0.0.1
local_port = 8000
use_encryption = false
use_compression = false
subdomain = web02
custom_domains = web02.yourdomain.com
# 如果不为空，frpc 将使用代理协议将连接信息传输到您的本地服务
# v1 或 v2 或空
proxy_protocol_version = v2

[plugin_unix_domain_socket]
type = tcp
remote_port = 6003
# 如果定义了插件，local_ip 和 local_port 就无效了
# 插件将处理从 frps 收到的连接
plugin = unix_domain_socket
# 插件所需的具有前缀 "plugin_" 的参数
plugin_unix_path = /var/run/docker.sock

[plugin_http_proxy]
type = tcp
remote_port = 6004
plugin = http_proxy
plugin_http_user = abc
plugin_http_passwd = abc

[plugin_socks5]
type = tcp
remote_port = 6005
plugin = socks5
plugin_user = abc
plugin_passwd = abc

[plugin_static_file]
type = tcp
remote_port = 6006
plugin = static_file
plugin_local_path = /var/www/blog
plugin_strip_prefix = static
plugin_http_user = abc
plugin_http_passwd = abc

[plugin_https2http]
type = https
custom_domains = test.yourdomain.com
plugin = https2http
plugin_local_addr = 127.0.0.1:80
plugin_crt_path = ./server.crt
plugin_key_path = ./server.key
plugin_host_header_rewrite = 127.0.0.1
plugin_header_X-From-Where = frp

[plugin_https2https]
type = https
custom_domains = test.yourdomain.com
plugin = https2https
plugin_local_addr = 127.0.0.1:443
plugin_crt_path = ./server.crt
plugin_key_path = ./server.key
plugin_host_header_rewrite = 127.0.0.1
plugin_header_X-From-Where = frp

[plugin_http2https]
type = http
custom_domains = test.yourdomain.com
plugin = http2https
plugin_local_addr = 127.0.0.1:443
plugin_host_header_rewrite = 127.0.0.1
plugin_header_X-From-Where = frp

[secret_tcp]
# 如果类型是 secret tcp，则 remote_port 无效
# 要连接本地端口的用户应部署另一个带有 stcp 代理和角色为 visitor 的 frpc
type = stcp
# 用于访问者认证的 sk
sk = abcdefg
local_ip = 127.0.0.1
local_port = 22
use_encryption = false
use_compression = false
# 如果不为空，则只允许来自指定用户的访问者连接。
# 否则，来自相同用户的访问者可以连接。'*' 表示允许所有用户。
allow_users = *

# frpc 的用户应该在 stcp 服务器和 stcp 访问者中相同
[secret_tcp_visitor]
# frpc 角色 visitor -> frps -> frpc 角色 server
role = visitor
type = stcp
# 您要访问的服务器名称
server_name = secret_tcp
sk = abcdefg
# 连接此地址以访问者 stcp 服务器
bind_addr = 127.0.0.1
# bind_port 可以小于 0，表示不绑定到端口，只接收从其他访问者重定向的连接。（SUDP 现在不支持此功能）
bind_port = 9000
use_encryption = false
use_compression = false

[p2p_tcp]
type = xtcp
sk = abcdefg
local_ip = 127.0.0.1
local_port = 22
use_encryption = false
use_compression = false
# 如果不为空，则只允许来自指定用户的访问者连接。
# 否则，来自相同用户的访问者可以连接。'*' 表示允许所有用户。
allow_users = user1, user2

[p2p_tcp_visitor]
role = visitor
type = xtcp
# 如果服务器用户未设置，则默认为当前用户
server_user = user1
server_name = p2p_tcp
sk = abcdefg
bind_addr = 127.0.0.1
# bind_port 可以小于 0，表示不绑定到端口，只接收从其他访问者重定向的连接。（SUDP 现在不支持此功能）
bind_port = 9001
use_encryption = false
use_com

pression = false
# 当需要自动隧道持久性时，将其设置为 true
keep_tunnel_open = false
# 当 keep_tunnel_open 设置为 true 时有效，每小时尝试穿越的次数
max_retries_an_hour = 8
min_retry_interval = 90
# fallback_to = stcp_visitor
# fallback_timeout_ms = 500

[tcpmuxhttpconnect]
type = tcpmux
multiplexer = httpconnect
local_ip = 127.0.0.1
local_port = 10701
custom_domains = tunnel1
# route_by_http_user = user1

frps

# [common] 是必要部分
[common]
# IPv6 的文字地址或主机名必须用方括号括起来，如 "[::1]:80"、"[ipv6-host]:http" 或 "[ipv6-host%zone]:80"
# 对于单个 "bind_addr" 字段，不需要方括号，如 "bind_addr = ::"。
bind_addr = 0.0.0.0
bind_port = 7000

# 用于 kcp 协议的 udp 端口，可以与 'bind_port' 相同。
# 如果未设置，frps 中将禁用 kcp。
kcp_bind_port = 7000

# 用于 quic 协议的 udp 端口。
# 如果未设置，frps 中将禁用 quic。
# quic_bind_port = 7002
# quic 协议选项
# quic_keepalive_period = 10
# quic_max_idle_timeout = 30
# quic_max_incoming_streams = 100000

# 指定代理将监听的地址，default value is same with bind_addr
# proxy_bind_addr = 127.0.0.1

# 如果要支持虚拟主机，必须设置监听的 http 端口（可选）
# 注意：http 端口和 https 端口可以与 bind_port 相同
vhost_http_port = 80
vhost_https_port = 443

# 用于 vhost http 服务器的响应头超时时间（秒），默认为 60 秒
# vhost_http_timeout = 60

# tcpmux_httpconnect_port 指定服务器监听 TCP HTTP CONNECT 请求的端口。
# 如果值为 0，则服务器不会在一个单一端口上多路复用 TCP 请求。如果不为 0，则会在此值上监听 HTTP CONNECT 请求。默认值为 0。
# tcpmux_httpconnect_port = 1337

# 如果 tcpmux_passthrough 为 true，则 frps 不会对流量进行任何更新。
# tcpmux_passthrough = false

# 设置 dashboard_addr 和 dashboard_port 以查看 frps 的仪表板
# dashboard_addr 的默认值与 bind_addr 相同
# 仪表板仅在设置了 dashboard_port 时可用
dashboard_addr = 0.0.0.0
dashboard_port = 7500

# 仪表板的基本身份验证用户名和密码
dashboard_user = admin
dashboard_pwd = admin

# 仪表板 TLS 模式
dashboard_tls_mode = false
# dashboard_tls_cert_file = server.crt
# dashboard_tls_key_file = server.key

# enable_prometheus 将在 {dashboard_addr}:{dashboard_port} 上的 /metrics API 导出 prometheus 指标。
enable_prometheus = true

# 仪表板资源目录（仅用于调试模式）
# assets_dir = ./static

# 控制台或真实 logFile 路径，例如 ./frps.log
log_file = ./frps.log

# trace、debug、info、warn、error
log_level = info

log_max_days = 3

# 当前推荐不要修改默认值
detailed_errors_to_client = true

# authentication_method 指定 frpc 与 frps 进行身份验证的身份验证方法。
# 如果指定为 "token" - 令牌将被读入登录消息。
# 如果指定为 "oidc" - 将使用 OIDC（Open ID Connect）设置发放 OIDC 令牌。默认情况下，该值为 "token"。
authentication_method = token

# authenticate_heartbeats 指定是否在发送到 frps 的心跳中包含身份验证令牌。默认情况下，该值为 false。
authenticate_heartbeats = false

# AuthenticateNewWorkConns 指定是否在发送到 frps 的新工作连接中包含身份验证令牌。默认情况下，该值为 false。
authenticate_new_work_conns = false

# auth token
token = 12345678

# oidc_issuer 指定要验证 OIDC 令牌的发行者。
# 默认情况下，该值为 ""。
oidc_issuer =

# oidc_audience 指定验证 OIDC 令牌时应包含的受众。
# 默认情况下，该值为 ""。
oidc_audience =

# oidc_skip_expiry_check 指定是否跳过检查 OIDC 令牌是否过期。
# 默认情况下，该值为 false。
oidc_skip_expiry_check = false

# oidc_skip_issuer_check 指定是否跳过检查 OIDC 令牌的发行者声明是否与 OidcIssuer 中指定的发行者匹配。
# 默认情况下，该值为 false。
oidc_skip_issuer_check = false

# heartbeat configure, it's not recommended to modify the default value
# the default value of heartbeat_timeout is 90. Set negative value to disable it.
# heartbeat_timeout = 90

# user_conn_timeout configure, it's not recommended to modify the default value
# the default value of user_conn_timeout is 10
#

user_conn_timeout = 10

# 仅允许 frpc 绑定你列出的端口，如果什么都不设置，则不会有任何限制
allow_ports = 2000-3000,3001,3003,4000-50000

# 每个客户端可用的最大端口数，默认值为 0 表示没有限制
max_ports_per_client = 0

# tls_only 指定是否仅接受 TLS 加密连接。默认情况下，该值为 false。
tls_only = false

# tls_cert_file = server.crt
# tls_key_file = server.key
# tls_trusted_ca_file = ca.crt

# 如果 subdomain_host 不为空，您可以在 frpc 的配置文件中为类型为 http 或 https 的代理设置子域名
# 当 subdomain 为 test 时，路由使用的主机是 test.frps.com
subdomain_host = frps.com

# 如果使用了 tcp 流多路复用，default is true
# tcp_mux = true

# 指定 tcp 多路复用的保持活动间隔。
# 仅在 tcp_mux 为 true 时有效。
# tcp_mux_keepalive_interval = 60

# tcp_keepalive 指定 frpc 与 frps 之间的活动网络连接的 keep-alive 探测之间的间隔。
# 如果为负数，将禁用 keep-alive 探测。
# tcp_keepalive = 7200

# 自定义 HTTP 请求的 404 页面
# custom_404_page = /path/to/404.html

# 指定 udp 数据包大小，单位为字节。如果未设置，默认值为 1500。
# 此参数应与客户端和服务器相同。
# 它影响 udp 和 sudp 代理。
udp_packet_size = 1500