cyonjan/frp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
- Fixed PayPal spelling in navigation
- Switched code section in TLS to ini format
This commit is contained in:
Asher Oto 2021-01-25 14:53:27 -06:00 committed by GitHub
parent b10ff4cb06
commit 10674cb85a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,3 +1,4 @@
# 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)
* [AliPay](#alipay)
* [Wechat Pay](#wechat-pay)
* [Paypal](#paypal)
* [PayPal](#paypal)
<!-- vim-markdown-toc -->
@ -519,30 +520,30 @@ For port multiplexing, frp sends a first byte `0x17` to dial a TLS connection.
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.**
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):
`
**`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):
`
**`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 regular SSL certificate. It can be self-signed or regular (such as Let's Encrypt or another SSL certificate provider).
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 want to generate the needed certs fast, download and run [Generate-Certs](https://github.com/asheroto/Generate-Certs) and it will generate the certs for you in less than a minute. Supports Windows + Linux.
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 Certificates.
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