2017-05-24 19:10:58 +02:00
# [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"
server_addr = 0.0.0.0
server_port = 7000
2018-05-04 12:36:38 +02:00
# if you want to connect frps by http proxy or socks5 proxy, you can set http_proxy here or in global environment variables
2017-06-17 12:01:08 +02:00
# it only works when protocol is tcp
2018-04-10 11:46:49 +02:00
# http_proxy = http://user:passwd@192.168.1.128:8080
2018-05-04 12:36:38 +02:00
# http_proxy = socks5://user:passwd@192.168.1.128:1080
2017-05-24 19:10:58 +02:00
# console or real logFile path like ./frpc.log
log_file = ./frpc.log
# trace, debug, info, warn, error
log_level = info
log_max_days = 3
# for authentication
2018-04-10 11:46:49 +02:00
token = 12345678
2017-05-24 19:10:58 +02:00
2017-07-12 20:20:49 +02:00
# 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
2018-11-06 11:35:05 +01:00
admin_pwd = admin
2017-07-12 20:20:49 +02:00
2017-05-24 19:10:58 +02:00
# 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
2017-06-04 13:56:21 +02:00
# communication protocol used to connect to server
2018-08-03 13:41:54 +02:00
# now it supports tcp and kcp and websocket, default is tcp
2017-06-04 13:56:21 +02:00
protocol = tcp
2019-03-11 07:14:31 +01:00
# if tls_enable is true, frpc will connect frps by tls
tls_enable = true
2018-04-22 20:59:40 +02:00
# specify a dns server, so frpc will use this instead of default one
2018-05-24 19:25:36 +02:00
# dns_server = 8.8.8.8
2018-04-22 20:59:40 +02:00
2019-07-14 21:35:43 +02:00
# proxy names you want to start seperated by ','
2017-05-24 19:45:38 +02:00
# default is empty, means all proxies
# start = ssh,dns
2017-05-24 19:10:58 +02:00
# 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
2018-05-20 17:22:07 +02:00
# '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'
2017-05-24 19:10:58 +02:00
[ssh]
2018-05-20 17:22:07 +02:00
# tcp | udp | http | https | stcp | xtcp, default is tcp
2017-05-24 19:10:58 +02:00
type = tcp
local_ip = 127.0.0.1
local_port = 22
# 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
2018-05-21 15:22:10 +02:00
# frps will load balancing connections for proxies in same group
group = test_group
# group should have same group key
group_key = 123456
2018-06-25 12:22:35 +02:00
# 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
2019-01-15 04:27:53 +01:00
# health check connection timeout
2018-12-09 14:56:46 +01:00
health_check_timeout_s = 3
2019-01-15 04:27:53 +01:00
# 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
2017-05-24 19:10:58 +02:00
2018-01-18 09:43:03 +01:00
[ssh_random]
type = tcp
local_ip = 127.0.0.1
local_port = 22
2018-05-08 11:02:49 +02:00
# if remote_port is 0, frps will assign a random port for you
2018-01-18 09:43:03 +01:00
remote_port = 0
2018-01-30 15:07:16 +01:00
# if you want to expose multiple ports, add 'range:' prefix to the section name
2018-01-24 10:49:13 +01:00
# 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
2017-05-24 19:10:58 +02:00
[dns]
type = udp
local_ip = 114.114.114.114
local_port = 53
remote_port = 6002
use_encryption = false
use_compression = false
2018-01-24 10:49:13 +01:00
[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
2017-05-24 19:10:58 +02:00
# 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
2018-04-22 21:04:33 +02:00
http_pwd = admin
2017-05-24 19:10:58 +02:00
# 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
2017-12-18 12:35:09 +01:00
# locations is only available for http type
2017-05-24 19:10:58 +02:00
locations = /,/pic
host_header_rewrite = example.com
2018-05-20 17:22:07 +02:00
# params with prefix "header_" will be used to update http request headers
header_X-From-Where = frp
2018-06-25 12:22:35 +02:00
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
2019-01-15 04:27:53 +01:00
health_check_max_failed = 3
health_check_timeout_s = 3
2017-05-24 19:10:58 +02:00
[web02]
type = https
local_ip = 127.0.0.1
local_port = 8000
use_encryption = false
2018-05-08 11:02:49 +02:00
use_compression = false
2017-05-24 19:10:58 +02:00
subdomain = web01
custom_domains = web02.yourdomain.com
2019-03-29 12:01:18 +01:00
# 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
2017-05-24 19:10:58 +02:00
2017-05-30 08:37:51 +02:00
[plugin_unix_domain_socket]
2017-05-24 19:10:58 +02:00
type = tcp
2017-05-30 08:37:51 +02:00
remote_port = 6003
2017-05-24 19:10:58 +02:00
# if plugin is defined, local_ip and local_port is useless
# plugin will handle connections got from frps
plugin = unix_domain_socket
2018-05-20 17:22:07 +02:00
# params with prefix "plugin_" that plugin needed
2017-05-24 19:10:58 +02:00
plugin_unix_path = /var/run/docker.sock
2017-05-30 08:37:51 +02:00
[plugin_http_proxy]
type = tcp
remote_port = 6004
plugin = http_proxy
plugin_http_user = abc
plugin_http_passwd = abc
2017-06-25 21:02:33 +02:00
2018-01-24 16:04:55 +01:00
[plugin_socks5]
2018-01-24 10:49:13 +01:00
type = tcp
remote_port = 6005
2018-01-24 16:04:55 +01:00
plugin = socks5
plugin_user = abc
plugin_passwd = abc
[plugin_static_file]
type = tcp
remote_port = 6006
2018-01-24 10:49:13 +01:00
plugin = static_file
plugin_local_path = /var/www/blog
plugin_strip_prefix = static
plugin_http_user = abc
plugin_http_passwd = abc
2019-04-10 07:39:26 +02:00
[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
2019-08-13 15:14:06 +02:00
plugin_header_X-From-Where = frp
2019-04-10 07:39:26 +02:00
2017-06-25 21:02:33 +02:00
[secret_tcp]
# If the type is secret tcp, remote_port is useless
2017-12-04 18:34:33 +01:00
# Who want to connect local port should deploy another frpc with stcp proxy and role is visitor
2017-06-25 21:02:33 +02:00
type = stcp
2017-12-04 18:34:33 +01:00
# sk used for authentication for visitors
2017-06-25 21:02:33 +02:00
sk = abcdefg
local_ip = 127.0.0.1
local_port = 22
use_encryption = false
use_compression = false
2017-12-04 18:34:33 +01:00
# 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
2017-06-25 21:02:33 +02:00
type = stcp
2017-12-04 18:34:33 +01:00
# the server name you want to visitor
2017-07-13 06:01:46 +02:00
server_name = secret_tcp
2017-06-25 21:02:33 +02:00
sk = abcdefg
2017-12-04 18:34:33 +01:00
# connect this address to visitor stcp server
2017-06-25 21:02:33 +02:00
bind_addr = 127.0.0.1
bind_port = 9000
use_encryption = false
use_compression = false
2017-10-24 12:20:07 +02:00
[p2p_tcp]
type = xtcp
sk = abcdefg
local_ip = 127.0.0.1
local_port = 22
use_encryption = false
use_compression = false
2017-12-04 18:34:33 +01:00
[p2p_tcp_visitor]
role = visitor
2017-10-24 12:20:07 +02:00
type = xtcp
server_name = p2p_tcp
sk = abcdefg
bind_addr = 127.0.0.1
bind_port = 9001
2017-10-24 20:49:56 +02:00
use_encryption = false
use_compression = false