Repository files navigation

README |中文文档

frp is an open source project with its ongoing development made possible entirely by the support of our awesome sponsors. If you'd like to join them, please considersponsoring frp's development.

frp is a fast reverse proxy that allows you to expose a local server located behind a NAT or firewall to the Internet. It currently supportsTCP andUDP, as well asHTTP andHTTPS protocols, enabling requests to be forwarded to internal services via domain name.

frp also offers a P2P connect mode.

• Development Status
  • About V2
• Architecture
• Example Usage
  • Access your computer in a LAN network via SSH
  • Multiple SSH services sharing the same port
  • Accessing Internal Web Services with Custom Domains in LAN
  • Forward DNS query requests
  • Forward Unix Domain Socket
  • Expose a simple HTTP file server
  • Enable HTTPS for a local HTTP(S) service
  • Expose your service privately
  • P2P Mode
• Features
  • Configuration Files
  • Using Environment Variables
  • Split Configures Into Different Files
  • Server Dashboard
  • Client Admin UI
  • Monitor
    • Prometheus
  • Authenticating the Client
    • Token Authentication
    • OIDC Authentication
  • Encryption and Compression
    • TLS
  • Hot-Reloading frpc configuration
  • Get proxy status from client
  • Only allowing certain ports on the server
  • Port Reuse
  • Bandwidth Limit
    • For Each Proxy
  • TCP Stream Multiplexing
  • Support KCP Protocol
  • Support QUIC Protocol
  • Connection Pooling
  • Load balancing
  • Service Health Check
  • Rewriting the HTTP Host Header
  • Setting other HTTP Headers
  • Get Real IP
    • HTTP X-Forwarded-For
    • Proxy Protocol
  • Require HTTP Basic Auth (Password) for Web Services
  • Custom Subdomain Names
  • URL Routing
  • TCP Port Multiplexing
  • Connecting to frps via PROXY
  • Port range mapping
  • Client Plugins
  • Server Manage Plugins
  • SSH Tunnel Gateway
• Related Projects
• Contributing
• Donation
  • GitHub Sponsors
  • PayPal

frp is currently under development. You can try the latest release version in themaster branch, or use thedev branch to access the version currently in development.

We are currently working on version 2 and attempting to perform some code refactoring and improvements. However, please note that it will not be compatible with version 1.

We will transition from version 0 to version 1 at the appropriate time and will only accept bug fixes and improvements, rather than big feature requests.

The complexity and difficulty of the v2 version are much higher than anticipated. I can only work on its development during fragmented time periods, and the constant interruptions disrupt productivity significantly. Given this situation, we will continue to optimize and iterate on the current version until we have more free time to proceed with the major version overhaul.

The concept behind v2 is based on my years of experience and reflection in the cloud-native domain, particularly in K8s and ServiceMesh. Its core is a modernized four-layer and seven-layer proxy, similar to envoy. This proxy itself is highly scalable, not only capable of implementing the functionality of intranet penetration but also applicable to various other domains. Building upon this highly scalable core, we aim to implement all the capabilities of frp v1 while also addressing the functionalities that were previously unachievable or difficult to implement in an elegant manner. Furthermore, we will maintain efficient development and iteration capabilities.

In addition, I envision frp itself becoming a highly extensible system and platform, similar to how we can provide a range of extension capabilities based on K8s. In K8s, we can customize development according to enterprise needs, utilizing features such as CRD, controller mode, webhook, CSI, and CNI. In frp v1, we introduced the concept of server plugins, which implemented some basic extensibility. However, it relies on a simple HTTP protocol and requires users to start independent processes and manage them on their own. This approach is far from flexible and convenient, and real-world demands vary greatly. It is unrealistic to expect a non-profit open-source project maintained by a few individuals to meet everyone's needs.

Finally, we acknowledge that the current design of modules such as configuration management, permission verification, certificate management, and API management is not modern enough. While we may carry out some optimizations in the v1 version, ensuring compatibility remains a challenging issue that requires a considerable amount of effort to address.

We sincerely appreciate your support for frp.

To begin, download the latest program for your operating system and architecture from theRelease page.

Next, place thefrps binary and server configuration file on Server A, which has a public IP address.

Finally, place thefrpc binary and client configuration file on Server B, which is located on a LAN that cannot be directly accessed from the public internet.

Some antiviruses improperly mark frpc as malware and delete it. This is due to frp being a networking tool capable of creating reverse proxies. Antiviruses sometimes flag reverse proxies due to their ability to bypass firewall port restrictions. If you are using antivirus, then you may need to whitelist/exclude frpc in your antivirus settings to avoid accidental quarantine/deletion. Seeissue 3637 for more details.

1. Modifyfrps.toml on server A by setting thebindPort for frp clients to connect to:

# frps.tomlbindPort =7000

2. Startfrps on server A:

./frps -c ./frps.toml

3. Modifyfrpc.toml on server B and set theserverAddr field to the public IP address of your frps server:

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000[[proxies]]name ="ssh"type ="tcp"localIP ="127.0.0.1"localPort =22remotePort =6000

Note that thelocalPort (listened on the client) andremotePort (exposed on the server) are used for traffic going in and out of the frp system, while theserverPort is used for communication between frps and frpc.

4. Startfrpc on server B:

./frpc -c ./frpc.toml

5. To access server B from another machine through server A via SSH (assuming the username istest), use the following command:

ssh -oPort=6000 test@x.x.x.x

This example implements multiple SSH services exposed through the same port using a proxy of type tcpmux. Similarly, as long as the client supports the HTTP Connect proxy connection method, port reuse can be achieved in this way.

1. Deploy frps on a machine with a public IP and modify the frps.toml file. Here is a simplified configuration:

bindPort =7000tcpmuxHTTPConnectPort =5002

2. Deploy frpc on the internal machine A with the following configuration:

serverAddr ="x.x.x.x"serverPort =7000[[proxies]]name ="ssh1"type ="tcpmux"multiplexer ="httpconnect"customDomains = ["machine-a.example.com"]localIP ="127.0.0.1"localPort =22

3. Deploy another frpc on the internal machine B with the following configuration:

serverAddr ="x.x.x.x"serverPort =7000[[proxies]]name ="ssh2"type ="tcpmux"multiplexer ="httpconnect"customDomains = ["machine-b.example.com"]localIP ="127.0.0.1"localPort =22

4. To access internal machine A using SSH ProxyCommand, assuming the username is "test":

ssh -o 'proxycommand socat - PROXY:x.x.x.x:%h:%p,proxyport=5002' test@machine-a.example.com

5. To access internal machine B, the only difference is the domain name, assuming the username is "test":

ssh -o 'proxycommand socat - PROXY:x.x.x.x:%h:%p,proxyport=5002' test@machine-b.example.com

Sometimes we need to expose a local web service behind a NAT network to others for testing purposes with our own domain name.

Unfortunately, we cannot resolve a domain name to a local IP. However, we can use frp to expose an HTTP(S) service.

1. Modifyfrps.toml and set the HTTP port for vhost to 8080:

# frps.tomlbindPort =7000vhostHTTPPort =8080

If you want to configure an https proxy, you need to set up thevhostHTTPSPort.

2. Startfrps:

./frps -c ./frps.toml

3. Modifyfrpc.toml and setserverAddr to the IP address of the remote frps server. Specify thelocalPort of your web service:

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000[[proxies]]name ="web"type ="http"localPort =80customDomains = ["www.example.com"]

4. Startfrpc:

./frpc -c ./frpc.toml

5. Map the A record ofwww.example.com to either the public IP of the remote frps server or a CNAME record pointing to your original domain.

6. Visit your local web service using urlhttp://www.example.com:8080.

1. Modifyfrps.toml:

# frps.tomlbindPort =7000

2. Startfrps:

./frps -c ./frps.toml

3. Modifyfrpc.toml and setserverAddr to the IP address of the remote frps server. Forward DNS query requests to the Google Public DNS server8.8.8.8:53:

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000[[proxies]]name ="dns"type ="udp"localIP ="8.8.8.8"localPort =53remotePort =6000

4. Start frpc:

./frpc -c ./frpc.toml

5. Test DNS resolution using thedig command:

dig @x.x.x.x -p 6000 www.google.com

Expose a Unix domain socket (e.g. the Docker daemon socket) as TCP.

Configurefrps as above.

1. Startfrpc with the following configuration:

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000[[proxies]]name ="unix_domain_socket"type ="tcp"remotePort =6000[proxies.plugin]type ="unix_domain_socket"unixPath ="/var/run/docker.sock"

2. Test the configuration by getting the docker version usingcurl:

curl http://x.x.x.x:6000/version

Expose a simple HTTP file server to access files stored in the LAN from the public Internet.

Configurefrps as described above, then:

1. Startfrpc with the following configuration:

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000[[proxies]]name ="test_static_file"type ="tcp"remotePort =6000[proxies.plugin]type ="static_file"localPath ="/tmp/files"stripPrefix ="static"httpUser ="abc"httpPassword ="abc"

2. Visithttp://x.x.x.x:6000/static/ from your browser and specify correct username and password to view files in/tmp/files on thefrpc machine.

You may substitutehttps2https for the plugin, and point thelocalAddr to a HTTPS endpoint.

1. Startfrpc with the following configuration:

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000[[proxies]]name ="test_https2http"type ="https"customDomains = ["test.example.com"][proxies.plugin]type ="https2http"localAddr ="127.0.0.1:80"crtPath ="./server.crt"keyPath ="./server.key"hostHeaderRewrite ="127.0.0.1"requestHeaders.set.x-from-where ="frp"

2. Visithttps://test.example.com.

To mitigate risks associated with exposing certain services directly to the public network, STCP (Secret TCP) mode requires a preshared key to be used for access to the service from other clients.

Configurefrps same as above.

1. Startfrpc on machine B with the following config. This example is for exposing the SSH service (port 22), and note thesecretKey field for the preshared key, and that theremotePort field is removed here:

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000[[proxies]]name ="secret_ssh"type ="stcp"secretKey ="abcdefg"localIP ="127.0.0.1"localPort =22

2. Start anotherfrpc (typically on another machine C) with the following config to access the SSH service with a security key (secretKey field):

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000[[visitors]]name ="secret_ssh_visitor"type ="stcp"serverName ="secret_ssh"secretKey ="abcdefg"bindAddr ="127.0.0.1"bindPort =6000

3. On machine C, connect to SSH on machine B, using this command:

ssh -oPort=6000 127.0.0.1

xtcp is designed to transmit large amounts of data directly between clients. A frps server is still needed, as P2P here only refers to the actual data transmission.

Note that it may not work with all types of NAT devices. You might want to fallback to stcp if xtcp doesn't work.

1. Startfrpc on machine B, and expose the SSH port. Note that theremotePort field is removed:

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000# set up a new stun server if the default one is not available.# natHoleStunServer = "xxx"[[proxies]]name ="p2p_ssh"type ="xtcp"secretKey ="abcdefg"localIP ="127.0.0.1"localPort =22

2. Start anotherfrpc (typically on another machine C) with the configuration to connect to SSH using P2P mode:

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000# set up a new stun server if the default one is not available.# natHoleStunServer = "xxx"[[visitors]]name ="p2p_ssh_visitor"type ="xtcp"serverName ="p2p_ssh"secretKey ="abcdefg"bindAddr ="127.0.0.1"bindPort =6000# when automatic tunnel persistence is required, set it to truekeepTunnelOpen =false

3. On machine C, connect to SSH on machine B, using this command:

ssh -oPort=6000 127.0.0.1

Since v0.52.0, we support TOML, YAML, and JSON for configuration. Please note that INI is deprecated and will be removed in future releases. New features will only be available in TOML, YAML, or JSON. Users wanting these new features should switch their configuration format accordingly.

Read the full example configuration files to find out even more features not described here.

Examples use TOML format, but you can still use YAML or JSON.

These configuration files is for reference only. Please do not use this configuration directly to run the program as it may have various issues.

Full configuration file for frps (Server)

Full configuration file for frpc (Client)

Environment variables can be referenced in the configuration file, using Go's standard format:

# frpc.tomlserverAddr ="{{ .Envs.FRP_SERVER_ADDR }}"serverPort =7000[[proxies]]name ="ssh"type ="tcp"localIP ="127.0.0.1"localPort =22remotePort ="{{ .Envs.FRP_SSH_REMOTE_PORT }}"

With the config above, variables can be passed intofrpc program like this:

export FRP_SERVER_ADDR=x.x.x.xexport FRP_SSH_REMOTE_PORT=6000./frpc -c ./frpc.toml

frpc will render configuration file template using OS environment variables. Remember to prefix your reference with.Envs.

You can split multiple proxy configs into different files and include them in the main file.

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000includes = ["./confd/*.toml"]

# ./confd/test.toml[[proxies]]name ="ssh"type ="tcp"localIP ="127.0.0.1"localPort =22remotePort =6000

Check frp's status and proxies' statistics information by Dashboard.

Configure a port for dashboard to enable this feature:

# The default value is 127.0.0.1. Change it to 0.0.0.0 when you want to access it from a public network.webServer.addr ="0.0.0.0"webServer.port =7500# dashboard's username and password are both optionalwebServer.user ="admin"webServer.password ="admin"

Then visithttp://[serverAddr]:7500 to see the dashboard, with username and password both beingadmin.

Additionally, you can use HTTPS port by using your domains wildcard or normal SSL certificate:

webServer.port =7500# dashboard's username and password are both optionalwebServer.user ="admin"webServer.password ="admin"webServer.tls.certFile ="server.crt"webServer.tls.keyFile ="server.key"

Then visithttps://[serverAddr]:7500 to see the dashboard in secure HTTPS connection, with username and password both beingadmin.

The Client Admin UI helps you check and manage frpc's configuration.

Configure an address for admin UI to enable this feature:

webServer.addr ="127.0.0.1"webServer.port =7400webServer.user ="admin"webServer.password ="admin"

Then visithttp://127.0.0.1:7400 to see admin UI, with username and password both beingadmin.

When web server is enabled, frps will save monitor data in cache for 7 days. It will be cleared after process restart.

Prometheus is also supported.

Enable dashboard first, then configureenablePrometheus = true infrps.toml.

http://{dashboard_addr}/metrics will provide prometheus monitor data.

There are 2 authentication methods to authenticate frpc with frps.

You can decide which one to use by configuringauth.method infrpc.toml andfrps.toml, the default one is token.

Configuringauth.additionalScopes = ["HeartBeats"] will use the configured authentication method to add and validate authentication on every heartbeat between frpc and frps.

Configuringauth.additionalScopes = ["NewWorkConns"] will do the same for every new work connection between frpc and frps.

When specifyingauth.method = "token" infrpc.toml andfrps.toml - token based authentication will be used.

Make sure to specify the sameauth.token infrps.toml andfrpc.toml for frpc to pass frps validation

When specifyingauth.method = "oidc" infrpc.toml andfrps.toml - OIDC based authentication will be used.

OIDC stands for OpenID Connect, and the flow used is calledClient Credentials Grant.

To use this authentication type - configurefrpc.toml andfrps.toml as follows:

# frps.tomlauth.method ="oidc"auth.oidc.issuer ="https://example-oidc-issuer.com/"auth.oidc.audience ="https://oidc-audience.com/.default"

# frpc.tomlauth.method ="oidc"auth.oidc.clientID ="98692467-37de-409a-9fac-bb2585826f18"# Replace with OIDC client IDauth.oidc.clientSecret ="oidc_secret"auth.oidc.audience ="https://oidc-audience.com/.default"auth.oidc.tokenEndpointURL ="https://example-oidc-endpoint.com/oauth2/v2.0/token"

The features are off by default. You can turn on encryption and/or compression:

# frpc.toml[[proxies]]name ="ssh"type ="tcp"localPort =22remotePort =6000transport.useEncryption =truetransport.useCompression =true

Since v0.50.0, the default value oftransport.tls.enable andtransport.tls.disableCustomTLSFirstByte has been changed to true, and tls is enabled by default.

For port multiplexing, frp sends a first byte0x17 to dial a TLS connection. This only takes effect when you settransport.tls.disableCustomTLSFirstByte to false.

Toenforcefrps to only accept TLS connections - configuretransport.tls.force = true infrps.toml.This is optional.

frpc TLS settings:

transport.tls.enable =truetransport.tls.certFile ="certificate.crt"transport.tls.keyFile ="certificate.key"transport.tls.trustedCaFile ="ca.crt"

frps TLS settings:

transport.tls.force =truetransport.tls.certFile ="certificate.crt"transport.tls.keyFile ="certificate.key"transport.tls.trustedCaFile ="ca.crt"

You will needa root CA cert andat least one SSL/TLS certificate. Itcan be self-signed or regular (such as Let's Encrypt or another SSL/TLS certificate provider).

If you usingfrp via IP address and not hostname, make sure to set the appropriate IP address in the Subject Alternative Name (SAN) area when generating SSL/TLS Certificates.

Given an example:

• Prepare openssl config file. It exists at/etc/pki/tls/openssl.cnf in Linux System and/System/Library/OpenSSL/openssl.cnf in MacOS, and you can copy it to current path, likecp /etc/pki/tls/openssl.cnf ./my-openssl.cnf. If not, you can build it by yourself, like:

cat > my-openssl.cnf << EOF[ ca ]default_ca = CA_default[ CA_default ]x509_extensions = usr_cert[ req ]default_bits        = 2048default_md          = sha256default_keyfile     = privkey.pemdistinguished_name  = req_distinguished_nameattributes          = req_attributesx509_extensions     = v3_castring_mask         = utf8only[ req_distinguished_name ][ req_attributes ][ usr_cert ]basicConstraints       = CA:FALSEnsComment              = "OpenSSL Generated Certificate"subjectKeyIdentifier   = hashauthorityKeyIdentifier = keyid,issuer[ v3_ca ]subjectKeyIdentifier   = hashauthorityKeyIdentifier = keyid:always,issuerbasicConstraints       = CA:trueEOF

• build ca certificates:

openssl genrsa -out ca.key 2048openssl req -x509 -new -nodes -key ca.key -subj "/CN=example.ca.com" -days 5000 -out ca.crt

• build frps certificates:

openssl genrsa -out server.key 2048openssl req -new -sha256 -key server.key \    -subj "/C=XX/ST=DEFAULT/L=DEFAULT/O=DEFAULT/CN=server.com" \    -reqexts SAN \    -config <(cat my-openssl.cnf <(printf "\n[SAN]\nsubjectAltName=DNS:localhost,IP:127.0.0.1,DNS:example.server.com")) \    -out server.csropenssl x509 -req -days 365 -sha256 \-in server.csr -CA ca.crt -CAkey ca.key -CAcreateserial \-extfile <(printf "subjectAltName=DNS:localhost,IP:127.0.0.1,DNS:example.server.com") \-out server.crt

• build frpc certificates：

openssl genrsa -out client.key 2048openssl req -new -sha256 -key client.key \    -subj "/C=XX/ST=DEFAULT/L=DEFAULT/O=DEFAULT/CN=client.com" \    -reqexts SAN \    -config <(cat my-openssl.cnf <(printf "\n[SAN]\nsubjectAltName=DNS:client.com,DNS:example.client.com")) \    -out client.csropenssl x509 -req -days 365 -sha256 \    -in client.csr -CA ca.crt -CAkey ca.key -CAcreateserial \-extfile <(printf "subjectAltName=DNS:client.com,DNS:example.client.com") \-out client.crt

ThewebServer fields are required for enabling HTTP API:

# frpc.tomlwebServer.addr ="127.0.0.1"webServer.port =7400

Then run commandfrpc reload -c ./frpc.toml and wait for about 10 seconds to letfrpc create or update or remove proxies.

Note that global client parameters won't be modified except 'start'.

You can run commandfrpc verify -c ./frpc.toml before reloading to check if there are config errors.

Usefrpc status -c ./frpc.toml to get status of all proxies. ThewebServer fields are required for enabling HTTP API.

allowPorts infrps.toml is used to avoid abuse of ports:

# frps.tomlallowPorts = [  {start =2000,end =3000 },  {single =3001 },  {single =3003 },  {start =4000,end =50000 }]

vhostHTTPPort andvhostHTTPSPort in frps can use same port withbindPort. frps will detect the connection's protocol and handle it correspondingly.

What you need to pay attention to is that if you want to configurevhostHTTPSPort andbindPort to the same port, you need to first settransport.tls.disableCustomTLSFirstByte to false.

We would like to try to allow multiple proxies bind a same remote port with different protocols in the future.

# frpc.toml[[proxies]]name ="ssh"type ="tcp"localPort =22remotePort =6000transport.bandwidthLimit ="1MB"

Settransport.bandwidthLimit in each proxy's configure to enable this feature. Supported units areMB andKB.

Settransport.bandwidthLimitMode toclient orserver to limit bandwidth on the client or server side. Default isclient.

frp supports tcp stream multiplexing since v0.10.0 like HTTP2 Multiplexing, in which case all logic connections to the same frpc are multiplexed into the same TCP connection.

You can disable this feature by modifyfrps.toml andfrpc.toml:

# frps.toml and frpc.toml, must be sametransport.tcpMux =false

KCP is a fast and reliable protocol that can achieve the transmission effect of a reduction of the average latency by 30% to 40% and reduction of the maximum delay by a factor of three, at the cost of 10% to 20% more bandwidth wasted than TCP.

KCP mode uses UDP as the underlying transport. Using KCP in frp:

1. Enable KCP in frps:

# frps.tomlbindPort =7000# Specify a UDP port for KCP.kcpBindPort =7000

ThekcpBindPort number can be the same number asbindPort, sincebindPort field specifies a TCP port.

2. Configurefrpc.toml to use KCP to connect to frps:

# frpc.tomlserverAddr ="x.x.x.x"# Same as the 'kcpBindPort' in frps.tomlserverPort =7000transport.protocol ="kcp"

QUIC is a new multiplexed transport built on top of UDP.

Using QUIC in frp:

1. Enable QUIC in frps:

# frps.tomlbindPort =7000# Specify a UDP port for QUIC.quicBindPort =7000

ThequicBindPort number can be the same number asbindPort, sincebindPort field specifies a TCP port.

2. Configurefrpc.toml to use QUIC to connect to frps:

# frpc.tomlserverAddr ="x.x.x.x"# Same as the 'quicBindPort' in frps.tomlserverPort =7000transport.protocol ="quic"

By default, frps creates a new frpc connection to the backend service upon a user request. With connection pooling, frps keeps a certain number of pre-established connections, reducing the time needed to establish a connection.

This feature is suitable for a large number of short connections.

1. Configure the limit of pool count each proxy can use infrps.toml:

# frps.tomltransport.maxPoolCount =5

2. Enable and specify the number of connection pool:

# frpc.tomltransport.poolCount =1

Load balancing is supported bygroup.

This feature is only available for typestcp,http,tcpmux now.

# frpc.toml[[proxies]]name ="test1"type ="tcp"localPort =8080remotePort =80loadBalancer.group ="web"loadBalancer.groupKey ="123"[[proxies]]name ="test2"type ="tcp"localPort =8081remotePort =80loadBalancer.group ="web"loadBalancer.groupKey ="123"

loadBalancer.groupKey is used for authentication.

Connections to port 80 will be dispatched to proxies in the same group randomly.

For typetcp,remotePort in the same group should be the same.

For typehttp,customDomains,subdomain,locations should be the same.

Health check feature can help you achieve high availability with load balancing.

AddhealthCheck.type = "tcp" orhealthCheck.type = "http" to enable health check.

With health check typetcp, the service port will be pinged (TCPing):

# frpc.toml[[proxies]]name ="test1"type ="tcp"localPort =22remotePort =6000# Enable TCP health checkhealthCheck.type ="tcp"# TCPing timeout secondshealthCheck.timeoutSeconds =3# If health check failed 3 times in a row, the proxy will be removed from frpshealthCheck.maxFailed =3# A health check every 10 secondshealthCheck.intervalSeconds =10

With health check typehttp, an HTTP request will be sent to the service and an HTTP 2xx OK response is expected:

# frpc.toml[[proxies]]name ="web"type ="http"localIP ="127.0.0.1"localPort =80customDomains = ["test.example.com"]# Enable HTTP health checkhealthCheck.type ="http"# frpc will send a GET request to '/status'# and expect an HTTP 2xx OK responsehealthCheck.path ="/status"healthCheck.timeoutSeconds =3healthCheck.maxFailed =3healthCheck.intervalSeconds =10

By default frp does not modify the tunneled HTTP requests at all as it's a byte-for-byte copy.

However, speaking of web servers and HTTP requests, your web server might rely on theHost HTTP header to determine the website to be accessed. frp can rewrite theHost header when forwarding the HTTP requests, with thehostHeaderRewrite field:

# frpc.toml[[proxies]]name ="web"type ="http"localPort =80customDomains = ["test.example.com"]hostHeaderRewrite ="dev.example.com"

The HTTP request will have theHost header rewritten toHost: dev.example.com when it reaches the actual web server, although the request from the browser probably hasHost: test.example.com.

Similar toHost, You can override other HTTP request and response headers with proxy typehttp.

# frpc.toml[[proxies]]name ="web"type ="http"localPort =80customDomains = ["test.example.com"]hostHeaderRewrite ="dev.example.com"requestHeaders.set.x-from-where ="frp"responseHeaders.set.foo ="bar"

In this example, it will set headerx-from-where: frp in the HTTP request andfoo: bar in the HTTP response.

This feature is forhttp proxies or proxies with thehttps2http andhttps2https plugins enabled.

You can get user's real IP from HTTP request headersX-Forwarded-For.

frp supports Proxy Protocol to send user's real IP to local services. It support all types except UDP.

Here is an example for https service:

# frpc.toml[[proxies]]name ="web"type ="https"localPort =443customDomains = ["test.example.com"]# now v1 and v2 are supportedtransport.proxyProtocolVersion ="v2"

You can enable Proxy Protocol support in nginx to expose user's real IP in HTTP headerX-Real-IP, and then readX-Real-IP header in your web service for the real IP.

Anyone who can guess your tunnel URL can access your local web server unless you protect it with a password.

This enforces HTTP Basic Auth on all requests with the username and password specified in frpc's configure file.

It can only be enabled when proxy type is http.

# frpc.toml[[proxies]]name ="web"type ="http"localPort =80customDomains = ["test.example.com"]httpUser ="abc"httpPassword ="abc"

Visithttp://test.example.com in the browser and now you are prompted to enter the username and password.

It is convenient to usesubdomain configure for http and https types when many people share one frps server.

# frps.tomlsubDomainHost ="frps.com"

Resolve*.frps.com to the frps server's IP. This is usually called a Wildcard DNS record.

# frpc.toml[[proxies]]name ="web"type ="http"localPort =80subdomain ="test"

Now you can visit your web service ontest.frps.com.

Note that ifsubdomainHost is not empty,customDomains should not be the subdomain ofsubdomainHost.

frp supports forwarding HTTP requests to different backend web services by url routing.

locations specifies the prefix of URL used for routing. frps first searches for the most specific prefix location given by literal strings regardless of the listed order.

# frpc.toml[[proxies]]name ="web01"type ="http"localPort =80customDomains = ["web.example.com"]locations = ["/"][[proxies]]name ="web02"type ="http"localPort =81customDomains = ["web.example.com"]locations = ["/news","/about"]

HTTP requests with URL prefix/news or/about will be forwarded toweb02 and other requests toweb01.

frp supports receiving TCP sockets directed to different proxies on a single port on frps, similar tovhostHTTPPort andvhostHTTPSPort.

The only supported TCP port multiplexing method available at the moment ishttpconnect - HTTP CONNECT tunnel.

When settingtcpmuxHTTPConnectPort to anything other than 0 in frps, frps will listen on this port for HTTP CONNECT requests.

The host of the HTTP CONNECT request will be used to match the proxy in frps. Proxy hosts can be configured in frpc by configuringcustomDomains and / orsubdomain undertcpmux proxies, whenmultiplexer = "httpconnect".

For example:

# frps.tomlbindPort =7000tcpmuxHTTPConnectPort =1337

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000[[proxies]]name ="proxy1"type ="tcpmux"multiplexer ="httpconnect"customDomains = ["test1"]localPort =80[[proxies]]name ="proxy2"type ="tcpmux"multiplexer ="httpconnect"customDomains = ["test2"]localPort =8080

In the above configuration - frps can be contacted on port 1337 with a HTTP CONNECT header such as:

CONNECT test1 HTTP/1.1\r\n\r\n

and the connection will be routed toproxy1.

frpc can connect to frps through proxy if you set OS environment variableHTTP_PROXY, or iftransport.proxyURL is set in frpc.toml file.

It only works when protocol is tcp.

# frpc.tomlserverAddr ="x.x.x.x"serverPort =7000transport.proxyURL ="http://user:pwd@192.168.1.128:8080"

Added in v0.56.0

We can use the range syntax of Go template combined with the built-inparseNumberRangePair function to achieve port range mapping.

The following example, when run, will create 8 proxies namedtest-6000, test-6001 ... test-6007, each mapping the remote port to the local port.

{{- range $_, $v := parseNumberRangePair "6000-6006,6007" "6000-6006,6007" }}[[proxies]]name = "tcp-{{ $v.First }}"type = "tcp"localPort = {{ $v.First }}remotePort = {{ $v.Second }}{{- end }}

frpc only forwards requests to local TCP or UDP ports by default.

Plugins are used for providing rich features. There are built-in plugins such asunix_domain_socket,http_proxy,socks5,static_file,http2https,https2http,https2https and you can seeexample usage.

Using pluginhttp_proxy:

# frpc.toml[[proxies]]name ="http_proxy"type ="tcp"remotePort =6000[proxies.plugin]type ="http_proxy"httpUser ="abc"httpPassword ="abc"

httpUser andhttpPassword are configuration parameters used inhttp_proxy plugin.

Read thedocument.

Find more plugins ingofrp/plugin.

added in v0.53.0

frp supports listening to an SSH port on the frps side and achieves TCP protocol proxying through the SSH -R protocol, without relying on frpc.

# frps.tomlsshTunnelGateway.bindPort =2200

When running./frps -c frps.toml, a private key file named.autogen_ssh_key will be automatically created in the current working directory. This generated private key file will be used by the SSH server in frps.

Executing the command

ssh -R :80:127.0.0.1:8080 v0@{frp address} -p 2200 tcp --proxy_name"test-tcp" --remote_port 9090

sets up a proxy on frps that forwards the local 8080 service to the port 9090.

frp (via SSH) (Ctrl+C to quit)User:ProxyName: test-tcpType: tcpRemoteAddress: :9090

This is equivalent to:

frpc tcp --proxy_name"test-tcp" --local_ip 127.0.0.1 --local_port 8080 --remote_port 9090

Please refer to thisdocument for more information.

• gofrp/plugin - A repository for frp plugins that contains a variety of plugins implemented based on the frp extension mechanism, meeting the customization needs of different scenarios.
• gofrp/tiny-frpc - A lightweight version of the frp client (around 3.5MB at minimum) implemented using the ssh protocol, supporting some of the most commonly used features, suitable for devices with limited resources.

Interested in getting involved? We would like to help you!

• Take a look at ourissues list and consider sending a Pull Request todev branch.
• If you want to add a new feature, please create an issue first to describe the new feature, as well as the implementation approach. Once a proposal is accepted, create an implementation of the new features and submit it as a pull request.
• Sorry for my poor English. Improvements for this document are welcome, even some typo fixes.
• If you have great ideas, send an email tofatedier@gmail.com.

Note: We prefer you to give your advise inissues, so others with a same question can search it quickly and we don't need to answer them repeatedly.

If frp helps you a lot, you can support us by:

Support us byGithub Sponsors.

You can have your company's logo placed on README file of this project.

Donate money byPayPal to my accountfatedier@gmail.com.