frpc_full.ini 9.2 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 "server_addr" field, no need square brackets, like "server_addr = ::".
6 7 8
server_addr = 0.0.0.0
server_port = 7000

9
# if you want to connect frps by http proxy or socks5 proxy or ntlm proxy, you can set http_proxy here or in global environment variables
F
fatedier 已提交
10
# it only works when protocol is tcp
F
fatedier 已提交
11
# http_proxy = http://user:passwd@192.168.1.128:8080
12
# http_proxy = socks5://user:passwd@192.168.1.128:1080
13
# http_proxy = ntlm://user:passwd@192.168.1.128:2080
14 15 16 17 18 19 20 21 22

# console or real logFile path like ./frpc.log
log_file = ./frpc.log

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

log_max_days = 3

23 24 25
# disable log colors when log_file is console, default is false
disable_log_color = false

C
Chirag Sukhala 已提交
26
# for authentication, should be same as your frps.ini
Y
yuyulei 已提交
27
# authenticate_heartbeats specifies whether to include authentication token in heartbeats sent to frps. By default, this value is false.
C
Chirag Sukhala 已提交
28 29
authenticate_heartbeats = false

Y
yuyulei 已提交
30
# authenticate_new_work_conns specifies whether to include authentication token in new work connections sent to frps. By default, this value is false.
C
Chirag Sukhala 已提交
31 32 33
authenticate_new_work_conns = false

# auth token
F
fatedier 已提交
34
token = 12345678
35

Y
yuyulei 已提交
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
# oidc_client_id specifies the client ID to use to get a token in OIDC authentication if AuthenticationMethod == "oidc".
# By default, this value is "".
oidc_client_id =

# oidc_client_secret specifies the client secret to use to get a token in OIDC authentication if AuthenticationMethod == "oidc".
# By default, this value is "".
oidc_client_secret =

# oidc_audience specifies the audience of the token in OIDC authentication if AuthenticationMethod == "oidc". By default, this value is "".
oidc_audience =

# oidc_token_endpoint_url specifies the URL which implements OIDC Token Endpoint.
# It will be used to get an OIDC token if AuthenticationMethod == "oidc". By default, this value is "".
oidc_token_endpoint_url =

51 52 53 54
# set admin address for control frpc's action by http api such as reload
admin_addr = 127.0.0.1
admin_port = 7400
admin_user = admin
F
fatedier 已提交
55
admin_pwd = admin
56 57
# Admin assets directory. By default, these assets are bundled with frpc.
# assets_dir = ./static
58

59 60 61 62 63 64 65 66 67 68 69 70 71
# connections will be established in advance, default value is zero
pool_count = 5

# if tcp stream multiplexing is used, default is true, it must be same with frps
tcp_mux = true

# your proxy name will be changed to {user}.{proxy}
user = your_name

# decide if exit program when first login failed, otherwise continuous relogin to frps
# default is true
login_fail_exit = true

F
fatedier 已提交
72
# communication protocol used to connect to server
73
# now it supports tcp, kcp and websocket, default is tcp
F
fatedier 已提交
74 75
protocol = tcp

F
fatedier 已提交
76 77 78
# if tls_enable is true, frpc will connect frps by tls
tls_enable = true

F
fatedier 已提交
79 80 81
# tls_cert_file = client.crt
# tls_key_file = client.key
# tls_trusted_ca_file = ca.crt
82
# tls_server_name = example.com
F
fatedier 已提交
83

84
# specify a dns server, so frpc will use this instead of default one
F
fatedier 已提交
85
# dns_server = 8.8.8.8
86

Y
Typo  
Yuvaraj L 已提交
87
# proxy names you want to start seperated by ','
F
fatedier 已提交
88 89 90
# default is empty, means all proxies
# start = ssh,dns

91 92 93 94 95
# heartbeat configure, it's not recommended to modify the default value
# the default value of heartbeat_interval is 10 and heartbeat_timeout is 90
# heartbeat_interval = 30
# heartbeat_timeout = 90

F
fatedier 已提交
96 97 98 99
# additional meta info for client
meta_var1 = 123
meta_var2 = 234

100 101 102 103 104
# 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 已提交
105 106
# 'ssh' is the unique proxy name
# if user in [common] section is not empty, it will be changed to {user}.{proxy} such as 'your_name.ssh'
107
[ssh]
F
fatedier 已提交
108
# tcp | udp | http | https | stcp | xtcp, default is tcp
109 110 111
type = tcp
local_ip = 127.0.0.1
local_port = 22
F
fatedier 已提交
112 113
# limit bandwidth for this proxy, unit is KB and MB
bandwidth_limit = 1MB
114 115 116 117 118 119
# true or false, if true, messages between frps and frpc will be encrypted, default is false
use_encryption = false
# if true, message will be compressed
use_compression = false
# remote port listen by frps
remote_port = 6001
F
fatedier 已提交
120 121 122 123
# frps will load balancing connections for proxies in same group
group = test_group
# group should have same group key
group_key = 123456
124 125 126
# enable health check for the backend service, it support 'tcp' and 'http' now
# frpc will connect local service's port to detect it's healthy status
health_check_type = tcp
F
fatedier 已提交
127
# health check connection timeout
F
fatedier 已提交
128
health_check_timeout_s = 3
F
fatedier 已提交
129 130 131 132
# if continuous failed in 3 times, the proxy will be removed from frps
health_check_max_failed = 3
# every 10 seconds will do a health check
health_check_interval_s = 10
F
fatedier 已提交
133 134 135
# additional meta info for each proxy
meta_var1 = 123
meta_var2 = 234
136

F
fatedier 已提交
137 138 139 140
[ssh_random]
type = tcp
local_ip = 127.0.0.1
local_port = 22
K
king6cong 已提交
141
# if remote_port is 0, frps will assign a random port for you
F
fatedier 已提交
142 143
remote_port = 0

F
typo  
fatedier 已提交
144
# if you want to expose multiple ports, add 'range:' prefix to the section name
145 146 147 148 149 150 151 152 153
# frpc will generate multiple proxies such as 'tcp_port_6010', 'tcp_port_6011' and so on.
[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

154 155 156 157 158 159 160 161
[dns]
type = udp
local_ip = 114.114.114.114
local_port = 53
remote_port = 6002
use_encryption = false
use_compression = false

162 163 164 165 166 167 168 169
[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

170 171 172 173 174 175 176 177 178 179
# Resolve your domain names to [server_addr] so you can use http://web01.yourdomain.com to browse web01 and http://web02.yourdomain.com to browse web02
[web01]
type = http
local_ip = 127.0.0.1
local_port = 80
use_encryption = false
use_compression = true
# http username and password are safety certification for http protocol
# if not set, you can access this custom_domains without certification
http_user = admin
F
fatedier 已提交
180
http_pwd = admin
181 182 183
# if domain for frps is frps.com, then you can access [web01] proxy by URL http://test.frps.com
subdomain = web01
custom_domains = web02.yourdomain.com
F
fatedier 已提交
184
# locations is only available for http type
185 186
locations = /,/pic
host_header_rewrite = example.com
F
fatedier 已提交
187 188
# params with prefix "header_" will be used to update http request headers
header_X-From-Where = frp
189 190 191 192 193
health_check_type = http
# frpc will send a GET http request '/status' to local http service
# http service is alive when it return 2xx http response code
health_check_url = /status
health_check_interval_s = 10
F
fatedier 已提交
194 195
health_check_max_failed = 3
health_check_timeout_s = 3
196 197 198 199 200 201

[web02]
type = https
local_ip = 127.0.0.1
local_port = 8000
use_encryption = false
K
king6cong 已提交
202
use_compression = false
203 204
subdomain = web01
custom_domains = web02.yourdomain.com
F
fatedier 已提交
205 206 207
# if not empty, frpc will use proxy protocol to transfer connection info to your local service
# v1 or v2 or empty
proxy_protocol_version = v2
208

F
fatedier 已提交
209
[plugin_unix_domain_socket]
210
type = tcp
F
fatedier 已提交
211
remote_port = 6003
212 213 214
# if plugin is defined, local_ip and local_port is useless
# plugin will handle connections got from frps
plugin = unix_domain_socket
F
fatedier 已提交
215
# params with prefix "plugin_" that plugin needed
216
plugin_unix_path = /var/run/docker.sock
F
fatedier 已提交
217 218 219 220 221 222 223

[plugin_http_proxy]
type = tcp
remote_port = 6004
plugin = http_proxy
plugin_http_user = abc
plugin_http_passwd = abc
F
fatedier 已提交
224

225
[plugin_socks5]
226 227
type = tcp
remote_port = 6005
228 229 230 231 232 233 234
plugin = socks5
plugin_user = abc
plugin_passwd = abc

[plugin_static_file]
type = tcp
remote_port = 6006
235 236 237 238 239 240
plugin = static_file
plugin_local_path = /var/www/blog
plugin_strip_prefix = static
plugin_http_user = abc
plugin_http_passwd = abc

F
fatedier 已提交
241 242 243 244 245 246 247 248
[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
F
fatedier 已提交
249 250
plugin_header_X-From-Where = frp

251 252 253 254 255 256 257 258 259 260
[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

F
fatedier 已提交
261 262 263 264 265 266
[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
267
plugin_header_X-From-Where = frp
F
fatedier 已提交
268

F
fatedier 已提交
269 270
[secret_tcp]
# If the type is secret tcp, remote_port is useless
F
fatedier 已提交
271
# Who want to connect local port should deploy another frpc with stcp proxy and role is visitor
F
fatedier 已提交
272
type = stcp
F
fatedier 已提交
273
# sk used for authentication for visitors
F
fatedier 已提交
274 275 276 277 278 279
sk = abcdefg
local_ip = 127.0.0.1
local_port = 22
use_encryption = false
use_compression = false

F
fatedier 已提交
280 281 282 283
# user of frpc should be same in both stcp server and stcp visitor
[secret_tcp_visitor]
# frpc role visitor -> frps -> frpc role server
role = visitor
F
fatedier 已提交
284
type = stcp
F
fatedier 已提交
285
# the server name you want to visitor
F
fatedier 已提交
286
server_name = secret_tcp
F
fatedier 已提交
287
sk = abcdefg
F
fatedier 已提交
288
# connect this address to visitor stcp server
F
fatedier 已提交
289 290 291 292
bind_addr = 127.0.0.1
bind_port = 9000
use_encryption = false
use_compression = false
F
fatedier 已提交
293 294 295 296 297 298 299 300 301

[p2p_tcp]
type = xtcp
sk = abcdefg
local_ip = 127.0.0.1
local_port = 22
use_encryption = false
use_compression = false

F
fatedier 已提交
302 303
[p2p_tcp_visitor]
role = visitor
F
fatedier 已提交
304 305 306 307 308
type = xtcp
server_name = p2p_tcp
sk = abcdefg
bind_addr = 127.0.0.1
bind_port = 9001
F
fatedier 已提交
309 310
use_encryption = false
use_compression = false
F
fatedier 已提交
311 312 313 314 315 316 317

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