frp/README.md

47 lines
1.6 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-04-06 11:43:50 +08:00
[README](README.md) | [中文文档](README_zh.md)
2016-03-14 15:26:26 +08:00
## What is frp?
2016-03-17 11:04:40 +08:00
frp is a fast reverse proxy to help you expose a local server behind a NAT or firewall to the internet.
2016-03-14 15:26:26 +08:00
2016-04-19 18:53:48 +08:00
## 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).
2016-03-14 15:26:26 +08:00
## Status
2016-04-06 11:43:50 +08:00
frp is under development and you can try it with latest release version.Master branch for releasing stable version when dev branch for developing.
**We may change any protocol and can't promise backward compatible before version 1.x.**
2016-03-14 15:26:26 +08:00
## Quick Start
2016-04-19 19:02:13 +08:00
Read the [QuickStart](/doc/quick_start_en.md)
2016-03-14 15:26:26 +08:00
2016-04-19 19:02:13 +08:00
[Tcp port forwarding](/doc/quick_start_en.md#tcp-port-forwarding)
2016-03-14 15:26:26 +08:00
2016-04-19 19:02:13 +08:00
[Http port forwarding and Custom domain binding](/doc/quick_start_en.md#http-port-forwarding-and-custom-domains-binding)
2016-03-14 15:26:26 +08:00
2016-04-19 18:53:48 +08:00
## Architecture
2016-03-14 15:26:26 +08:00
2016-04-19 19:02:13 +08:00
![architecture](/doc/pic/architecture.png)
2016-03-14 16:18:29 +08:00
## Contributing
Interested in getting involved? We would love to help you!
2016-04-06 11:51:12 +08:00
* Take a look at our [issues list](https://github.com/fatedier/frp/issues) and consider submitting a patch
* If you have some wanderful ideas, send email to fatedier@gmail.com.
2016-04-06 11:43:50 +08:00
## Contributors
* [fatedier](https://github.com/fatedier)
* [Hurricanezwf](https://github.com/Hurricanezwf)
* [vashstorm](https://github.com/vashstorm)