Examples on frp

Access Intranet Machines via SSH

Mon, 01 Jan 0001 00:00:00 +0000

Steps

Deploy frps on a machine with public IP

Deploy frps and edit the frps.toml file. Here is a simplified configuration where we set the port for the frp server to receive client connections:
```
bindPort = 7000
```
Deploy frpc on the intranet machine that needs to be accessed

Deploy frpc and edit the frpc.toml file. Assume the public IP address of the server where frps is located is x.x.x.x. Here is an example configuration:

Multiple SSH Services Sharing the Same Port

Mon, 01 Jan 0001 00:00:00 +0000

Steps

Deploy frps on a machine with public IP

Modify the frps.toml file to include the following content (using the most simplified configuration here):
```
bindPort = 7000
tcpmuxHTTPConnectPort = 5002
```

Deploy frpc on intranet machine A

Create an frpc configuration file, for example frpc.toml, and add the following content to the configuration file:

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

Deploy another frpc on intranet machine B

Create an frpc configuration file, for example frpc.toml, and add the following content to the configuration file:

Access Intranet Web Services via Custom Domain Names

Mon, 01 Jan 0001 00:00:00 +0000

HTTP type proxies are very suitable for providing intranet web services to external users through custom domain names. Compared to TCP type proxies, HTTP proxies can not only reuse ports but also provide many features based on the HTTP protocol.

HTTPS is similar to this, but it should be noted that frp’s HTTPS proxy requires the local service to be an HTTPS service, and frps will not perform TLS termination. You can also combine the https2http plugin to expose local HTTP services through the HTTPS protocol.

Forward DNS Query Requests

Mon, 01 Jan 0001 00:00:00 +0000

DNS query requests typically use the UDP protocol, and frp supports penetration of intranet UDP services, with configuration similar to TCP.

Steps

Configure frps.toml

Add the following content to the frps.toml file:
```
bindPort = 7000
```
Configure frpc.toml

Add the following content to the frpc.toml file:
```
serverAddr = "x.x.x.x"
serverPort = 7000

[[proxies]]
name = "dns"
type = "udp"
localIP = "8.8.8.8"
localPort = 53
remotePort = 6000
```
Please note that this example reverse-proxies Google’s DNS query server address, which is only for testing UDP proxy and has no practical significance.

Forward Unix Domain Socket

Mon, 01 Jan 0001 00:00:00 +0000

Steps

Configure frps.toml

Add the following content to the frps.toml file:
```
bindPort = 7000
```

Configure frpc.toml

Add the following content to the frpc.toml file, ensuring the correct Unix domain socket path is set:

serverAddr = "x.x.x.x"
serverPort = 7000

[[proxies]]
name = "unix_domain_socket"
type = "tcp"
remotePort = 6000
[proxies.plugin]
type = "unix_domain_socket"
# Unix domain socket path
unixPath = "/var/run/docker.sock"

Start frps and frpc
Use curl to view Docker version information
```
curl http://x.x.x.x:6000/version
```

Provide Simple File Access Service

Mon, 01 Jan 0001 00:00:00 +0000

By using the static_file plugin, you can easily provide an HTTP-based file access service that allows others to access your specified files.

Steps

Configure frps.toml

Add the following content to the frps.toml file:
```
bindPort = 7000
```

Configure frpc.toml

Add the following content to the frpc.toml file, ensuring appropriate file paths, username, and password are set:

serverAddr = "x.x.x.x"
serverPort = 7000

[[proxies]]
name = "test_static_file"
type = "tcp"
remotePort = 6000
[proxies.plugin]
type = "static_file"
# Local file directory to provide external access
localPath = "/tmp/file"
# Prefix in URL that will be removed, remaining content is the file path to access
stripPrefix = "static"
httpUser = "abc"
httpPassword = "abc"

Please modify localPath, stripPrefix, httpUser, and httpPassword according to your actual situation.

Enable HTTPS for Local HTTP Service

Mon, 01 Jan 0001 00:00:00 +0000

Steps

Configure frps.toml
```
bindPort = 7000
vhostHTTPSPort = 443
```

Configure frpc.toml

serverAddr = "x.x.x.x"
serverPort = 7000

[[proxies]]
name = "test_htts2http"
type = "https"
customDomains = ["test.yourdomain.com"]

[proxies.plugin]
type = "https2http"
localAddr = "127.0.0.1:80"

# HTTPS certificate related configuration
crtPath = "./server.crt"
keyPath = "./server.key"
hostHeaderRewrite = "127.0.0.1"
requestHeaders.set.x-from-where = "frp"

Please note that you need to modify the above configuration according to your domain name and certificate path.

Start frps and frpc
Access HTTPS Service

Open your web browser and visit https://test.yourdomain.com.

By following the above steps, you will be able to enable HTTPS for local HTTP services to achieve secure external access.

Securely Expose Intranet Services

Mon, 01 Jan 0001 00:00:00 +0000

Some intranet services may pose security risks if directly exposed on the public network. Using stcp (secret tcp) type proxies allows you to securely expose intranet services to authorized users, which requires visitors to also deploy frpc clients.

Steps

Configure frps.toml

Add the following content to the frps.toml file:
```
bindPort = 7000
```
Deploy frpc client and configure

Deploy frpc on the machine that needs to expose intranet services to the public network, and create the following configuration:

Point-to-Point Intranet Penetration

Mon, 01 Jan 0001 00:00:00 +0000

frp provides a new proxy type xtcp for intranet penetration when you need to transfer large amounts of data and don’t want traffic to go through the server.

Similar to stcp, using xtcp requires deploying frpc on both ends to establish a direct connection.

Note that xtcp is not suitable for all types of NAT devices. If penetration fails, you can try using stcp proxy.

Steps

Configure frpc.toml file on the machine that needs to be exposed to the external network

Virtual Network (VirtualNet)

Mon, 01 Jan 0001 00:00:00 +0000

Note: VirtualNet is an Alpha-stage feature that is currently unstable. Its configuration methods and functionality may change at any time in future versions. Please do not use this feature in production environments; it is only recommended for testing and evaluation purposes.

Overview

Virtual Network (VirtualNet) functionality is an Alpha feature introduced in frp v0.62.0, which allows frp to create and manage virtual network connections between clients and visitors through TUN interfaces, enabling complete network connectivity between devices.