mirrors/XTLS_REALITY
0
0
Fork 0
mirror of https://github.com/XTLS/REALITY.git synced 2025-08-24 07:28:36 +00:00
Code

readme

Browse Source
This commit is contained in:
Meo597 2025-06-08 19:39:26 +08:00
parent fda134e780
commit b1225047c7
2 changed files with 150 additions and 187 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.en.md
View File

@ -11,10 +11,9 @@ TODO List: TODO
[中文](README.md) | English [中文](README.md) | English
```jsonc ```json5
{ {
"inbounds": [ "inbounds": [ // Server Inbound Configuration
// Server Inbound Configuration
{ {
"listen": "0.0.0.0", "listen": "0.0.0.0",
"port": 443, "port": 443,
@ -35,8 +34,7 @@ TODO List: TODO
"show": false, // Optional, if true, output debugging information "show": false, // Optional, if true, output debugging information
"dest": "example.com:443", // Required, the format is the same as the dest of VLESS fallbacks "dest": "example.com:443", // Required, the format is the same as the dest of VLESS fallbacks
"xver": 0, // Optional, the format is the same as xver of VLESS fallbacks "xver": 0, // Optional, the format is the same as xver of VLESS fallbacks
"serverNames": [ "serverNames": [ // Required, the acceptable serverName list, does not support * wildcards for now
// Required, the acceptable serverName list, does not support * wildcards for now
"example.com", "example.com",
"www.example.com" "www.example.com"
], ],
@ -44,26 +42,10 @@ TODO List: TODO
"minClientVer": "", // Optional, minimum client Xray version, format is x.y.z "minClientVer": "", // Optional, minimum client Xray version, format is x.y.z
"maxClientVer": "", // Optional, the highest version of client Xray, the format is x.y.z "maxClientVer": "", // Optional, the highest version of client Xray, the format is x.y.z
"maxTimeDiff": 0, // Optional, the maximum time difference allowed, in milliseconds "maxTimeDiff": 0, // Optional, the maximum time difference allowed, in milliseconds
"shortIds": [ "shortIds": [ // Required, the acceptable shortId list, which can be used to distinguish different clients
// Required, the acceptable shortId list, which can be used to distinguish different clients
"", // If there is this item, the client shortId can be empty "", // If there is this item, the client shortId can be empty
"0123456789abcdef" // 0 to f, the length is a multiple of 2, the maximum length is 16 "0123456789abcdef" // 0 to f, the length is a multiple of 2, the maximum length is 16
], ]
// The two limit below are optional for rate limiting falling REALITY connections. Default are 0 means disabled
// WARNING: Enabling rate limiting may create detectable patterns for Great-Firewall!
// If you're a GUI/panel/one-click script developer, RANDOMIZE these parameters!
"limitFallbackUpload": {
// Limit upload for falling REALITY connections
"afterBytes": 0, // Start throttling after (bytes)
"bytesPerSec": 0, // Base speed (bytes/s)
"burstBytesPerSec": 0 // Burst capacity (bytes)
},
"limitFallbackDownload": {
// Limit download for falling REALITY connections
"afterBytes": 0, // Start throttling after (bytes)
"bytesPerSec": 0, // Base speed (bytes/s)
"burstBytesPerSec": 0 // Burst capacity (bytes)
}
} }
} }
} }
@ -81,10 +63,9 @@ Configuration bonus items: **Block the proxy traffic back to China, TCP/80, UDP/
**REALITY can also be used with proxy protocols other than XTLS**, but this is not recommended due to their obvious and already targeted TLS in TLS characteristics **REALITY can also be used with proxy protocols other than XTLS**, but this is not recommended due to their obvious and already targeted TLS in TLS characteristics
The next main goal of REALITY is "**pre-built mode**", that is, to collect and build the characteristics of the target website in advance, and the next main goal of XTLS is **0-RTT** The next main goal of REALITY is "**pre-built mode**", that is, to collect and build the characteristics of the target website in advance, and the next main goal of XTLS is **0-RTT**
```jsonc ```json5
{ {
"outbounds": [ "outbounds": [ // Client outbound configuration
// Client outbound configuration
{ {
"protocol": "vless", "protocol": "vless",
"settings": { "settings": {

32
README.md
View File

@ -11,10 +11,9 @@ TODO List: TODO
中文 | [English](README.en.md) 中文 | [English](README.en.md)
```jsonc ```json5
{ {
"inbounds": [ "inbounds": [ // 服务端入站配置
// 服务端入站配置
{ {
"listen": "0.0.0.0", "listen": "0.0.0.0",
"port": 443, "port": 443,
@ -35,8 +34,7 @@ TODO List: TODO
"show": false, // 选填，若为 true，输出调试信息 "show": false, // 选填，若为 true，输出调试信息
"dest": "example.com:443", // 必填，格式同 VLESS fallbacks 的 dest "dest": "example.com:443", // 必填，格式同 VLESS fallbacks 的 dest
"xver": 0, // 选填，格式同 VLESS fallbacks 的 xver "xver": 0, // 选填，格式同 VLESS fallbacks 的 xver
"serverNames": [ "serverNames": [ // 必填，客户端可用的 serverName 列表，暂不支持 * 通配符
// 必填，客户端可用的 serverName 列表，暂不支持 * 通配符
"example.com", "example.com",
"www.example.com" "www.example.com"
], ],
@ -44,25 +42,10 @@ TODO List: TODO
"minClientVer": "", // 选填，客户端 Xray 最低版本，格式为 x.y.z "minClientVer": "", // 选填，客户端 Xray 最低版本，格式为 x.y.z
"maxClientVer": "", // 选填，客户端 Xray 最高版本，格式为 x.y.z "maxClientVer": "", // 选填，客户端 Xray 最高版本，格式为 x.y.z
"maxTimeDiff": 0, // 选填，允许的最大时间差，单位为毫秒 "maxTimeDiff": 0, // 选填，允许的最大时间差，单位为毫秒
"shortIds": [ "shortIds": [ // 必填，客户端可用的 shortId 列表，可用于区分不同的客户端
// 必填，客户端可用的 shortId 列表，可用于区分不同的客户端
"", // 若有此项，客户端 shortId 可为空 "", // 若有此项，客户端 shortId 可为空
"0123456789abcdef" // 0 到 f，长度为 2 的倍数，长度上限为 16 "0123456789abcdef" // 0 到 f，长度为 2 的倍数，长度上限为 16
], ]
// 下列两个 limit 为选填，可对回落的 REALITY 连接限速。默认为 0 即不启用
// 警告：启用限速可能会引入新的特征被 GFW 探测到！如果您是GUI/面板/一键脚本开发者，请务必让这些参数随机化！
"limitFallbackUpload": {
// 限制回落上行
"afterBytes": 0, // 传输指定字节后开始限速
"bytesPerSec": 0, // 基准速率 (字节/秒)
"burstBytesPerSec": 0 // 突发速率 (字节/秒)
},
"limitFallbackDownload": {
// 限制回落下行
"afterBytes": 0, // 传输指定字节后开始限速
"bytesPerSec": 0, // 基准速率 (字节/秒)
"burstBytesPerSec": 0 // 突发速率 (字节/秒)
}
} }
} }
} }
@ -80,10 +63,9 @@ TODO List: TODO
**REALITY 也可以搭配 XTLS 以外的代理协议使用**，但不建议这样做，因为它们存在明显且已被针对的 TLS in TLS 特征 **REALITY 也可以搭配 XTLS 以外的代理协议使用**，但不建议这样做，因为它们存在明显且已被针对的 TLS in TLS 特征
REALITY 的下一个主要目标是“**预先构建模式**”，即提前采集目标网站特征，XTLS 的下一个主要目标是 **0-RTT** REALITY 的下一个主要目标是“**预先构建模式**”，即提前采集目标网站特征，XTLS 的下一个主要目标是 **0-RTT**
```jsonc ```json5
{ {
"outbounds": [ "outbounds": [ // 客户端出站配置
// 客户端出站配置
{ {
"protocol": "vless", "protocol": "vless",
"settings": { "settings": {