{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/469", "result": {"data":{"issuesJson":{"id":"f4202156-f84b-519e-9d9d-60987c867ff9","title":"rapiz1/rathole: 安全、稳定、高性能的内网穿透工具，用 Rust 语言编写，类似frp","number":469,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposrapiz1/rathole
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

rathole

\n

\"rathole-logo\"

\n

\"GitHub
\n\"GitHub
\n\"GitHub
\n\"GitHub
\n\"Docker
\n\"Join

\n

English | 简体中文

\n

A secure, stable and high-performance reverse proxy for NAT traversal, written in Rust

\n

rathole, like frp and ngrok, can help to expose the service on the device behind the NAT to the Internet, via a server with a public IP.

\n\n\n\n

Features

\n\n

Quickstart

\n

A full-powered rathole can be obtained from the release page. Or build from source for other platforms and minimizing the binary. A Docker image is also available.

\n

The usage of rathole is very similar to frp. If you have experience with the latter, then the configuration is very easy for you. The only difference is that configuration of a service is split into the client side and the server side, and a token is mandatory.

\n

To use rathole, you need a server with a public IP, and a device behind the NAT, where some services that need to be exposed to the Internet.

\n

Assuming you have a NAS at home behind the NAT, and want to expose its ssh service to the Internet:

\n
    \n
  1. On the server which has a public IP
    2. \n
\n

Create server.toml with the following content and accommodate it to your needs.

\n
# server.toml\n[server]\nbind_addr = \"0.0.0.0:2333\" # `2333` specifies the port that rathole listens for clients\n\n[server.services.my_nas_ssh]\ntoken = \"use_a_secret_that_only_you_know\" # Token that is used to authenticate the client for the service. Change to an arbitrary value.\nbind_addr = \"0.0.0.0:5202\" # `5202` specifies the port that exposes `my_nas_ssh` to the Internet
\n

Then run:

\n
./rathole server.toml
\n
    \n
  1. On the host which is behind the NAT (your NAS)
    2. \n
\n

Create client.toml with the following content and accommodate it to your needs.

\n
# client.toml\n[client]\nremote_addr = \"myserver.com:2333\" # The address of the server. The port must be the same with the port in `server.bind_addr`\n\n[client.services.my_nas_ssh]\ntoken = \"use_a_secret_that_only_you_know\" # Must be the same with the server to pass the validation\nlocal_addr = \"127.0.0.1:22\" # The address of the service that needs to be forwarded
\n

Then run:

\n
./rathole client.toml
\n
    \n
  1. Now the client will try to connect to the server myserver.com on port 2333, and any traffic to myserver.com:5202 will be forwarded to the client's port 22.
    2. \n
\n

So you can ssh myserver.com:5202 to ssh to your NAS.

\n

To run rathole run as a background service on Linux, checkout the systemd examples.

\n

Configuration

\n

rathole can automatically determine to run in the server mode or the client mode, according to the content of the configuration file, if only one of [server] and [client] block is present, like the example in Quickstart.

\n

But the [client] and [server] block can also be put in one file. Then on the server side, run rathole --server config.toml and on the client side, run rathole --client config.toml to explicitly tell rathole the running mode.

\n

Before heading to the full configuration specification, it's recommend to skim the configuration examples to get a feeling of the configuration format.

\n

See Transport for more details about encryption and the transport block.

\n

Here is the full configuration specification:

\n
[client]\nremote_addr = \"example.com:2333\" # Necessary. The address of the server\ndefault_token = \"default_token_if_not_specify\" # Optional. The default token of services, if they don't define their own ones\nheartbeat_timeout = 40 # Optional. Set to 0 to disable the application-layer heartbeat test. The value must be greater than `server.heartbeat_interval`. Default: 40 seconds\nretry_interval = 1 # Optional. The interval between retry to connect to the server. Default: 1 second\n\n[client.transport] # The whole block is optional. Specify which transport to use\ntype = \"tcp\" # Optional. Possible values: [\"tcp\", \"tls\", \"noise\"]. Default: \"tcp\"\n\n[client.transport.tcp] # Optional. Also affects `noise` and `tls`\nproxy = \"socks5://user:passwd@127.0.0.1:1080\" # Optional. The proxy used to connect to the server. `http` and `socks5` is supported.\nnodelay = true # Optional. Determine whether to enable TCP_NODELAY, if applicable, to improve the latency but decrease the bandwidth. Default: true\nkeepalive_secs = 20 # Optional. Specify `tcp_keepalive_time` in `tcp(7)`, if applicable. Default: 20 seconds\nkeepalive_interval = 8 # Optional. Specify `tcp_keepalive_intvl` in `tcp(7)`, if applicable. Default: 8 seconds\n\n[client.transport.tls] # Necessary if `type` is \"tls\"\ntrusted_root = \"ca.pem\" # Necessary. The certificate of CA that signed the server's certificate\nhostname = \"example.com\" # Optional. The hostname that the client uses to validate the certificate. If not set, fallback to `client.remote_addr`\n\n[client.transport.noise] # Noise protocol. See `docs/transport.md` for further explanation\npattern = \"Noise_NK_25519_ChaChaPoly_BLAKE2s\" # Optional. Default value as shown\nlocal_private_key = \"key_encoded_in_base64\" # Optional\nremote_public_key = \"key_encoded_in_base64\" # Optional\n\n[client.transport.websocket] # Necessary if `type` is \"websocket\"\ntls = true # If `true` then it will use settings in `client.transport.tls`\n\n[client.services.service1] # A service that needs forwarding. The name `service1` can change arbitrarily, as long as identical to the name in the server's configuration\ntype = \"tcp\" # Optional. The protocol that needs forwarding. Possible values: [\"tcp\", \"udp\"]. Default: \"tcp\"\ntoken = \"whatever\" # Necessary if `client.default_token` not set\nlocal_addr = \"127.0.0.1:1081\" # Necessary. The address of the service that needs to be forwarded\nnodelay = true # Optional. Override the `client.transport.nodelay` per service\nretry_interval = 1 # Optional. The interval between retry to connect to the server. Default: inherits the global config\n\n[client.services.service2] # Multiple services can be defined\nlocal_addr = \"127.0.0.1:1082\"\n\n[server]\nbind_addr = \"0.0.0.0:2333\" # Necessary. The address that the server listens for clients. Generally only the port needs to be change.\ndefault_token = \"default_token_if_not_specify\" # Optional\nheartbeat_interval = 30 # Optional. The interval between two application-layer heartbeat. Set to 0 to disable sending heartbeat. Default: 30 seconds\n\n[server.transport] # Same as `[client.transport]`\ntype = \"tcp\"\n\n[server.transport.tcp] # Same as the client\nnodelay = true\nkeepalive_secs = 20\nkeepalive_interval = 8\n\n[server.transport.tls] # Necessary if `type` is \"tls\"\npkcs12 = \"identify.pfx\" # Necessary. pkcs12 file of server's certificate and private key\npkcs12_password = \"password\" # Necessary. Password of the pkcs12 file\n\n[server.transport.noise] # Same as `[client.transport.noise]`\npattern = \"Noise_NK_25519_ChaChaPoly_BLAKE2s\"\nlocal_private_key = \"key_encoded_in_base64\"\nremote_public_key = \"key_encoded_in_base64\"\n\n[server.transport.websocket] # Necessary if `type` is \"websocket\"\ntls = true # If `true` then it will use settings in `server.transport.tls`\n\n[server.services.service1] # The service name must be identical to the client side\ntype = \"tcp\" # Optional. Same as the client `[client.services.X.type]\ntoken = \"whatever\" # Necessary if `server.default_token` not set\nbind_addr = \"0.0.0.0:8081\" # Necessary. The address of the service is exposed at. Generally only the port needs to be change.\nnodelay = true # Optional. Same as the client\n\n[server.services.service2]\nbind_addr = \"0.0.0.1:8082\"
\n

Logging

\n

rathole, like many other Rust programs, use environment variables to control the logging level. info, warn, error, debug, trace are available.

\n
RUST_LOG=error ./rathole config.toml
\n

will run rathole with only error level logging.

\n

If RUST_LOG is not present, the default logging level is info.

\n

Tuning

\n

From v0.4.7, rathole enables TCP_NODELAY by default, which should benefit the latency and interactive applications like rdp, Minecraft servers. However, it slightly decreases the bandwidth.

\n

If the bandwidth is more important, TCP_NODELAY can be opted out with nodelay = false.

\n

Benchmark

\n

rathole has similar latency to frp, but can handle a more connections, provide larger bandwidth, with less memory usage.

\n

For more details, see the separate page Benchmark.

\n

However, don't take it from here that rathole can magically make your forwarded service faster several times than before. The benchmark is done on local loopback, indicating the performance when the task is cpu-bounded. One can gain quite a improvement if the network is not the bottleneck. Unfortunately, that's not true for many users. In that case, the main benefit is lower resource consumption, while the bandwidth and the latency may not improved significantly.

\n

\"http_throughput\"
\n\"tcp_bitrate\"
\n\"udp_bitrate\"
\n\"mem\"

\n

Planning

\n\n

Out of Scope lists features that are not planned to be implemented and why.

","updatedAt":"2025-05-21T16:17:58Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"内网穿透","color":"4b9909"}},{"node":{"name":"rapiz1","color":"5d0e13"}}]},"comments":{"edges":[]}}},"pageContext":{"number":469,"previous":{"title":"rancher/rancher: 一个开源容器管理平台，专为在生产中部署容器的组织而构建。Rancher 让您可以轻松地在任何地方运行 Kubernetes、满足 IT 要求并为 DevOps 团队提供支持","number":468},"next":{"title":"rdiff-backup/rdiff-backup: rdiff-backup 是一个简单的备份工具，可以在本地和远程、Linux 和 Windows 上使用，甚至可以在两者之间跨平台使用。","number":470}}}, "staticQueryHashes": ["151096407","2861350382"]}