frpc_full.ini 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
  1. # [common] is integral section
  2. [common]
  3. # A literal address or host name for IPv6 must be enclosed
  4. # in square brackets, as in "[::1]:80", "[ipv6-host]:http" or "[ipv6-host%zone]:80"
  5. # For single "server_addr" field, no need square brackets, like "server_addr = ::".
  6. server_addr = 0.0.0.0
  7. server_port = 7000
  8. # The maximum amount of time a dial to server will wait for a connect to complete. Default value is 10 seconds.
  9. # dial_server_timeout = 10
  10. # dial_server_keepalive specifies the interval between keep-alive probes for an active network connection between frpc and frps.
  11. # If negative, keep-alive probes are disabled.
  12. # dial_server_keepalive = 7200
  13. # 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
  14. # it only works when protocol is tcp
  15. # http_proxy = http://user:passwd@192.168.1.128:8080
  16. # http_proxy = socks5://user:passwd@192.168.1.128:1080
  17. # http_proxy = ntlm://user:passwd@192.168.1.128:2080
  18. # console or real logFile path like ./frpc.log
  19. log_file = ./frpc.log
  20. # trace, debug, info, warn, error
  21. log_level = info
  22. log_max_days = 3
  23. # disable log colors when log_file is console, default is false
  24. disable_log_color = false
  25. # for authentication, should be same as your frps.ini
  26. # authenticate_heartbeats specifies whether to include authentication token in heartbeats sent to frps. By default, this value is false.
  27. authenticate_heartbeats = false
  28. # authenticate_new_work_conns specifies whether to include authentication token in new work connections sent to frps. By default, this value is false.
  29. authenticate_new_work_conns = false
  30. # auth token
  31. token = 12345678
  32. authentication_method =
  33. # oidc_client_id specifies the client ID to use to get a token in OIDC authentication if AuthenticationMethod == "oidc".
  34. # By default, this value is "".
  35. oidc_client_id =
  36. # oidc_client_secret specifies the client secret to use to get a token in OIDC authentication if AuthenticationMethod == "oidc".
  37. # By default, this value is "".
  38. oidc_client_secret =
  39. # oidc_audience specifies the audience of the token in OIDC authentication if AuthenticationMethod == "oidc". By default, this value is "".
  40. oidc_audience =
  41. # oidc_scope specifies the permisssions of the token in OIDC authentication if AuthenticationMethod == "oidc". By default, this value is "".
  42. oidc_scope =
  43. # oidc_token_endpoint_url specifies the URL which implements OIDC Token Endpoint.
  44. # It will be used to get an OIDC token if AuthenticationMethod == "oidc". By default, this value is "".
  45. oidc_token_endpoint_url =
  46. # oidc_additional_xxx specifies additional parameters to be sent to the OIDC Token Endpoint.
  47. # For example, if you want to specify the "audience" parameter, you can set as follow.
  48. # frp will add "audience=<value>" "var1=<value>" to the additional parameters.
  49. # oidc_additional_audience = https://dev.auth.com/api/v2/
  50. # oidc_additional_var1 = foobar
  51. # set admin address for control frpc's action by http api such as reload
  52. admin_addr = 127.0.0.1
  53. admin_port = 7400
  54. admin_user = admin
  55. admin_pwd = admin
  56. # Admin assets directory. By default, these assets are bundled with frpc.
  57. # assets_dir = ./static
  58. # connections will be established in advance, default value is zero
  59. pool_count = 5
  60. # if tcp stream multiplexing is used, default is true, it must be same with frps
  61. # tcp_mux = true
  62. # specify keep alive interval for tcp mux.
  63. # only valid if tcp_mux is true.
  64. # tcp_mux_keepalive_interval = 60
  65. # your proxy name will be changed to {user}.{proxy}
  66. user = your_name
  67. # decide if exit program when first login failed, otherwise continuous relogin to frps
  68. # default is true
  69. login_fail_exit = true
  70. # communication protocol used to connect to server
  71. # supports tcp, kcp, quic and websocket now, default is tcp
  72. protocol = tcp
  73. # set client binding ip when connect server, default is empty.
  74. # only when protocol = tcp or websocket, the value will be used.
  75. connect_server_local_ip = 0.0.0.0
  76. # if tls_enable is true, frpc will connect frps by tls
  77. tls_enable = true
  78. # tls_cert_file = client.crt
  79. # tls_key_file = client.key
  80. # tls_trusted_ca_file = ca.crt
  81. # tls_server_name = example.com
  82. # specify a dns server, so frpc will use this instead of default one
  83. # dns_server = 8.8.8.8
  84. # proxy names you want to start separated by ','
  85. # default is empty, means all proxies
  86. # start = ssh,dns
  87. # heartbeat configure, it's not recommended to modify the default value
  88. # The default value of heartbeat_interval is 10 and heartbeat_timeout is 90. Set negative value
  89. # to disable it.
  90. # heartbeat_interval = 30
  91. # heartbeat_timeout = 90
  92. # additional meta info for client
  93. meta_var1 = 123
  94. meta_var2 = 234
  95. # specify udp packet size, unit is byte. If not set, the default value is 1500.
  96. # This parameter should be same between client and server.
  97. # It affects the udp and sudp proxy.
  98. udp_packet_size = 1500
  99. # include other config files for proxies.
  100. # includes = ./confd/*.ini
  101. # By default, frpc will connect frps with first custom byte if tls is enabled.
  102. # If DisableCustomTLSFirstByte is true, frpc will not send that custom byte.
  103. disable_custom_tls_first_byte = false
  104. # Enable golang pprof handlers in admin listener.
  105. # Admin port must be set first.
  106. pprof_enable = false
  107. # 'ssh' is the unique proxy name
  108. # if user in [common] section is not empty, it will be changed to {user}.{proxy} such as 'your_name.ssh'
  109. [ssh]
  110. # tcp | udp | http | https | stcp | xtcp, default is tcp
  111. type = tcp
  112. local_ip = 127.0.0.1
  113. local_port = 22
  114. # limit bandwidth for this proxy, unit is KB and MB
  115. bandwidth_limit = 1MB
  116. # true or false, if true, messages between frps and frpc will be encrypted, default is false
  117. use_encryption = false
  118. # if true, message will be compressed
  119. use_compression = false
  120. # remote port listen by frps
  121. remote_port = 6001
  122. # frps will load balancing connections for proxies in same group
  123. group = test_group
  124. # group should have same group key
  125. group_key = 123456
  126. # enable health check for the backend service, it support 'tcp' and 'http' now
  127. # frpc will connect local service's port to detect it's healthy status
  128. health_check_type = tcp
  129. # health check connection timeout
  130. health_check_timeout_s = 3
  131. # if continuous failed in 3 times, the proxy will be removed from frps
  132. health_check_max_failed = 3
  133. # every 10 seconds will do a health check
  134. health_check_interval_s = 10
  135. # additional meta info for each proxy
  136. meta_var1 = 123
  137. meta_var2 = 234
  138. [ssh_random]
  139. type = tcp
  140. local_ip = 127.0.0.1
  141. local_port = 22
  142. # if remote_port is 0, frps will assign a random port for you
  143. remote_port = 0
  144. # if you want to expose multiple ports, add 'range:' prefix to the section name
  145. # frpc will generate multiple proxies such as 'tcp_port_6010', 'tcp_port_6011' and so on.
  146. [range:tcp_port]
  147. type = tcp
  148. local_ip = 127.0.0.1
  149. local_port = 6010-6020,6022,6024-6028
  150. remote_port = 6010-6020,6022,6024-6028
  151. use_encryption = false
  152. use_compression = false
  153. [dns]
  154. type = udp
  155. local_ip = 114.114.114.114
  156. local_port = 53
  157. remote_port = 6002
  158. use_encryption = false
  159. use_compression = false
  160. [range:udp_port]
  161. type = udp
  162. local_ip = 127.0.0.1
  163. local_port = 6010-6020
  164. remote_port = 6010-6020
  165. use_encryption = false
  166. use_compression = false
  167. # 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
  168. [web01]
  169. type = http
  170. local_ip = 127.0.0.1
  171. local_port = 80
  172. use_encryption = false
  173. use_compression = true
  174. # http username and password are safety certification for http protocol
  175. # if not set, you can access this custom_domains without certification
  176. http_user = admin
  177. http_pwd = admin
  178. # if domain for frps is frps.com, then you can access [web01] proxy by URL http://web01.frps.com
  179. subdomain = web01
  180. custom_domains = web01.yourdomain.com
  181. # locations is only available for http type
  182. locations = /,/pic
  183. # route requests to this service if http basic auto user is abc
  184. # route_by_http_user = abc
  185. host_header_rewrite = example.com
  186. # params with prefix "header_" will be used to update http request headers
  187. header_X-From-Where = frp
  188. health_check_type = http
  189. # frpc will send a GET http request '/status' to local http service
  190. # http service is alive when it return 2xx http response code
  191. health_check_url = /status
  192. health_check_interval_s = 10
  193. health_check_max_failed = 3
  194. health_check_timeout_s = 3
  195. [web02]
  196. type = https
  197. local_ip = 127.0.0.1
  198. local_port = 8000
  199. use_encryption = false
  200. use_compression = false
  201. subdomain = web01
  202. custom_domains = web02.yourdomain.com
  203. # if not empty, frpc will use proxy protocol to transfer connection info to your local service
  204. # v1 or v2 or empty
  205. proxy_protocol_version = v2
  206. [plugin_unix_domain_socket]
  207. type = tcp
  208. remote_port = 6003
  209. # if plugin is defined, local_ip and local_port is useless
  210. # plugin will handle connections got from frps
  211. plugin = unix_domain_socket
  212. # params with prefix "plugin_" that plugin needed
  213. plugin_unix_path = /var/run/docker.sock
  214. [plugin_http_proxy]
  215. type = tcp
  216. remote_port = 6004
  217. plugin = http_proxy
  218. plugin_http_user = abc
  219. plugin_http_passwd = abc
  220. [plugin_socks5]
  221. type = tcp
  222. remote_port = 6005
  223. plugin = socks5
  224. plugin_user = abc
  225. plugin_passwd = abc
  226. [plugin_static_file]
  227. type = tcp
  228. remote_port = 6006
  229. plugin = static_file
  230. plugin_local_path = /var/www/blog
  231. plugin_strip_prefix = static
  232. plugin_http_user = abc
  233. plugin_http_passwd = abc
  234. [plugin_https2http]
  235. type = https
  236. custom_domains = test.yourdomain.com
  237. plugin = https2http
  238. plugin_local_addr = 127.0.0.1:80
  239. plugin_crt_path = ./server.crt
  240. plugin_key_path = ./server.key
  241. plugin_host_header_rewrite = 127.0.0.1
  242. plugin_header_X-From-Where = frp
  243. [plugin_https2https]
  244. type = https
  245. custom_domains = test.yourdomain.com
  246. plugin = https2https
  247. plugin_local_addr = 127.0.0.1:443
  248. plugin_crt_path = ./server.crt
  249. plugin_key_path = ./server.key
  250. plugin_host_header_rewrite = 127.0.0.1
  251. plugin_header_X-From-Where = frp
  252. [plugin_http2https]
  253. type = http
  254. custom_domains = test.yourdomain.com
  255. plugin = http2https
  256. plugin_local_addr = 127.0.0.1:443
  257. plugin_host_header_rewrite = 127.0.0.1
  258. plugin_header_X-From-Where = frp
  259. [secret_tcp]
  260. # If the type is secret tcp, remote_port is useless
  261. # Who want to connect local port should deploy another frpc with stcp proxy and role is visitor
  262. type = stcp
  263. # sk used for authentication for visitors
  264. sk = abcdefg
  265. local_ip = 127.0.0.1
  266. local_port = 22
  267. use_encryption = false
  268. use_compression = false
  269. # user of frpc should be same in both stcp server and stcp visitor
  270. [secret_tcp_visitor]
  271. # frpc role visitor -> frps -> frpc role server
  272. role = visitor
  273. type = stcp
  274. # the server name you want to visitor
  275. server_name = secret_tcp
  276. sk = abcdefg
  277. # connect this address to visitor stcp server
  278. bind_addr = 127.0.0.1
  279. bind_port = 9000
  280. use_encryption = false
  281. use_compression = false
  282. [p2p_tcp]
  283. type = xtcp
  284. sk = abcdefg
  285. local_ip = 127.0.0.1
  286. local_port = 22
  287. use_encryption = false
  288. use_compression = false
  289. [p2p_tcp_visitor]
  290. role = visitor
  291. type = xtcp
  292. server_name = p2p_tcp
  293. sk = abcdefg
  294. bind_addr = 127.0.0.1
  295. bind_port = 9001
  296. use_encryption = false
  297. use_compression = false
  298. [tcpmuxhttpconnect]
  299. type = tcpmux
  300. multiplexer = httpconnect
  301. local_ip = 127.0.0.1
  302. local_port = 10701
  303. custom_domains = tunnel1
  304. # route_by_http_user = user1