frp/README_zh.md

81 lines
3.8 KiB
Markdown
Raw Normal View History

2016-04-06 11:43:50 +08:00
# frp
2017-05-19 02:59:51 +08:00
[![Build Status](https://travis-ci.org/fatedier/frp.svg?branch=master)](https://travis-ci.org/fatedier/frp)
2020-05-24 14:05:31 +08:00
[![GitHub release](https://img.shields.io/github/tag/fatedier/frp.svg?label=release)](https://github.com/fatedier/frp/releases)
2016-04-06 11:43:50 +08:00
[README](README.md) | [中文文档](README_zh.md)
2020-05-24 14:05:31 +08:00
frp 是一个专注于内网穿透的高性能的反向代理应用,支持 TCP、UDP、HTTP、HTTPS 等多种协议。可以将内网服务以安全、便捷的方式通过具有公网 IP 节点的中转暴露到公网。
2016-07-07 18:07:45 +08:00
2022-01-28 15:29:43 +08:00
<h3 align="center">Gold Sponsors</h3>
<!--gold sponsors start-->
<p align="center">
<a href="https://workos.com/?utm_campaign=github_repo&utm_medium=referral&utm_content=frp&utm_source=github" target="_blank">
2023-02-23 13:22:05 +08:00
<img width="350px" src="https://raw.githubusercontent.com/fatedier/frp/dev/doc/pic/sponsor_workos.png">
</a>
2022-01-28 15:29:43 +08:00
</p>
<!--gold sponsors end-->
2020-05-24 14:05:31 +08:00
## 为什么使用 frp
2016-07-07 18:07:45 +08:00
2020-05-24 14:05:31 +08:00
通过在具有公网 IP 的节点上部署 frp 服务端,可以轻松地将内网服务穿透到公网,同时提供诸多专业的功能特性,这包括:
2017-12-05 01:34:33 +08:00
2020-05-24 14:05:31 +08:00
* 客户端服务端通信支持 TCP、KCP 以及 Websocket 等多种协议。
* 采用 TCP 连接流式复用,在单个连接间承载更多请求,节省连接建立时间。
* 代理组间的负载均衡。
* 端口复用,多个服务通过同一个服务端端口暴露。
* 多个原生支持的客户端插件静态文件查看HTTP、SOCK5 代理等),便于独立使用 frp 客户端完成某些工作。
* 高度扩展性的服务端插件系统,方便结合自身需求进行功能扩展。
* 服务端和客户端 UI 页面。
2016-12-21 01:18:12 +08:00
2016-04-06 11:43:50 +08:00
## 开发状态
2020-05-24 14:05:31 +08:00
frp 目前已被很多公司广泛用于测试、生产环境。
2016-04-06 11:43:50 +08:00
2017-05-18 01:51:32 +08:00
master 分支用于发布稳定版本dev 分支用于开发,您可以尝试下载最新的 release 版本进行测试。
2021-11-09 14:18:40 +08:00
我们正在进行 v2 大版本的开发,将会尝试在各个方面进行重构和升级,且不会与 v1 版本进行兼容,预计会持续一段时间。
现在的 v0 版本将会在合适的时间切换为 v1 版本并且保证兼容性,后续只做 bug 修复和优化,不再进行大的功能性更新。
2020-05-24 14:05:31 +08:00
## 文档
2016-07-07 18:07:45 +08:00
2020-05-24 14:05:31 +08:00
完整文档已经迁移至 [https://gofrp.org](https://gofrp.org/docs)。
2016-04-06 11:43:50 +08:00
2016-08-21 00:52:15 +08:00
## 为 frp 做贡献
2016-04-06 11:43:50 +08:00
2016-08-21 00:52:15 +08:00
frp 是一个免费且开源的项目,我们欢迎任何人为其开发和进步贡献力量。
2016-04-06 11:43:50 +08:00
2016-08-21 00:52:15 +08:00
* 在使用过程中出现任何问题,可以通过 [issues](https://github.com/fatedier/frp/issues) 来反馈。
* Bug 的修复可以直接提交 Pull Request 到 dev 分支。
* 如果是增加新的功能特性,请先创建一个 issue 并做简单描述以及大致的实现方法,提议被采纳后,就可以创建一个实现新特性的 Pull Request。
* 欢迎对说明文档做出改善,帮助更多的人使用 frp特别是英文文档。
2016-08-16 14:09:29 +08:00
* 贡献代码请提交 PR 至 dev 分支master 分支仅用于发布稳定可用版本。
2020-05-24 14:05:31 +08:00
* 如果你有任何其他方面的问题或合作,欢迎发送邮件至 fatedier@gmail.com 。
2016-04-06 11:43:50 +08:00
2016-06-03 18:15:01 +08:00
**提醒:和项目相关的问题最好在 [issues](https://github.com/fatedier/frp/issues) 中反馈,这样方便其他有类似问题的人可以快速查找解决方法,并且也避免了我们重复回答一些问题。**
2016-08-24 13:36:38 +08:00
## 捐助
如果您觉得 frp 对你有帮助,欢迎给予我们一定的捐助来维持项目的长期发展。
2022-01-26 20:56:00 +08:00
### GitHub Sponsors
您可以通过 [GitHub Sponsors](https://github.com/sponsors/fatedier) 赞助我们。
企业赞助者可以将贵公司的 Logo 以及链接放置在项目 README 文件中。
2019-01-15 15:15:02 +08:00
### 知识星球
2020-05-24 14:05:31 +08:00
如果您想学习 frp 相关的知识和技术,或者寻求任何帮助及咨询,都可以通过微信扫描下方的二维码付费加入知识星球的官方社群:
2019-01-15 15:15:02 +08:00
![zsxq](/doc/pic/zsxq.jpg)
2016-08-24 13:36:38 +08:00
### 支付宝扫码捐赠
![donate-alipay](/doc/pic/donate-alipay.png)
2017-06-12 01:31:33 +08:00
### 微信支付捐赠
![donate-wechatpay](/doc/pic/donate-wechatpay.png)