SakuraFrp/README.md

43 lines
1.4 KiB
Markdown
Raw Normal View History

2015-12-21 15:25:54 +00:00
# frp
[![Build Status](https://travis-ci.org/fatedier/frp.svg)](https://travis-ci.org/fatedier/frp)
2016-04-06 03:43:50 +00:00
[README](README.md) | [中文文档](README_zh.md)
2016-03-14 07:26:26 +00:00
## What is frp?
2016-03-17 03:04:40 +00: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 07:26:26 +00:00
## Status
2016-04-06 03:43:50 +00: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 07:26:26 +00:00
## Quick Start
2016-03-14 07:27:54 +00:00
Read the [QuickStart](doc/quick_start_en.md) | [使用文档](doc/quick_start_zh.md)
2016-03-14 07:26:26 +00:00
## Architecture
![architecture](doc/pic/architecture.png)
## What can I do with frp?
2016-04-18 07:47:14 +00:00
* Expose any http service behind a NAT or firewall to the internet by a server with public IP address(Name-based Virtual Host Support).
2016-03-14 07:26:26 +00:00
* 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 08:18:29 +00:00
## Contributing
Interested in getting involved? We would love to help you!
2016-04-06 03:51:12 +00: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 03:43:50 +00:00
## Contributors
* [fatedier](https://github.com/fatedier)
* [Hurricanezwf](https://github.com/Hurricanezwf)
* [vashstorm](https://github.com/vashstorm)