purgatory/Xray-docs-next
1
0
Fork 0
mirror of https://github.com/XTLS/Xray-docs-next.git synced 2025-04-07 07:13:36 +03:00
Code Issues Projects Releases Packages Wiki Activity

Reality done.

Browse source
This commit is contained in:
Lumière Élevé 2024-03-30 18:22:52 +00:00
parent 32bb0e4198
commit bf18c73587
No known key found for this signature in database
GPG key ID: 92858B1762E16671
2 changed files with 96 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/config/transport.md
View file

@ -375,7 +375,7 @@ CipherSuites 用于配置受支持的密码套件列表, 每个套件名称之
必填，同 [TLSObject](https://xtls.github.io/config/transport.html#tlsobject)。
> `shortID` : string
> `shortId` : string
服务端 shortIds 之一。

95
docs/en/config/transport.md
View file

@ -285,7 +285,102 @@ If you want to achieve A/A+ rating in SSLLabs or MySSL tests, visit [here](https
Path to the (Pre-)Master-Secret log file. Can be used by sniffers like WireShark to decrypt TLS connections managed by Xray. Cannot be used with uTLS at the moment, and requires Xray-core v.8.7 or later.
#### RealityObject
```json
{
"show": false,
"dest": "example.com:443",
"xver": 0,
"serverNames": ["example.com", "www.example.com"],
"privateKey": "",
"minClientVer": "",
"maxClientVer": "",
"maxTimeDiff": 0,
"shortIds": ["", "0123456789abcdef"],
"fingerprint": "chrome",
"serverName": "",
"publicKey": "",
"shortId": "",
"spiderX": ""
}
```
::: tip
Further information available in the [REALITY project repo](https://github.com/XTLS/REALITY).
:::
> `show`: true | false
Emits verbose logs when `true`.
::: tip
**Inbound** (**server-side**) configs below.
:::
> `dest`: string
Required. Same schema as [dest](https://xtls.github.io/config/features/fallback.html#fallbackobject) in VLESS `fallbacks`.
> `xver`: string
Optional. Same schema as [xver](https://xtls.github.io/config/features/fallback.html#fallbackobject) in VLESS `fallbacks`.
> `serverNames`: [string]
Required. A list of accepted server names. No support for `*` wildcards yet.
> `privateKey`: string
Required. Generate with `./xray x25519`.
> `minClientVer`: string
Optional. Minimal accepted version of the Xray client, specified in `x.y.z`.
> `maxClientVer`: string
Optional. Maximum accepted version of the Xray client, specified in `x.y.z`.
> `maxTimeDiff`: number
Optional. The maximum time difference allowed, specified in milliseconds.
> `shortIds`: [string]
Required. A list of `shortId`s accepted. Can be used to distinguish different clients.
Specified in hex strings, with the length as multiples of 2. Cannot be longer than 16 characters.
`shortId` on clients can be left blank if a blank value exists on the server.
::: tip
**Outbound** (**client-side**) configs below.
:::
> `serverName`: string
One of the server names accepted by the server.
> `fingerprint`: string
Required. Same as the [TLSObject](#tlsobject).
> `shortId`: string
One of the short IDs accepted by the server.
Specified in hex strings, with the length as multiples of 2. Cannot be longer than 16 characters.
`shortId` on clients can be left blank if a blank value exists on the server.
> `publicKey`: string
Required. The public key that corresponds to the private key on the server. Can be obtained by `./xray x25519 -i "privateKey"`.
> `spiderX`: string
The bootstrapping path and query params of the spider. It's recommended to have this varied per client.
#### CertificateObject