Skip to content

Commit

Permalink
GitBook: [#34] No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
@crackair @gitbook-bot
crackair authored and gitbook-bot committed Dec 17, 2021
1 parent 2ecc12c commit 06dcc8a
Showing 1 changed file with 61 additions and 59 deletions.
120 changes: 61 additions & 59 deletions xrayr-pei-zhi-wen-jian-shuo-ming/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ Nodes:
EnableDNS: false # Use custom DNS config, Please ensure that you set the dns.json well
DNSType: AsIs # AsIs, UseIP, UseIPv4, UseIPv6, DNS strategy
DisableUploadTraffic: false # Disable Upload Traffic to the panel
DisableGetRule: false # Disable Get Rule from the panel
DisableGetRule: false # Disable Get Rule from the panel
DisableIVCheck: false # Disable the anti-reply protection for Shadowsocks
EnableProxyProtocol: false # Only works for WebSocket and TCP
EnableFallback: false # Only support for Trojan and Vless
FallBackConfigs: # Support multiple fallbacks
Expand Down Expand Up @@ -120,11 +121,11 @@ Log:
ErrorPath: # ./error.log
```
| 参数 | 选项 | 说明 |
| :--- | :--- | :--- |
| `Level` | `none`,`error`,`warning`,`info`,`debug` | 日志显示级别，`none`为不显示 |
| `AccessPath` | 无 | Access日志的保存路径 |
| `ErrorPath` | 无 | Error日志的保存路径 |
| 参数 | 选项 | 说明 |
| ------------ | --------------------------------------- | ----------------- |
| `Level` | `none`,`error`,`warning`,`info`,`debug` | 日志显示级别，`none`为不显示 |
| `AccessPath` | 无 | Access日志的保存路径 |
| `ErrorPath` | 无 | Error日志的保存路径 |

#### 自定义DNS配置

Expand All @@ -134,9 +135,9 @@ Log:
DnsConfigPath: # ./dns.json Path to dns config
```

| 参数 | 选项 | 说明 |
| :--- | :--- | :--- |
| `DnsConfigPath` | 无 | 自定义DNS配置文件的路径 |
| 参数 | 选项 | 说明 |
| --------------- | -- | ------------- |
| `DnsConfigPath` | 无 | 自定义DNS配置文件的路径 |

#### 自定义路由配置

Expand All @@ -146,9 +147,9 @@ DnsConfigPath: # ./dns.json Path to dns config
RouteConfigPath: # ./route.json # Path to route config, check https://xtls.github.io/config/base/route/ for help
```

| 参数 | 选项 | 说明 |
| :--- | :--- | :--- |
| `RouteConfigPath` | 无 | 自定义路由配置文件的路径 |
| 参数 | 选项 | 说明 |
| ----------------- | -- | ------------ |
| `RouteConfigPath` | 无 | 自定义路由配置文件的路径 |

#### 自定义出口配置

Expand All @@ -158,9 +159,9 @@ RouteConfigPath: # ./route.json # Path to route config, check https://xtls.githu
OutboundConfigPath: # ./custom_outbound.json # Path to custom outbound config, check https://xtls.github.io/config/base/outbound/ for help
```

| 参数 | 选项 | 说明 |
| :--- | :--- | :--- |
| `OutboundConfigPath` | 无 | 自定义出口配置文件的路径 |
| 参数 | 选项 | 说明 |
| -------------------- | -- | ------------ |
| `OutboundConfigPath` | 无 | 自定义出口配置文件的路径 |

#### 连接控制

Expand All @@ -175,13 +176,13 @@ ConnetionConfig:
BufferSize: 64 # The internal cache size of each connection, kB
```

| 参数 | 选项 | 说明 |
| :--- | :--- | :--- |
| `Handshake` | 无 | 连接建立时的握手时间限制。单位为秒。默认值为 4。在入站代理处理一个新连接时，在握手阶段如果使用的时间超过这个时间，则中断该连接。 |
| `ConnIdle` | 无 | 连接空闲的时间限制。单位为秒。默认值为 10。如果在 `ConnIdle` 时间内，没有任何数据被传输（包括上行和下行数据），则中断该连接。**减少该值有可能可以优化内存占用，但是会导致用户连接延时变高**。 |
| `UplinkOnly` | 无 | 当连接下行线路关闭后的时间限制。单位为秒。默认值为 2。当服务器（如远端网站）关闭下行连接时，出站代理会在等待`UplinkOnly`时间后中断连接。 |
| `DownlinkOnly` | 无 | 当连接上行线路关闭后的时间限制。单位为秒。默认值为 4。当服务器（如远端网站）关闭上行连接时，出站代理会在等待`DownlinkOnly`时间后中断连接。 |
| `BufferSize` | 无 | 每个连接的内部缓存大小。单位为 kB。当值为 0 时，内部缓存被禁用。**减少该值有可能可以优化内存占用，但有可能导致CPU占用上升** |
| 参数 | 选项 | 说明 |
| -------------- | -- | -------------------------------------------------------------------------------------------------------- |
| `Handshake` | 无 | 连接建立时的握手时间限制。单位为秒。默认值为 4。在入站代理处理一个新连接时，在握手阶段如果使用的时间超过这个时间，则中断该连接。 |
| `ConnIdle` | 无 | 连接空闲的时间限制。单位为秒。默认值为 10。如果在 `ConnIdle` 时间内，没有任何数据被传输（包括上行和下行数据），则中断该连接。**减少该值有可能可以优化内存占用，但是会导致用户连接延时变高**。 |
| `UplinkOnly` | 无 | 当连接下行线路关闭后的时间限制。单位为秒。默认值为 2。当服务器（如远端网站）关闭下行连接时，出站代理会在等待`UplinkOnly`时间后中断连接。 |
| `DownlinkOnly` | 无 | 当连接上行线路关闭后的时间限制。单位为秒。默认值为 4。当服务器（如远端网站）关闭上行连接时，出站代理会在等待`DownlinkOnly`时间后中断连接。 |
| `BufferSize` | 无 | 每个连接的内部缓存大小。单位为 kB。当值为 0 时，内部缓存被禁用。**减少该值有可能可以优化内存占用，但有可能导致CPU占用上升** |

提示： 1. 减少`ConnIdle`有可能可以优化高连接数量时的内存占用，但是会导致用户连接延时变高。 2. 在 HTTP 浏览的场景中，可以将 `UplinkOnly` 和 `DownlinkOnly` 设为 0，以提高连接关闭的效率，减少内存占用。 3. 减少`BufferSize`可以优化内存占用，但是可能会导致CPU占用上升。

Expand Down Expand Up @@ -265,8 +266,8 @@ Nodes:
PanelType: "V2board" # Panel type: SSpanel, V2board, PMpanel, Proxypanel
```

| 参数 | 选项 | 说明 |
| :--- | :--- | :--- |
| 参数 | 选项 | 说明 |
| ----------- | ------------------------------------------ | -------- |
| `PanelType` | `SSPanel`,`V2board`,`PMpanel`,`Proxypanel` | 对接前端面板类型 |

#### 面板对接配置
Expand All @@ -285,18 +286,18 @@ ApiConfig:
RuleListPath: # ./rulelist Path to local rulelist file
```

| 参数 | 选项 | 说明 |
| :--- | :--- | :--- |
| `ApiHost` | 无 | 对接前端面板地址 |
| `ApiKey` | 无 | 前端对接通讯秘钥 |
| `NodeID` | 无 | 节点ID |
| `NodeType` | `V2ray`,`Shadowsocks`, `Shadowsocks-Plugin`,`Trojan` | 节点类型 |
| `Timeout` | 无 | 设定单次访问API超时时间，默认5秒 |
| `EnableVless` | `true`,`false` | 是否给V2ray启用Vless协议 |
| `EnableXTLS` | `true`,`false` | 是否使用XTLS |
| `SpeedLimit` | float | 单位Mbps, 本地限速设置，会覆盖远程设置，0为不启用 |
| `DeviceLimit` | int | 本地设备限制，会覆盖远程设置，0为不启用 |
| `RuleListPath` | 无 | 本地规则设置，指定本地规则文件路径，规则文件格式 |
| 参数 | 选项 | 说明 |
| -------------- | ---------------------------------------------------- | ---------------------------- |
| `ApiHost` | 无 | 对接前端面板地址 |
| `ApiKey` | 无 | 前端对接通讯秘钥 |
| `NodeID` | 无 | 节点ID |
| `NodeType` | `V2ray`,`Shadowsocks`, `Shadowsocks-Plugin`,`Trojan` | 节点类型 |
| `Timeout` | 无 | 设定单次访问API超时时间，默认5秒 |
| `EnableVless` | `true`,`false` | 是否给V2ray启用Vless协议 |
| `EnableXTLS` | `true`,`false` | 是否使用XTLS |
| `SpeedLimit` | float | 单位Mbps, 本地限速设置，会覆盖远程设置，0为不启用 |
| `DeviceLimit` | int | 本地设备限制，会覆盖远程设置，0为不启用 |
| `RuleListPath` | 无 | 本地规则设置，指定本地规则文件路径，规则文件格式 |

#### 后端相关配置

Expand All @@ -308,7 +309,8 @@ ControllerConfig:
EnableDNS: false # Use custom DNS config, Please ensure that you set the dns.json well
DNSType: AsIs # AsIs, UseIP, UseIPv4, UseIPv6, DNS strategy
DisableUploadTraffic: false # Disable Upload Traffic to the panel
DisableGetRule: false # Disable Get Rule from the panel
DisableGetRule: false # Disable Get Rule from the panel
DisableIVCheck: false # Disable the anti-reply protection for Shadowsocks
EnableProxyProtocol: false # Only works for WebSocket and TCP
EnableFallback: false # Only support for Trojan and Vless
FallBackConfigs: # Support multiple fallbacks
Expand All @@ -319,22 +321,23 @@ ControllerConfig:
ProxyProtocolVer: 0 # Send PROXY protocol version, 0 for dsable
```

| 参数 | 选项 | 说明 |
| :--- | :--- | :--- |
| `ListenIP` | 无 | 选择监听的IP地址，`0.0.0.0`会同时监听v6和v4 |
| `SendIP` | 无 | 用于发送数据的 IP 地址 |
| `UpdatePeriodic` | 无 | 从前端更新节点、用户信息和上报用户使用信息的间隔，默认60秒 |
| `EnableDNS` | `true`,`false` | 是否为当前节点启用自定义DNS，默认使用系统DNS |
| `DNSType` | `AsIs`,`UseIP`,`UseIPv4`,`UseIPv6` | DNS解析类型，`AsIs`：使用系统DNS，`UseIP`,`UseIPv4`,`UseIPv6`为使用自定义DNS，请确保`EnableDNS`为`true`，且正确配置了`DnsConfigPath` |
| `DisableUploadTraffic` | `false`, `true` | 是否禁止上传节点流量，默认`false` |
| `DisableGetRule` | `false`, `true` | 是否禁止获取远程规则，默认`false` |
| `EnableProxyProtocol` | `true`,`false` | 是否为当前节点启用ProxyProtocol获取中转IP，只对TCP和WS有效 |
| `EnableFallback` | `true`,`false` | 是否为当前节点启用Fallback，只对Vless和Trojan协议有效 |
| `FallBackConfigs` | list | Fallback 相关配置，请查看 [Fallback功能说明](../gong-neng-shuo-ming/fallback.md) |
| 参数 | 选项 | 说明 |
| ---------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `ListenIP` | 无 | 选择监听的IP地址，`0.0.0.0`会同时监听v6和v4 |
| `SendIP` | 无 | 用于发送数据的 IP 地址 |
| `UpdatePeriodic` | 无 | 从前端更新节点、用户信息和上报用户使用信息的间隔，默认60秒 |
| `EnableDNS` | `true`,`false` | 是否为当前节点启用自定义DNS，默认使用系统DNS |
| `DNSType` | `AsIs`,`UseIP`,`UseIPv4`,`UseIPv6` | DNS解析类型，`AsIs`：使用系统DNS，`UseIP`,`UseIPv4`,`UseIPv6`为使用自定义DNS，请确保`EnableDNS`为`true`，且正确配置了`DnsConfigPath` |
| `DisableUploadTraffic` | `false`, `true` | 是否禁止上传节点流量，默认`false` |
| `DisableGetRule` | `false`, `true` | 是否禁止获取远程规则，默认`false` |
| `DisableIVCheck` | `false`, `true` | 是否关闭Shadowsocks用于防止重放攻击的布隆过滤器 |
| `EnableProxyProtocol` | `true`,`false` | 是否为当前节点启用ProxyProtocol获取中转IP，只对TCP和WS有效 |
| `EnableFallback` | `true`,`false` | 是否为当前节点启用Fallback，只对Vless和Trojan协议有效 |
| `FallBackConfigs` | list | Fallback 相关配置，请查看 [Fallback功能说明](../gong-neng-shuo-ming/fallback.md) |

#### 证书申请相关配置

XrayR 支持多种自动申请证书配置。申请到的证书将会放在**配置文件\(config.yml\)目录的`cert`文件夹下**。
XrayR 支持多种自动申请证书配置。申请到的证书将会放在**配置文件(config.yml)目录的`cert`文件夹下**。

```yaml
CertConfig:
Expand All @@ -349,12 +352,11 @@ CertConfig:
ALICLOUD_SECRET_KEY: bbb
```

| 参数 | 选项 | 说明 |
| :--- | :--- | :--- |
| `CertMode` | `none`,`file`,`http`,`dns` | 获取证书的方式。`file`:手动提供，并制定路径。`http`：通过http申请，需要80端口。`dns`：使用dns模式申请，需要制定相关dns服务商配置。`none`：强制关闭tls设置，交由nginx或者caddy处理。 |
| `CertDomain` | 无 | 申请证书域名 |
| `CertFile` | 无 | 手动指定的证书路径 |
| `KeyFile` | 无 | 手动指定的私钥路径 |
| `Provider` | 无 | dns提供商，所有支持的dns提供商请在此获取：[https://go-acme.github.io/lego/dns/](https://go-acme.github.io/lego/dns/) |
| `DNSEnv` | 无 | 采用DNS申请证书需要的环境变量，请参考上文链接内，自己的dns提供商所需要的参数，填写于此。请注意一行一个，填写时需符合yaml文件格式。 |

| 参数 | 选项 | 说明 |
| ------------ | -------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `CertMode` | `none`,`file`,`http`,`dns` | 获取证书的方式。`file`:手动提供，并制定路径。`http`：通过http申请，需要80端口。`dns`：使用dns模式申请，需要制定相关dns服务商配置。`none`：强制关闭tls设置，交由nginx或者caddy处理。 |
| `CertDomain` | 无 | 申请证书域名 |
| `CertFile` | 无 | 手动指定的证书路径 |
| `KeyFile` | 无 | 手动指定的私钥路径 |
| `Provider` | 无 | dns提供商，所有支持的dns提供商请在此获取：[https://go-acme.github.io/lego/dns/](https://go-acme.github.io/lego/dns/) |
| `DNSEnv` | 无 | 采用DNS申请证书需要的环境变量，请参考上文链接内，自己的dns提供商所需要的参数，填写于此。请注意一行一个，填写时需符合yaml文件格式。 |

0 comments on commit 06dcc8a

Please sign in to comment.