MirrorSave
/
rathole
mirror of https://github.com/rapiz1/rathole.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update README.md

This commit is contained in:
Yujia Qiao 2021-12-24 22:42:04 +08:00
parent 9ac350d355
commit c8336bd1ee
No known key found for this signature in database
GPG Key ID: DC129173B148701B
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,10 +1,16 @@
# rathole # rathole
![rathole-logo](./docs/img/rathole-logo.png) ![rathole-logo](./docs/img/rathole-logo.png)
A fast and stable reverse proxy for NAT traversal, written in Rust A fast, secure and stable reverse proxy for NAT traversal, written in Rust
rathole, like [frp](https://github.com/fatedier/frp), can help to expose the service on the device behind the NAT to the Internet, via a server with a public IP. rathole, like [frp](https://github.com/fatedier/frp), can help to expose the service on the device behind the NAT to the Internet, via a server with a public IP.
- **High Performance** Much higher throughput can be achieved than frp. See [Benchmark](#Benchmark)
- **Low Resource Consumption** Much less memory is consumed and well managed by Rust.
- **Secure Model** Tokens of services are mandatory and service-wise. The server and clients are responsible for their own configs.
- **Encryption** With the help of the Noise Protocol, encryption can be configured at ease. No need to create a self-signed certificate!
- **Flexibility** While the default profile produces a small binary, it can be customized to be even smaller to fit the constraints of devices, like embedded devices as routers.
## Quickstart ## Quickstart
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. 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.