mirror/frp
1
0
Fork 0
mirror of https://github.com/fatedier/frp.git synced 2024-11-24 02:59:19 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix example config (#3701)

Browse Source
This commit is contained in:
fatedier 2023-10-19 17:28:35 +08:00 committed by GitHub
parent 31190c703d
commit 9cb0726ebc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
conf/frpc.toml
View File

@ -36,7 +36,7 @@ auth.token = "12345678"
# auth.oidc.clientSecret = "" # auth.oidc.clientSecret = ""
# oidc.audience specifies the audience of the token in OIDC authentication. # oidc.audience specifies the audience of the token in OIDC authentication.
# auth.oidc.audience = "" # auth.oidc.audience = ""
# oidc_scope specifies the permisssions of the token in OIDC authentication if AuthenticationMethod == "oidc". By default, this value is "". # oidc.scope specifies the permisssions of the token in OIDC authentication if AuthenticationMethod == "oidc". By default, this value is "".
# auth.oidc.scope = "" # auth.oidc.scope = ""
# oidc.tokenEndpointURL specifies the URL which implements OIDC Token Endpoint. # oidc.tokenEndpointURL specifies the URL which implements OIDC Token Endpoint.
# It will be used to get an OIDC token. # It will be used to get an OIDC token.
@ -110,7 +110,7 @@ transport.tls.enable = true
# transport.tls.disableCustomTLSFirstByte = true # transport.tls.disableCustomTLSFirstByte = true
# Heartbeat configure, it's not recommended to modify the default value. # Heartbeat configure, it's not recommended to modify the default value.
# The default value of heartbeat_interval is 10 and heartbeat_timeout is 90. Set negative value # The default value of heartbeatInterval is 10 and heartbeatTimeout is 90. Set negative value
# to disable it. # to disable it.
# transport.heartbeatInterval = 30 # transport.heartbeatInterval = 30
# transport.heartbeatTimeout = 90 # transport.heartbeatTimeout = 90
@ -173,7 +173,7 @@ name = "ssh_random"
type = "tcp" type = "tcp"
localIP = "192.168.31.100" localIP = "192.168.31.100"
localPort = 22 localPort = 22
# If remote_port is 0, frps will assign a random port for you # If remotePort is 0, frps will assign a random port for you
remotePort = 0 remotePort = 0
[[proxies]] [[proxies]]
@ -183,14 +183,14 @@ localIP = "114.114.114.114"
localPort = 53 localPort = 53
remotePort = 6002 remotePort = 6002
# 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 # Resolve your domain names to [serverAddr] so you can use http://web01.yourdomain.com to browse web01 and http://web02.yourdomain.com to browse web02
[[proxies]] [[proxies]]
name = "web01" name = "web01"
type = "http" type = "http"
localIP = "127.0.0.1" localIP = "127.0.0.1"
localPort = 80 localPort = 80
# http username and password are safety certification for http protocol # http username and password are safety certification for http protocol
# if not set, you can access this custom_domains without certification # if not set, you can access this customDomains without certification
httpUser = "admin" httpUser = "admin"
httpPassword = "admin" httpPassword = "admin"
# if domain for frps is frps.com, then you can access [web01] proxy by URL http://web01.frps.com # if domain for frps is frps.com, then you can access [web01] proxy by URL http://web01.frps.com
@ -199,9 +199,8 @@ customDomains = ["web01.yourdomain.com"]
# locations is only available for http type # locations is only available for http type
locations = ["/", "/pic"] locations = ["/", "/pic"]
# route requests to this service if http basic auto user is abc # route requests to this service if http basic auto user is abc
# route_by_http_user = abc # routeByHTTPUser = abc
hostHeaderRewrite = "example.com" hostHeaderRewrite = "example.com"
# params with prefix "header_" will be used to update http request headers
requestHeaders.set.x-from-where = "frp" requestHeaders.set.x-from-where = "frp"
healthCheck.type = "http" healthCheck.type = "http"
# frpc will send a GET http request '/status' to local http service # frpc will send a GET http request '/status' to local http service
@ -235,7 +234,7 @@ customDomains = ["tunnel1"]
name = "plugin_unix_domain_socket" name = "plugin_unix_domain_socket"
type = "tcp" type = "tcp"
remotePort = 6003 remotePort = 6003
# if plugin is defined, local_ip and local_port is useless # if plugin is defined, localIP and localPort is useless
# plugin will handle connections got from frps # plugin will handle connections got from frps
[proxies.plugin] [proxies.plugin]
type = "unix_domain_socket" type = "unix_domain_socket"
@ -306,7 +305,7 @@ requestHeaders.set.x-from-where = "frp"
[[proxies]] [[proxies]]
name = "secret_tcp" name = "secret_tcp"
# If the type is secret tcp, remote_port is useless # If the type is secret tcp, remotePort is useless
# Who want to connect local port should deploy another frpc with stcp proxy and role is visitor # Who want to connect local port should deploy another frpc with stcp proxy and role is visitor
type = "stcp" type = "stcp"
# secretKey is used for authentication for visitors # secretKey is used for authentication for visitors
@ -353,7 +352,7 @@ bindAddr = "127.0.0.1"
bindPort = 9001 bindPort = 9001
# when automatic tunnel persistence is required, set it to true # when automatic tunnel persistence is required, set it to true
keepTunnelOpen = false keepTunnelOpen = false
# effective when keep_tunnel_open is set to true, the number of attempts to punch through per hour # effective when keepTunnelOpen is set to true, the number of attempts to punch through per hour
maxRetriesAnHour = 8 maxRetriesAnHour = 8
minRetryInterval = 90 minRetryInterval = 90
# fallbackTo = "stcp_visitor" # fallbackTo = "stcp_visitor"

14
conf/frps.toml
View File

@ -1,10 +1,10 @@
# A literal address or host name for IPv6 must be enclosed # 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" # in square brackets, as in "[::1]:80", "[ipv6-host]:http" or "[ipv6-host%zone]:80"
# For single "bind_addr" field, no need square brackets, like "bind_addr = ::". # For single "bindAddr" field, no need square brackets, like `bindAddr = "::"`.
bindAddr = "0.0.0.0" bindAddr = "0.0.0.0"
bindPort = 7000 bindPort = 7000
# udp port used for kcp protocol, it can be same with 'bind_port'. # udp port used for kcp protocol, it can be same with 'bindPort'.
# if not set, kcp is disabled in frps. # if not set, kcp is disabled in frps.
kcpBindPort = 7000 kcpBindPort = 7000
@ -12,8 +12,8 @@ kcpBindPort = 7000
# if not set, quic is disabled in frps. # if not set, quic is disabled in frps.
# quicBindPort = 7002 # quicBindPort = 7002
# Specify which address proxy will listen for, default value is same with bind_addr # Specify which address proxy will listen for, default value is same with bindAddr
# proxy_bind_addr = "127.0.0.1" # proxyBindAddr = "127.0.0.1"
# quic protocol options # quic protocol options
# transport.quic.keepalivePeriod = 10 # transport.quic.keepalivePeriod = 10
@ -21,7 +21,7 @@ kcpBindPort = 7000
# transport.quic.maxIncomingStreams = 100000 # transport.quic.maxIncomingStreams = 100000
# Heartbeat configure, it's not recommended to modify the default value # Heartbeat configure, it's not recommended to modify the default value
# The default value of heartbeat_timeout is 90. Set negative value to disable it. # The default value of heartbeatTimeout is 90. Set negative value to disable it.
# transport.heartbeatTimeout = 90 # transport.heartbeatTimeout = 90
# Pool count in each proxy will keep no more than maxPoolCount. # Pool count in each proxy will keep no more than maxPoolCount.
@ -46,7 +46,7 @@ tls.force = false
# transport.tls.trustedCaFile = "ca.crt" # transport.tls.trustedCaFile = "ca.crt"
# If you want to support virtual host, you must set the http port for listening (optional) # If you want to support virtual host, you must set the http port for listening (optional)
# Note: http port and https port can be same with bind_port # Note: http port and https port can be same with bindPort
vhostHTTPPort = 80 vhostHTTPPort = 80
vhostHTTPSPort = 443 vhostHTTPSPort = 443
@ -59,7 +59,7 @@ vhostHTTPSPort = 443
# HTTP CONNECT requests. By default, this value is 0. # HTTP CONNECT requests. By default, this value is 0.
# tcpmuxHTTPConnectPort = 1337 # tcpmuxHTTPConnectPort = 1337
# If tcpmux_passthrough is true, frps won't do any update on traffic. # If tcpmuxPassthrough is true, frps won't do any update on traffic.
# tcpmuxPassthrough = false # tcpmuxPassthrough = false
# Configure the web server to enable the dashboard for frps. # Configure the web server to enable the dashboard for frps.

1
pkg/config/v1/server.go
View File

@ -150,6 +150,7 @@ type ServerTransportConfig struct {
// TCPMux toggles TCP stream multiplexing. This allows multiple requests // TCPMux toggles TCP stream multiplexing. This allows multiple requests
// from a client to share a single TCP connection. By default, this value // from a client to share a single TCP connection. By default, this value
// is true. // is true.
// $HideFromDoc
TCPMux *bool `json:"tcpMux,omitempty"` TCPMux *bool `json:"tcpMux,omitempty"`
// TCPMuxKeepaliveInterval specifies the keep alive interval for TCP stream multipler. // TCPMuxKeepaliveInterval specifies the keep alive interval for TCP stream multipler.
// If TCPMux is true, heartbeat of application layer is unnecessary because it can only rely on heartbeat in TCPMux. // If TCPMux is true, heartbeat of application layer is unnecessary because it can only rely on heartbeat in TCPMux.