@@ -3,8 +3,9 @@
## 配置说明
1.
1. 修改Home Assistant `config/configuration.yaml` 添加：
-
- 修改Home Assistant `config/configuration.yaml` 添加：
``` yaml
http :
@@ -12,4 +13,107 @@ http:
trusted_proxies :
- 127.0 .0 .1
```
修改之后，
修改之后，
- 配置参数解释：
``` yaml
serverAddr : frp.freefrp.net
serverPort : 7000
authToken : freefrp.net
proxies :
- name : "nas_yourdomain_com_http"
type : "http"
localIP : "192.168.1.8"
localPort : 5000
customDomains : "nas.yourdomain.com"
- name : "nas_yourdomain_com_https"
type : "https"
localIP : "192.168.1.8"
localPort : 5001
customDomains : "nas.yourdomain.com"
- name : "yourname_liunx_ssh"
type : "tcp"
localIP : "192.168.1.21"
localPort : 22
remotePort : 22222
- name : "yourname_window10_rdp"
type : "tcp"
localIP : "192.168.1.10"
localPort : 3389
remotePort : 33333
```
#### 此配置是frp客户端中重要的配置文件frpc.toml的一小部分， ，
此配置主要分为两部分，其中第一部分为服务器连接配置，第二部分为所需穿透的各项服务配置，服务配置又分为需要 **Web ** 访问的 **HTTP / HTTPS ** 协议和 **TCP / UDP ** 协议。
---
### 服务器连接配置
服务提供商提供的 frp 服务器信息配置
``` yaml
serverAddr : "frp.freefrp.net" #服务提供商提供的 frp 服务器 IP 地址或者域名地址
serverPort : 7000 #服务提供商提供的 frp 服务端口号
authToken : "freefrp.net" #服务提供商提供的 token 密码
```
---
### HTTP / HTTPS 协议 Web 穿透服务
同一个域名只能穿透一个 HTTP / HTTPS 服务，如需穿透多个 Web，
**例如 ** ：示例中 **nas.yourdomain.com ** 已经分别配置到了群晖 NAS 的 HTTP 和 HTTPS 端口。如果本地还有其他例如博客的 Web 服务器需要穿透，请再分配例如 www.yourdomain.com 或 blog.yourdomain.com 的二级域名来使用。
``` yaml
name : "nas_yourdomain_com_http" #（可选）服务名称： 此处为该条穿透服务的名称，必须修改，且不能与其他用户重复。为保证唯一性，建议以类似示例中 xxx_xxx_com_http 的方式命名。此条记录重复会导致 frp 客户端无法启动， ， ， ， ：
type : "http" #（必选）协议类型： 确保本条穿透服务使用此协议能够在内网正常使用或访问。例如，尝试在本地访问 http://内网IP:内网端口 确保能够正常浏览。
localIP : "192.168.1.8" #（必选）内网 IP：
localPort : 5000 #（必选）本地端口：本地服务的端口号。例如群晖 NAS 的 HTTP 管理端口号为 5000。
customDomains : "nas.yourdomain.com" #（必选）自定义域名：为本条穿透服务提供的域名，请确保在域名服务商后台将该域名的 CNAME 指向了本 frp 服务器地址，也就是上文的 serverAddr 地址，如果 serverAddr 为 IP，
```
**重点提示 ** ：当 **type = "http" ** 或者 * * "https"** 协议时, **custom_domains ** 必须存在。**如果没有此参数会导致 frp 客户端无法启动。**
---
``` yaml
name : "nas_yourdomain_com_https" #（可选）服务名称： 此处为该条穿透服务的名称，必须修改，且不能与其他用户重复。为保证唯一性，建议以类似示例中 xxx_xxx_com_https 的方式命名。此条记录重复会导致 frp 客户端无法启动， ， ， ， ：
type : "https" #（必选）协议类型： 确保本条穿透服务使用此协议能够在内网正常使用或访问。例如，尝试在本地访问 https://内网IP:内网端口 确保能够正常浏览。
localIP : "192.168.1.8" #（必选）内网 IP：
localPort : 5001 #（必选）本地端口：本地服务的端口号。例如群晖 NAS 的 HTTPS 管理端口号为 5001。
customDomains : "nas.yourdomain.com" #（必选）自定义域名：为本条穿透服务提供的域名，请确保在域名服务商后台将该域名的 CNAME 指向了本 frp 服务器地址，也就是上文的 serverAddr 地址，如果 serverAddr 为 IP，
```
**重点提示 ** ：当 **type = "http" ** 或者 * * "https"** 协议时, **custom_domains ** 必须存在。**如果没有此参数会导致 frp 客户端无法启动。**
---
### TCP/UDP
``` yaml
name: yourname_linux_ssh #（可选）服务名称： 此处为该条穿透服务的名称，必须修改，且不能与其他用户重复。为保证唯一性，建议以类似示例中 yourname_linux_ssh 的方式命名。此条记录重复会导致 frp 客户端无法启动， ， ， : frp服务器地址_包含大小写字母和数字的10位随机字符串， ：
type : tcp #（必选）协议类型： 确保本条穿透服务使用此协议能够在内网正常使用或访问。例如，尝试在本地终端执行 ssh root@192.168.1.21 确保能够正常登录。
localIP : 192.168 .1 .21 #（必选）内网 IP：
localPort : 22 #（必选）本地端口：本地服务的端口号。例如，本地 linux 服务器的默认 SSH 登录端口为 22。
remotePort : 22222 #（必选）远程端口：远程服务的端口号。自定义填写一个远程服务端口号，例如 22222， ，
```
**远程端口号（ ） ， ， ， **
**重点提示 ** ：当 **type = "tcp" ** 时，无需配置上文的两条域名记录，可以直接使用 frp 服务器的地址作为域名，也可以将自己的域名 CNAME 或 A 记录 指向 frp 服务器的域名或 IP。
---
``` yaml
name: yourname_windows10_rdp #（可选）服务名称： 此处为该条穿透服务的名称，必须修改，且不能与其他用户重复。为保证唯一性，建议以类似示例中 yourname_windows10_rdp 的方式命名。此条记录重复会导致 frp 客户端无法启动， ， ， : frp服务器地址_包含大小写字母和数字的10位随机字符串， ：
type : tcp #（必选）协议类型：确保本条穿透服务使用此协议能够在内网正常使用或访问。例如，尝试在本地使用 Microsoft Remote Desktop 来远程访问该电脑，确保能够正常登录。
localIP : 192.168 .1 .10 #（必选）内网 IP：
localPort : 3389 #（必选）本地端口：本地服务的端口号。例如，本地 Windows RDP 的默认端口为 3389。
remotePort : 33333 #（必选）远程端口：远程服务的端口号。自定义填写一个远程服务端口号，例如 33333， ，
```
**远程端口号（ ） ， ， ， **
**重点提示 ** ：当 **type = tcp ** 时，无需配置上文的两条域名记录，可以直接使用 frp 服务器的地址作为域名，也可以将自己的域名 CNAME 或 A 记录 指向 frp 服务器的域名或 IP。
waxgourd