mirror/frp
1
0
Fork 0
mirror of https://github.com/fatedier/frp.git synced 2024-11-24 02:59:19 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README (#2221)

Browse Source 
* Updated README.md

- Fixed spelling of PayPal
- Added information to TLS section, fixed spelling
This commit is contained in:
Asher Oto 2021-01-26 23:07:44 -06:00 committed by GitHub
parent 3621aad1c1
commit fa89671452
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,3 +1,4 @@
# frp # frp
[![Build Status](https://circleci.com/gh/fatedier/frp.svg?style=shield)](https://circleci.com/gh/fatedier/frp) [![Build Status](https://circleci.com/gh/fatedier/frp.svg?style=shield)](https://circleci.com/gh/fatedier/frp)
@ -67,7 +68,7 @@ frp also has a P2P connect mode.
* [Donation](#donation) * [Donation](#donation)
* [AliPay](#alipay) * [AliPay](#alipay)
* [Wechat Pay](#wechat-pay) * [Wechat Pay](#wechat-pay)
* [Paypal](#paypal) * [PayPal](#paypal)
<!-- vim-markdown-toc --> <!-- vim-markdown-toc -->
@ -515,11 +516,32 @@ use_compression = true
frp supports the TLS protocol between `frpc` and `frps` since v0.25.0. frp supports the TLS protocol between `frpc` and `frps` since v0.25.0.
Config `tls_enable = true` in the `[common]` section to `frpc.ini` to enable this feature.
For port multiplexing, frp sends a first byte `0x17` to dial a TLS connection. For port multiplexing, frp sends a first byte `0x17` to dial a TLS connection.
To enforce `frps` to only accept TLS connections - configure `tls_only = true` in the `[common]` section in `frps.ini`. Configure `tls_enable = true` in the `[common]` section to `frpc.ini` to enable this feature.
To **enforce** `frps` to only accept TLS connections - configure `tls_only = true` in the `[common]` section in `frps.ini`. **This is optional.**
**`frpc` TLS settings (under the `[common]` section):**
```ini
tls_enable = true
tls_cert_file = certificate.crt
tls_key_file = certificate.key
tls_trusted_ca_file = ca.crt
```
**`frps` TLS settings (under the `[common]` section):**
```ini
tls_only = true
tls_enable = true
tls_cert_file = certificate.crt
tls_key_file = certificate.key
tls_trusted_ca_file = ca.crt
```
You will need **a root CA cert** and **at least one SSL/TLS certificate**. It **can** be self-signed or regular (such as Let's Encrypt or another SSL/TLS certificate provider).
If you using `frp` via IP address and not hostname, make sure to set the appropriate IP address in the Subject Alternative Name (SAN) area when generating SSL/TLS Certificates.
### Hot-Reloading frpc configuration ### Hot-Reloading frpc configuration
@ -967,6 +989,6 @@ frp QQ group: 606194980
![donation-wechatpay](/doc/pic/donate-wechatpay.png) ![donation-wechatpay](/doc/pic/donate-wechatpay.png)
### Paypal ### PayPal
Donate money by [paypal](https://www.paypal.me/fatedier) to my account **fatedier@gmail.com**. Donate money by [PayPal](https://www.paypal.me/fatedier) to my account **fatedier@gmail.com**.