frps_full.ini 4.9 KB
Newer Older
1 2 3 4
# [common] is integral section
[common]
# A literal address or host name for IPv6 must be enclosed
# in square brackets, as in "[::1]:80", "[ipv6-host]:http" or "[ipv6-host%zone]:80"
Y
yuyulei 已提交
5
# For single "bind_addr" field, no need square brackets, like "bind_addr = ::".
6 7 8
bind_addr = 0.0.0.0
bind_port = 7000

F
fatedier 已提交
9 10 11
# udp port to help make udp hole to penetrate nat
bind_udp_port = 7001

F
fatedier 已提交
12 13 14 15
# udp port used for kcp protocol, it can be same with 'bind_port'
# if not set, kcp is disabled in frps
kcp_bind_port = 7000

F
fatedier 已提交
16 17 18
# specify which address proxy will listen for, default value is same with bind_addr
# proxy_bind_addr = 127.0.0.1

19
# if you want to support virtual host, you must set the http port for listening (optional)
20
# Note: http port and https port can be same with bind_port
21 22 23
vhost_http_port = 80
vhost_https_port = 443

F
fatedier 已提交
24 25 26
# response header timeout(seconds) for vhost http server, default is 60s
# vhost_http_timeout = 60

Y
yuyulei 已提交
27
# tcpmux_httpconnect_port specifies the port that the server listens for TCP
F
fatedier 已提交
28 29 30 31 32
# HTTP CONNECT requests. If the value is 0, the server will not multiplex TCP
# requests on one single port. If it's not - it will listen on this value for
# HTTP CONNECT requests. By default, this value is 0.
# tcpmux_httpconnect_port = 1337

T
timerever 已提交
33 34 35 36
# set dashboard_addr and dashboard_port to view dashboard of frps
# dashboard_addr's default value is same with bind_addr
# dashboard is available only if dashboard_port is set
dashboard_addr = 0.0.0.0
37 38
dashboard_port = 7500

F
fatedier 已提交
39
# dashboard user and passwd for basic auth protect, if not set, both default value is admin
40
dashboard_user = admin
wujingquan's avatar
wujingquan 已提交
41
dashboard_pwd = admin
42

43 44 45
# enable_prometheus will export prometheus metrics on {dashboard_addr}:{dashboard_port} in /metrics api.
enable_prometheus = true

46 47
# dashboard assets directory(only for debug mode)
# assets_dir = ./static
Y
yuyulei 已提交
48

49 50 51 52 53 54 55 56
# console or real logFile path like ./frps.log
log_file = ./frps.log

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

log_max_days = 3

57 58 59
# disable log colors when log_file is console, default is false
disable_log_color = false

F
fatedier 已提交
60 61 62
# DetailedErrorsToClient defines whether to send the specific error (with debug info) to frpc. By default, this value is true.
detailed_errors_to_client = true

Y
yuyulei 已提交
63
# authentication_method specifies what authentication method to use authenticate frpc with frps.
F
fatedier 已提交
64 65 66 67
# If "token" is specified - token will be read into login message.
# If "oidc" is specified - OIDC (Open ID Connect) token will be issued using OIDC settings. By default, this value is "token".
authentication_method = token

Y
yuyulei 已提交
68
# authenticate_heartbeats specifies whether to include authentication token in heartbeats sent to frps. By default, this value is false.
F
fatedier 已提交
69 70 71 72 73
authenticate_heartbeats = false

# AuthenticateNewWorkConns specifies whether to include authentication token in new work connections sent to frps. By default, this value is false.
authenticate_new_work_conns = false

F
fatedier 已提交
74 75
# auth token
token = 12345678
76

Y
yuyulei 已提交
77
# oidc_issuer specifies the issuer to verify OIDC tokens with.
F
fatedier 已提交
78
# By default, this value is "".
Y
yuyulei 已提交
79
oidc_issuer =
F
fatedier 已提交
80

Y
yuyulei 已提交
81
# oidc_audience specifies the audience OIDC tokens should contain when validated.
F
fatedier 已提交
82
# By default, this value is "".
Y
yuyulei 已提交
83 84 85 86 87
oidc_audience =

# oidc_skip_expiry_check specifies whether to skip checking if the OIDC token is expired.
# By default, this value is false.
oidc_skip_expiry_check = false
F
fatedier 已提交
88 89


Y
yuyulei 已提交
90 91 92
# oidc_skip_issuer_check specifies whether to skip checking if the OIDC token's issuer claim matches the issuer specified in OidcIssuer.
# By default, this value is false.
oidc_skip_issuer_check = false
F
fatedier 已提交
93

94 95 96 97
# heartbeat configure, it's not recommended to modify the default value
# the default value of heartbeat_timeout is 90
# heartbeat_timeout = 90

Y
yuyulei 已提交
98 99 100 101
# 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

102
# only allow frpc to bind ports you list, if you set nothing, there won't be any limit
F
fatedier 已提交
103
allow_ports = 2000-3000,3001,3003,4000-50000
104 105 106 107

# pool_count in each proxy will change to max_pool_count if they exceed the maximum value
max_pool_count = 5

F
fatedier 已提交
108 109 110
# max ports can be used for each client, default value is 0 means no limit
max_ports_per_client = 0

Y
yuyulei 已提交
111
# tls_only specifies whether to only accept TLS-encrypted connections. By default, the value is false.
F
fatedier 已提交
112 113
tls_only = false

F
fatedier 已提交
114 115 116 117
# tls_cert_file = server.crt
# tls_key_file = server.key
# tls_trusted_ca_file = ca.crt

118 119 120 121 122 123
# if subdomain_host is not empty, you can set subdomain when type is http or https in frpc's configure file
# when subdomain is test, the host used by routing is test.frps.com
subdomain_host = frps.com

# if tcp stream multiplexing is used, default is true
tcp_mux = true
F
fatedier 已提交
124 125 126

# custom 404 page for HTTP requests
# custom_404_page = /path/to/404.html
F
fatedier 已提交
127

128 129 130 131 132
# specify udp packet size, unit is byte. If not set, the default value is 1500.
# This parameter should be same between client and server.
# It affects the udp and sudp proxy.
udp_packet_size = 1500

F
fatedier 已提交
133 134 135 136 137 138 139 140 141
[plugin.user-manager]
addr = 127.0.0.1:9000
path = /handler
ops = Login

[plugin.port-manager]
addr = 127.0.0.1:9001
path = /handler
ops = NewProxy