frpc_full.ini 11 KB

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