frp/README.md

34 lines
1.1 KiB
Markdown
Raw Normal View History

2015-12-21 23:25:54 +08:00
# frp
[![Build Status](https://travis-ci.org/fatedier/frp.svg)](https://travis-ci.org/fatedier/frp)
2016-03-14 15:26:26 +08:00
## What is frp?
frp is a fast reverse proxy which can help you expose a local server behind a NAT or firewall to the internet.
## Status
2016-03-17 10:49:38 +08:00
frp is under development and you can try it with available version 0.2.0.
2016-03-14 15:26:26 +08:00
## Quick Start
2016-03-14 15:27:54 +08:00
Read the [QuickStart](doc/quick_start_en.md) | [使用文档](doc/quick_start_zh.md)
2016-03-14 15:26:26 +08:00
## 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.
* 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).
2016-03-14 16:18:29 +08:00
## Contributing
Interested in getting involved? We would love to help you!
For simple bug fixes, just submit a PR with the fix and we can discuss the fix directly in the PR. If the fix is more complex, start with an issue.
If you have some wanderful ideas, send email to fatedier@gmail.com.