Improve a few type definitions, update english log docs

This commit is contained in:
mmmray
2024-09-22 16:16:00 -05:00
parent 1764ec590e
commit 603389ff05
6 changed files with 16 additions and 6 deletions
+1 -1
View File
@@ -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/).
+11 -1
View File
@@ -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]`
+1 -1
View File
@@ -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)