Improve a few type definitions, update english log docs

XTLS · Sep 22, 2024 · 603389f · 603389f
1 parent 1764ec5
commit 603389f
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 6 deletions.
diff --git a/docs/config/inbound.md b/docs/config/inbound.md
@@ -57,7 +57,7 @@
 
 当只有一个端口时，Xray 会在此端口监听入站连接。当指定了一个端口范围时，取决于 `allocate` 设置。
 
-> `protocol`: string
+> `protocol`: "dokodemo-door" | "http" | "shadowsocks" | "socks" | "vless" | "vmess" | "trojan" | "wireguard"
 
 连接协议名称，可选的协议列表见左侧 入站代理。
 

diff --git a/docs/config/log.md b/docs/config/log.md
@@ -47,7 +47,7 @@ error 日志的级别, 指示 error 日志需要记录的信息.
 
 是否启用 DNS 查询日志，例如：`DOH//doh.server got answer: domain.com -> [ip1, ip2] 2.333ms`
 
-> `maskAddress`: string
+> `maskAddress`: "quarter" | "half" | "full"
 
 IP地址遮罩，启用后将自动替换log中出现的IP地址，用于在分享日志时保护隐私，默认为空即不启用。
 

diff --git a/docs/en/config/inbound.md b/docs/en/config/inbound.md
@@ -52,7 +52,7 @@ Port. The accepted formats are:
 
 When only one port is specified, Xray listens for inbound connections on that port. When a range of ports is specified, it depends on the `allocate` setting.
 
-> `protocol`: string
+> `protocol`: "dokodemo-door" | "http" | "shadowsocks" | "socks" | "vless" | "vmess" | "trojan" | "wireguard"
 
 The connection protocol name. The optional protocol types are listed in [inbound protocols](./inbounds/).
 

diff --git a/docs/en/config/log.md b/docs/en/config/log.md
@@ -14,7 +14,8 @@ LogObject corresponds to the `log` item in the configuration file.
     "access": "file_path",
     "error": "file_path",
     "loglevel": "warning",
-    "dnsLog": false
+    "dnsLog": false,
+    "maskAddress": ""
   }
 }
 ```
@@ -44,3 +45,12 @@ The log level for error logs, indicating the information that needs to be record
 > `dnsLog`: bool
 
 Whether to enable DNS query logs, for example: `DOH//doh.server got answer: domain.com -> [ip1, ip2] 2.333ms`.
+
+> `maskAddress`: "quarter" | "half" | "full"
+
+IP address masking, when enabled, will automatically replace the IP address appearing in the log. It is used to protect privacy when sharing logs. The default is empty and is not enabled.
+
+Currently available levels are `quarter`, `half`, `full`. The mask form corresponds to the following:
+
+- ipv4 `1.2.*.*` `1.*.*.*` `[Masked IPv4]`
+- ipv6 `1234:5678::/32` `1234::/16` `[Masked IPv6]`
diff --git a/docs/en/config/transport.md b/docs/en/config/transport.md
@@ -51,7 +51,7 @@ Whether to enable transport layer encryption. Supported options below.
 
 - `"none"` enables no encryption (default).
 - `"tls"` enables encryption with [TLS](https://en.wikipedia.org/wiki/transport_Layer_Security).
-- `"xtls"` enables encryption with REALITY.
+- `"reality"` enables encryption with REALITY.
 
 > `tlsSettings`: [TLSObject](#tlsobject)
 

diff --git a/docs/ru/config/inbound.md b/docs/ru/config/inbound.md
@@ -60,7 +60,7 @@
 Если указан только один порт, Xray будет прослушивать входящие подключения на этом порту.  
 Если указан диапазон портов, то фактическое поведение зависит от настройки `allocate`.
 
-> `protocol`: string
+> `protocol`: "dokodemo-door" | "http" | "shadowsocks" | "socks" | "vless" | "vmess" | "trojan" | "wireguard"
 
 Название протокола подключения.  
 Список доступных протоколов см. в разделе "Входящие подключения" в левой части документации.