XiaoMo/frp
1
0
Fork 0
mirror of https://github.com/fatedier/frp.git synced 2025-08-01 19:49:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: update

Browse Source
This commit is contained in:
fatedier
2016-04-19 18:53:48 +08:00
parent 14ba38a1b4
commit deb750652f
4 changed files with 175 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -8,6 +8,12 @@
frp is a fast reverse proxy to help you expose a local server behind a NAT or firewall to the internet.
## What can I do with frp?
* Expose any http service behind a NAT or firewall to the internet by a server with public IP address(Name-based Virtual Host Support).
* Expose any tcp service behind a NAT or firewall to the internet by a server with public IP address.
* Inspect all http requests/responses that are transmitted over the tunnel(future).
## Status
frp is under development and you can try it with latest release version.Master branch for releasing stable version when dev branch for developing.
@@ -18,16 +24,14 @@ frp is under development and you can try it with latest release version.Master b
Read the [QuickStart](doc/quick_start_en.md) | [使用文档](doc/quick_start_zh.md)
[Tcp port forwarding](doc/quick_start_en.md#Tcp-port-forwarding)
[Http port forwarding and Custom domain binding](doc/quick_start_en.md#Http-port-forwarding-and-Custom-domains-binding)
## Architecture
![architecture](doc/pic/architecture.png)
## What can I do with frp?
* Expose any http service behind a NAT or firewall to the internet by a server with public IP address(Name-based Virtual Host Support).
* Expose any tcp service behind a NAT or firewall to the internet by a server with public IP address.
* Inspect all http requests/responses that are transmitted over the tunnel(future).
## Contributing
Interested in getting involved? We would love to help you!