diff --git a/docs/config/geodata.md b/docs/config/geodata.md index ae6f6312..8a2453fb 100644 --- a/docs/config/geodata.md +++ b/docs/config/geodata.md @@ -6,14 +6,18 @@ ## GeodataObject +`GeodataObject` 对应配置文件的 `geodata` 项。 + ```json { - "cron": "0 4 * * *", - "outbound": "proxy", - "assets": [ - { "url": "https://example.com/geoip.dat", "file": "geoip.dat" }, - { "url": "https://example.com/geosite.dat", "file": "geosite.dat" } - ] + "geodata": { + "cron": "0 4 * * *", + "outbound": "proxy", + "assets": [ + { "url": "https://example.com/geoip.dat", "file": "geoip.dat" }, + { "url": "https://example.com/geosite.dat", "file": "geosite.dat" } + ] + } } ``` diff --git a/docs/config/inbounds/http.md b/docs/config/inbounds/http.md index 8e495aec..adfc8138 100644 --- a/docs/config/inbounds/http.md +++ b/docs/config/inbounds/http.md @@ -21,6 +21,8 @@ HTTP 协议。 ## InboundConfigurationObject +`InboundConfigurationObject` 对应 [`InboundObject`](../inbound.md) 中的 `settings` 项。 + ```json { "inbounds": [ diff --git a/docs/config/inbounds/hysteria.md b/docs/config/inbounds/hysteria.md index a645c558..615c3565 100644 --- a/docs/config/inbounds/hysteria.md +++ b/docs/config/inbounds/hysteria.md @@ -6,6 +6,8 @@ ## InboundConfigurationObject +`InboundConfigurationObject` 对应 [`InboundObject`](../inbound.md) 中的 `settings` 项。 + ```json { "inbounds": [ diff --git a/docs/config/inbounds/shadowsocks.md b/docs/config/inbounds/shadowsocks.md index 986bf045..be15d0f3 100644 --- a/docs/config/inbounds/shadowsocks.md +++ b/docs/config/inbounds/shadowsocks.md @@ -29,6 +29,8 @@ Shadowsocks 2022 新协议格式提升了性能并带有完整的重放保护, ## InboundConfigurationObject +`InboundConfigurationObject` 对应 [`InboundObject`](../inbound.md) 中的 `settings` 项。 + ```json { "inbounds": [ diff --git a/docs/config/inbounds/socks.md b/docs/config/inbounds/socks.md index 75f7bc42..41715b9b 100644 --- a/docs/config/inbounds/socks.md +++ b/docs/config/inbounds/socks.md @@ -10,6 +10,8 @@ ## InboundConfigurationObject +`InboundConfigurationObject` 对应 [`InboundObject`](../inbound.md) 中的 `settings` 项。 + ```json { "inbounds": [ diff --git a/docs/config/inbounds/trojan.md b/docs/config/inbounds/trojan.md index d057e09d..b6feac0b 100644 --- a/docs/config/inbounds/trojan.md +++ b/docs/config/inbounds/trojan.md @@ -8,6 +8,8 @@ Trojan 被设计工作在正确配置的加密 TLS 隧道 ## InboundConfigurationObject +`InboundConfigurationObject` 对应 [`InboundObject`](../inbound.md) 中的 `settings` 项。 + ```json { "inbounds": [ diff --git a/docs/config/inbounds/tun.md b/docs/config/inbounds/tun.md index 7f66c48e..0f902752 100644 --- a/docs/config/inbounds/tun.md +++ b/docs/config/inbounds/tun.md @@ -4,6 +4,8 @@ ## InboundConfigurationObject +`InboundConfigurationObject` 对应 [`InboundObject`](../inbound.md) 中的 `settings` 项。 + ```json { "inbounds": [ diff --git a/docs/config/inbounds/tunnel.md b/docs/config/inbounds/tunnel.md index 2d488bf6..34f4b363 100644 --- a/docs/config/inbounds/tunnel.md +++ b/docs/config/inbounds/tunnel.md @@ -4,6 +4,8 @@ Tunnel(隧道),旧称 dokodemo-door(任意门),可以监听数个本 ## InboundConfigurationObject +`InboundConfigurationObject` 对应 [`InboundObject`](../inbound.md) 中的 `settings` 项。 + ```json { "inbounds": [ diff --git a/docs/config/inbounds/vless.md b/docs/config/inbounds/vless.md index 194104e6..6acb7f7b 100644 --- a/docs/config/inbounds/vless.md +++ b/docs/config/inbounds/vless.md @@ -6,6 +6,8 @@ VLESS 是一个无状态的轻量传输协议,它分为入站和出站两部 ## InboundConfigurationObject +`InboundConfigurationObject` 对应 [`InboundObject`](../inbound.md) 中的 `settings` 项。 + ```json { "inbounds": [ diff --git a/docs/config/inbounds/vmess.md b/docs/config/inbounds/vmess.md index 1c897289..b61f59f8 100644 --- a/docs/config/inbounds/vmess.md +++ b/docs/config/inbounds/vmess.md @@ -8,6 +8,8 @@ VMess 依赖于系统时间,请确保使用 Xray 的系统 UTC 时间误差在 ## InboundConfigurationObject +`InboundConfigurationObject` 对应 [`InboundObject`](../inbound.md) 中的 `settings` 项。 + ```json { "inbounds": [ diff --git a/docs/config/inbounds/wireguard.md b/docs/config/inbounds/wireguard.md index 15605430..c832bc7f 100644 --- a/docs/config/inbounds/wireguard.md +++ b/docs/config/inbounds/wireguard.md @@ -8,6 +8,8 @@ User-space Wireguard 协议实现。 ## InboundConfigurationObject +`InboundConfigurationObject` 对应 [`InboundObject`](../inbound.md) 中的 `settings` 项。 + ```json { "inbounds": [ diff --git a/docs/config/metrics.md b/docs/config/metrics.md index 59261b9b..6f3ecb08 100644 --- a/docs/config/metrics.md +++ b/docs/config/metrics.md @@ -2,15 +2,17 @@ 更直接(希望更好)的统计导出方式。 -## 相关配置 +## MetricsObject -在基础配置中增加 metrics +`MetricsObject` 对应配置文件的 `metrics` 项。 ```json - "metrics": { - "tag": "Metrics", - "listen": "127.0.0.1:11111" - } +{ + "metrics": { + "tag": "Metrics", + "listen": "127.0.0.1:11111" + } +} ``` > `tag`: string diff --git a/docs/config/observatory.md b/docs/config/observatory.md index 3479a8f2..88a02999 100644 --- a/docs/config/observatory.md +++ b/docs/config/observatory.md @@ -4,12 +4,16 @@ ## ObservatoryObject +`ObservatoryObject` 对应配置文件的 `observatory` 项。 + ```json { - "subjectSelector": ["outbound"], - "probeUrl": "https://www.google.com/generate_204", - "probeInterval": "10s", - "enableConcurrency": false + "observatory": { + "subjectSelector": ["outbound"], + "probeUrl": "https://www.google.com/generate_204", + "probeInterval": "10s", + "enableConcurrency": false + } } ``` @@ -34,10 +38,14 @@ ## BurstObservatoryObject +`BurstObservatoryObject` 对应配置文件的 `burstObservatory` 项。 + ```json { - "subjectSelector": ["outbound"], - "pingConfig": {} + "burstObservatory": { + "subjectSelector": ["outbound"], + "pingConfig": {} + } } ``` diff --git a/docs/config/outbounds/blackhole.md b/docs/config/outbounds/blackhole.md index c9f23152..74944e14 100644 --- a/docs/config/outbounds/blackhole.md +++ b/docs/config/outbounds/blackhole.md @@ -4,6 +4,8 @@ Blackhole(黑洞)是一个出站数据协议,它会阻碍所有数据的 ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/dns.md b/docs/config/outbounds/dns.md index 33f6e407..49f76a1e 100644 --- a/docs/config/outbounds/dns.md +++ b/docs/config/outbounds/dns.md @@ -8,6 +8,8 @@ DNS 是一个出站协议,用于接收由 routing 送入的 DNS 查询,并 ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/freedom.md b/docs/config/outbounds/freedom.md index b05da805..117e7361 100644 --- a/docs/config/outbounds/freedom.md +++ b/docs/config/outbounds/freedom.md @@ -8,6 +8,8 @@ Freedom 是一个出站协议,可以用来向任意网络发送(正常的) ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/http.md b/docs/config/outbounds/http.md index 7d508d3b..c2d07884 100644 --- a/docs/config/outbounds/http.md +++ b/docs/config/outbounds/http.md @@ -12,6 +12,8 @@ HTTP 协议。 ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/hysteria.md b/docs/config/outbounds/hysteria.md index 55cee878..a0e11e62 100644 --- a/docs/config/outbounds/hysteria.md +++ b/docs/config/outbounds/hysteria.md @@ -10,6 +10,8 @@ Hysteria 协议的客户端实现。 ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/loopback.md b/docs/config/outbounds/loopback.md index 0a291720..89a09c70 100644 --- a/docs/config/outbounds/loopback.md +++ b/docs/config/outbounds/loopback.md @@ -4,6 +4,8 @@ Loopback 是个出站数据协议,其作用为将经该出站传出的数据 ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/shadowsocks.md b/docs/config/outbounds/shadowsocks.md index 0cb7fb50..e73031b1 100644 --- a/docs/config/outbounds/shadowsocks.md +++ b/docs/config/outbounds/shadowsocks.md @@ -29,6 +29,8 @@ Shadowsocks 2022 新协议格式提升了性能并带有完整的重放保护, ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/socks.md b/docs/config/outbounds/socks.md index 7cbda833..eb72f13f 100644 --- a/docs/config/outbounds/socks.md +++ b/docs/config/outbounds/socks.md @@ -8,6 +8,8 @@ ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/trojan.md b/docs/config/outbounds/trojan.md index dc053ccb..e253785c 100644 --- a/docs/config/outbounds/trojan.md +++ b/docs/config/outbounds/trojan.md @@ -8,6 +8,8 @@ Trojan 被设计工作在正确配置的加密 TLS 隧道 ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/vless.md b/docs/config/outbounds/vless.md index c1c2ee14..8abe3c10 100644 --- a/docs/config/outbounds/vless.md +++ b/docs/config/outbounds/vless.md @@ -6,6 +6,8 @@ VLESS 是一个无状态的轻量传输协议,它分为入站和出站两部 ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/vmess.md b/docs/config/outbounds/vmess.md index 5daa701b..b7f26cea 100644 --- a/docs/config/outbounds/vmess.md +++ b/docs/config/outbounds/vmess.md @@ -8,6 +8,8 @@ VMess 依赖于系统时间,请确保使用 Xray 的系统 UTC 时间误差在 ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/outbounds/wireguard.md b/docs/config/outbounds/wireguard.md index 3b7953f4..8ece815d 100644 --- a/docs/config/outbounds/wireguard.md +++ b/docs/config/outbounds/wireguard.md @@ -8,6 +8,8 @@ ## OutboundConfigurationObject +`OutboundConfigurationObject` 对应 [`OutboundObject`](../outbound.md) 中的 `settings` 项。 + ```json { "outbounds": [ diff --git a/docs/config/transport.md b/docs/config/transport.md index 092c511d..e46c2cef 100644 --- a/docs/config/transport.md +++ b/docs/config/transport.md @@ -6,7 +6,7 @@ ## StreamSettingsObject -`StreamSettingsObject` 对应入站或出站中的 `streamSettings` 项。每一个入站或出站都可以分别配置不同的传输配置,都可以设置 `streamSettings` 来进行一些传输的配置。 +`StreamSettingsObject` 对应 [`InboundObject`](./inbound.md) 或 [`OutboundObject`](./outbound.md) 中的 `streamSettings` 项。每一个入站或出站都可以分别配置不同的传输配置,都可以设置 `streamSettings` 来进行一些传输的配置。 ```json { diff --git a/docs/config/transports/grpc.md b/docs/config/transports/grpc.md index cca0c2dd..e46b9cb1 100644 --- a/docs/config/transports/grpc.md +++ b/docs/config/transports/grpc.md @@ -35,7 +35,7 @@ gRPC(HTTP/2)内置多路复用,不建议使用 gRPC 与 HTTP/2 时启用 m ## GRPCObject -`GRPCObject` 对应传输配置的 `grpcSettings` 项。 +`GRPCObject` 对应 [`StreamSettingsObject`](../transport.md#streamsettingsobject) 中的 `grpcSettings` 项。 ```json { diff --git a/docs/config/transports/httpupgrade.md b/docs/config/transports/httpupgrade.md index d176998a..6b5d89e1 100644 --- a/docs/config/transports/httpupgrade.md +++ b/docs/config/transports/httpupgrade.md @@ -9,7 +9,7 @@ ## HttpUpgradeObject -`HttpUpgradeObject` 对应传输配置的 `httpupgradeSettings` 项。 +`HttpUpgradeObject` 对应 [`StreamSettingsObject`](../transport.md#streamsettingsobject) 中的 `httpupgradeSettings` 项。 ```json { diff --git a/docs/config/transports/hysteria.md b/docs/config/transports/hysteria.md index 56bf0b0c..14b65689 100644 --- a/docs/config/transports/hysteria.md +++ b/docs/config/transports/hysteria.md @@ -4,7 +4,7 @@ Hysteria2 的底层 QUIC 传输的 Xray 实现,通常搭配 hysteria[出站](. ## HysteriaObject -`HysteriaObject` 对应传输配置的 `hysteriaSettings` 项。 +`HysteriaObject` 对应 [`StreamSettingsObject`](../transport.md#streamsettingsobject) 中的 `hysteriaSettings` 项。 ```json { diff --git a/docs/config/transports/mkcp.md b/docs/config/transports/mkcp.md index 3a590c8e..7e46cf00 100644 --- a/docs/config/transports/mkcp.md +++ b/docs/config/transports/mkcp.md @@ -10,7 +10,7 @@ mKCP 牺牲带宽来降低延迟。传输同样的内容,mKCP 一般比 TCP ## KcpObject -`KcpObject` 对应传输配置的 `kcpSettings` 项。 +`KcpObject` 对应 [`StreamSettingsObject`](../transport.md#streamsettingsobject) 中的 `kcpSettings` 项。 ```json { diff --git a/docs/config/transports/raw.md b/docs/config/transports/raw.md index e33e64a0..ede0a674 100644 --- a/docs/config/transports/raw.md +++ b/docs/config/transports/raw.md @@ -6,7 +6,7 @@ ## RawObject -`RawObject` 对应传输配置的 `rawSettings` 项。 +`RawObject` 对应 [`StreamSettingsObject`](../transport.md#streamsettingsobject) 中的 `rawSettings` 项。 ```json { diff --git a/docs/config/transports/websocket.md b/docs/config/transports/websocket.md index 9040a2e9..2be1c281 100644 --- a/docs/config/transports/websocket.md +++ b/docs/config/transports/websocket.md @@ -14,7 +14,7 @@ Websocket 会识别 HTTP 请求的 X-Forwarded-For 头来覆写流量的源地 ## WebSocketObject -`WebSocketObject` 对应传输配置的 `wsSettings` 项。 +`WebSocketObject` 对应 [`StreamSettingsObject`](../transport.md#streamsettingsobject) 中的 `wsSettings` 项。 ```json { diff --git a/docs/en/config/geodata.md b/docs/en/config/geodata.md index 8312e076..f37e5466 100644 --- a/docs/en/config/geodata.md +++ b/docs/en/config/geodata.md @@ -6,14 +6,18 @@ Use with caution on low-memory devices. ## GeodataObject +`GeodataObject` corresponds to the `geodata` item in the configuration file. + ```json { - "cron": "0 4 * * *", - "outbound": "proxy", - "assets": [ - { "url": "https://example.com/geoip.dat", "file": "geoip.dat" }, - { "url": "https://example.com/geosite.dat", "file": "geosite.dat" } - ] + "geodata": { + "cron": "0 4 * * *", + "outbound": "proxy", + "assets": [ + { "url": "https://example.com/geoip.dat", "file": "geoip.dat" }, + { "url": "https://example.com/geosite.dat", "file": "geosite.dat" } + ] + } } ``` diff --git a/docs/en/config/inbounds/http.md b/docs/en/config/inbounds/http.md index 1851f611..111ecb96 100644 --- a/docs/en/config/inbounds/http.md +++ b/docs/en/config/inbounds/http.md @@ -21,6 +21,8 @@ Use the following environment variables in Linux to enable a global HTTP proxy f ## InboundConfigurationObject +`InboundConfigurationObject` corresponds to the `settings` item in [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/en/config/inbounds/hysteria.md b/docs/en/config/inbounds/hysteria.md index 6cb83f4b..33aced8b 100644 --- a/docs/en/config/inbounds/hysteria.md +++ b/docs/en/config/inbounds/hysteria.md @@ -6,6 +6,8 @@ The `hysteria protocol` itself has no authentication; `users` only take effect w ## InboundConfigurationObject +`InboundConfigurationObject` corresponds to the `settings` item in [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/en/config/inbounds/shadowsocks.md b/docs/en/config/inbounds/shadowsocks.md index a6bf0159..aaff0e2d 100644 --- a/docs/en/config/inbounds/shadowsocks.md +++ b/docs/en/config/inbounds/shadowsocks.md @@ -29,6 +29,8 @@ Under the "none" encryption method, traffic will be transmitted in plain text. T ## InboundConfigurationObject +`InboundConfigurationObject` corresponds to the `settings` item in [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/en/config/inbounds/socks.md b/docs/en/config/inbounds/socks.md index c4aecab9..cb5dd993 100644 --- a/docs/en/config/inbounds/socks.md +++ b/docs/en/config/inbounds/socks.md @@ -10,6 +10,8 @@ A more meaningful usage of `Socks` inbound is to listen within a LAN or on the l ## InboundConfigurationObject +`InboundConfigurationObject` corresponds to the `settings` item in [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/en/config/inbounds/trojan.md b/docs/en/config/inbounds/trojan.md index ca80a04c..6fca24b4 100644 --- a/docs/en/config/inbounds/trojan.md +++ b/docs/en/config/inbounds/trojan.md @@ -8,6 +8,8 @@ Trojan is designed to work over correctly configured encrypted TLS tunnels. ## InboundConfigurationObject +`InboundConfigurationObject` corresponds to the `settings` item in [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/en/config/inbounds/tun.md b/docs/en/config/inbounds/tun.md index ad91d048..38bf0135 100644 --- a/docs/en/config/inbounds/tun.md +++ b/docs/en/config/inbounds/tun.md @@ -4,6 +4,8 @@ Creates a TUN interface; traffic sent to this interface will be processed by Xra ## InboundConfigurationObject +`InboundConfigurationObject` corresponds to the `settings` item in [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/en/config/inbounds/tunnel.md b/docs/en/config/inbounds/tunnel.md index 3544de0e..36fd37dd 100644 --- a/docs/en/config/inbounds/tunnel.md +++ b/docs/en/config/inbounds/tunnel.md @@ -4,6 +4,8 @@ Tunnel, formerly known as dokodemo-door (Arbitrary Door), can listen on multiple ## InboundConfigurationObject +`InboundConfigurationObject` corresponds to the `settings` item in [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/en/config/inbounds/vless.md b/docs/en/config/inbounds/vless.md index 549372d6..56c4a687 100644 --- a/docs/en/config/inbounds/vless.md +++ b/docs/en/config/inbounds/vless.md @@ -6,6 +6,8 @@ Unlike [VMess](./vmess.md), VLESS does not depend on system time. The authentica ## InboundConfigurationObject +`InboundConfigurationObject` corresponds to the `settings` item in [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/en/config/inbounds/vmess.md b/docs/en/config/inbounds/vmess.md index 133d5d18..10731ce3 100644 --- a/docs/en/config/inbounds/vmess.md +++ b/docs/en/config/inbounds/vmess.md @@ -8,6 +8,8 @@ VMess depends on system time. Please ensure that the system UTC time of the devi ## InboundConfigurationObject +`InboundConfigurationObject` corresponds to the `settings` item in [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/en/config/inbounds/wireguard.md b/docs/en/config/inbounds/wireguard.md index 3f72bf86..90025851 100644 --- a/docs/en/config/inbounds/wireguard.md +++ b/docs/en/config/inbounds/wireguard.md @@ -8,6 +8,8 @@ User-space WireGuard protocol implementation. ## InboundConfigurationObject +`InboundConfigurationObject` corresponds to the `settings` item in [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/en/config/metrics.md b/docs/en/config/metrics.md index c13bda0f..22dae624 100644 --- a/docs/en/config/metrics.md +++ b/docs/en/config/metrics.md @@ -2,15 +2,17 @@ A more direct (and hopefully better) way to export statistics. -## Relevant Configuration +## MetricsObject -Add `metrics` to the basic configuration: +`MetricsObject` corresponds to the `metrics` item in the configuration file. ```json - "metrics": { - "tag": "Metrics", - "listen": "127.0.0.1:11111" - } +{ + "metrics": { + "tag": "Metrics", + "listen": "127.0.0.1:11111" + } +} ``` > `tag`: string diff --git a/docs/en/config/observatory.md b/docs/en/config/observatory.md index d03003de..5d9ebbf8 100644 --- a/docs/en/config/observatory.md +++ b/docs/en/config/observatory.md @@ -4,12 +4,16 @@ The Observatory component uses HTTPing to probe the connection status of outboun ## ObservatoryObject +`ObservatoryObject` corresponds to the `observatory` item in the configuration file. + ```json { - "subjectSelector": ["outbound"], - "probeUrl": "https://www.google.com/generate_204", - "probeInterval": "10s", - "enableConcurrency": false + "observatory": { + "subjectSelector": ["outbound"], + "probeUrl": "https://www.google.com/generate_204", + "probeInterval": "10s", + "enableConcurrency": false + } } ``` @@ -34,10 +38,14 @@ Note that since the request interval is fixed, periodic fixed requests might lea ## BurstObservatoryObject +`BurstObservatoryObject` corresponds to the `burstObservatory` item in the configuration file. + ```json { - "subjectSelector": ["outbound"], - "pingConfig": {} + "burstObservatory": { + "subjectSelector": ["outbound"], + "pingConfig": {} + } } ``` diff --git a/docs/en/config/outbounds/blackhole.md b/docs/en/config/outbounds/blackhole.md index 7e2c291e..58fc8661 100644 --- a/docs/en/config/outbounds/blackhole.md +++ b/docs/en/config/outbounds/blackhole.md @@ -4,6 +4,8 @@ Blackhole is an outbound data protocol that blocks all outbound data. When used ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/dns.md b/docs/en/config/outbounds/dns.md index b4dc65f5..d3959337 100644 --- a/docs/en/config/outbounds/dns.md +++ b/docs/en/config/outbounds/dns.md @@ -8,6 +8,8 @@ It can allow queries to the target DNS server, `hijack` them to the built-in [DN ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/freedom.md b/docs/en/config/outbounds/freedom.md index c05043fc..2c941d81 100644 --- a/docs/en/config/outbounds/freedom.md +++ b/docs/en/config/outbounds/freedom.md @@ -8,6 +8,8 @@ This outbound has a default safety policy in server-side and reverse-proxy scena ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/http.md b/docs/en/config/outbounds/http.md index 0e7674c2..95235637 100644 --- a/docs/en/config/outbounds/http.md +++ b/docs/en/config/outbounds/http.md @@ -12,6 +12,8 @@ HTTP protocol. ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/hysteria.md b/docs/en/config/outbounds/hysteria.md index d8b6e323..b51985e0 100644 --- a/docs/en/config/outbounds/hysteria.md +++ b/docs/en/config/outbounds/hysteria.md @@ -10,6 +10,8 @@ The `hysteria protocol` itself has no authentication. When using with a non `hys ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/loopback.md b/docs/en/config/outbounds/loopback.md index 8631476e..1eaa95f6 100644 --- a/docs/en/config/outbounds/loopback.md +++ b/docs/en/config/outbounds/loopback.md @@ -4,6 +4,8 @@ Loopback is an outbound data protocol. Its function is to re-inject data sent th ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/shadowsocks.md b/docs/en/config/outbounds/shadowsocks.md index f3bb3e61..5b520c64 100644 --- a/docs/en/config/outbounds/shadowsocks.md +++ b/docs/en/config/outbounds/shadowsocks.md @@ -29,6 +29,8 @@ Under the "none" encryption method, traffic will be transmitted in plain text. T ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/socks.md b/docs/en/config/outbounds/socks.md index 98a1bb95..a713ec89 100644 --- a/docs/en/config/outbounds/socks.md +++ b/docs/en/config/outbounds/socks.md @@ -8,6 +8,8 @@ Standard Socks protocol implementation, compatible with Socks 5. ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/trojan.md b/docs/en/config/outbounds/trojan.md index e147691b..aa0913e7 100644 --- a/docs/en/config/outbounds/trojan.md +++ b/docs/en/config/outbounds/trojan.md @@ -8,6 +8,8 @@ Trojan is designed to work over a correctly configured encrypted TLS tunnel. ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/vless.md b/docs/en/config/outbounds/vless.md index c01175ac..7bd472ab 100644 --- a/docs/en/config/outbounds/vless.md +++ b/docs/en/config/outbounds/vless.md @@ -6,6 +6,8 @@ Unlike [VMess](./vmess.md), VLESS does not depend on system time. The authentica ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/vmess.md b/docs/en/config/outbounds/vmess.md index e578dceb..fa64cb0b 100644 --- a/docs/en/config/outbounds/vmess.md +++ b/docs/en/config/outbounds/vmess.md @@ -8,6 +8,8 @@ VMess depends on system time. Please ensure that the UTC time of the system runn ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/outbounds/wireguard.md b/docs/en/config/outbounds/wireguard.md index fa403309..dbb1685e 100644 --- a/docs/en/config/outbounds/wireguard.md +++ b/docs/en/config/outbounds/wireguard.md @@ -8,6 +8,8 @@ Standard Wireguard protocol implementation. ## OutboundConfigurationObject +`OutboundConfigurationObject` corresponds to the `settings` item in [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/en/config/transport.md b/docs/en/config/transport.md index 7c295b1c..c58e8923 100644 --- a/docs/en/config/transport.md +++ b/docs/en/config/transport.md @@ -6,7 +6,7 @@ Transport specifies a stable method for data transmission. Generally, both ends ## StreamSettingsObject -`StreamSettingsObject` corresponds to the `streamSettings` item in inbound or outbound configurations. Each inbound or outbound can be configured with different transport settings independently, and `streamSettings` can be set to perform some transport configurations. +`StreamSettingsObject` corresponds to the `streamSettings` item in [`InboundObject`](./inbound.md) or [`OutboundObject`](./outbound.md). Each inbound or outbound can be configured with different transport settings independently, and `streamSettings` can be set to perform some transport configurations. ```json { diff --git a/docs/en/config/transports/grpc.md b/docs/en/config/transports/grpc.md index 25d2a88c..d588a245 100644 --- a/docs/en/config/transports/grpc.md +++ b/docs/en/config/transports/grpc.md @@ -35,7 +35,7 @@ If you are using fallback, please note the following: ## GRPCObject -`GRPCObject` corresponds to the `grpcSettings` item in the transport configuration. +`GRPCObject` corresponds to the `grpcSettings` item in [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/en/config/transports/httpupgrade.md b/docs/en/config/transports/httpupgrade.md index a4930365..2f72c212 100644 --- a/docs/en/config/transports/httpupgrade.md +++ b/docs/en/config/transports/httpupgrade.md @@ -9,7 +9,7 @@ Its design is not recommended for standalone use; instead, it is intended to wor ## HttpUpgradeObject -`HttpUpgradeObject` corresponds to the `httpupgradeSettings` item in transport configuration. +`HttpUpgradeObject` corresponds to the `httpupgradeSettings` item in [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/en/config/transports/hysteria.md b/docs/en/config/transports/hysteria.md index 5b4c10fe..f127dcde 100644 --- a/docs/en/config/transports/hysteria.md +++ b/docs/en/config/transports/hysteria.md @@ -4,7 +4,7 @@ Xray implementation of the underlying QUIC transport for Hysteria2, typically us ## HysteriaObject -`HysteriaObject` corresponds to the `hysteriaSettings` item in the transport configuration. +`HysteriaObject` corresponds to the `hysteriaSettings` item in [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/en/config/transports/mkcp.md b/docs/en/config/transports/mkcp.md index 4c43e5bc..e74747ab 100644 --- a/docs/en/config/transports/mkcp.md +++ b/docs/en/config/transports/mkcp.md @@ -10,7 +10,7 @@ Please ensure that the firewall configuration on the host is correct. ## KcpObject -`KcpObject` corresponds to the `kcpSettings` item in the transport configuration. +`KcpObject` corresponds to the `kcpSettings` item in [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/en/config/transports/raw.md b/docs/en/config/transports/raw.md index f1963f96..b3fa6832 100644 --- a/docs/en/config/transports/raw.md +++ b/docs/en/config/transports/raw.md @@ -6,7 +6,7 @@ It can be combined with various protocols in multiple modes. ## RawObject -`RawObject` corresponds to the `rawSettings` item in transport configuration. +`RawObject` corresponds to the `rawSettings` item in [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/en/config/transports/websocket.md b/docs/en/config/transports/websocket.md index 25d65b28..cf548dd5 100644 --- a/docs/en/config/transports/websocket.md +++ b/docs/en/config/transports/websocket.md @@ -14,7 +14,7 @@ WebSocket will recognize the `X-Forwarded-For` header in HTTP requests to overwr ## WebSocketObject -`WebSocketObject` corresponds to the `wsSettings` item in the transport configuration. +`WebSocketObject` corresponds to the `wsSettings` item in [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/ru/config/geodata.md b/docs/ru/config/geodata.md index bd91335b..8b2fc48e 100644 --- a/docs/ru/config/geodata.md +++ b/docs/ru/config/geodata.md @@ -6,14 +6,18 @@ ## GeodataObject +`GeodataObject` соответствует элементу `geodata` в файле конфигурации. + ```json { - "cron": "0 4 * * *", - "outbound": "proxy", - "assets": [ - { "url": "https://example.com/geoip.dat", "file": "geoip.dat" }, - { "url": "https://example.com/geosite.dat", "file": "geosite.dat" } - ] + "geodata": { + "cron": "0 4 * * *", + "outbound": "proxy", + "assets": [ + { "url": "https://example.com/geoip.dat", "file": "geoip.dat" }, + { "url": "https://example.com/geosite.dat", "file": "geosite.dat" } + ] + } } ``` diff --git a/docs/ru/config/inbounds/http.md b/docs/ru/config/inbounds/http.md index 5d336e19..9221d758 100644 --- a/docs/ru/config/inbounds/http.md +++ b/docs/ru/config/inbounds/http.md @@ -21,6 +21,8 @@ ## InboundConfigurationObject +`InboundConfigurationObject` соответствует элементу `settings` в [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/ru/config/inbounds/hysteria.md b/docs/ru/config/inbounds/hysteria.md index d3310c45..233175bd 100644 --- a/docs/ru/config/inbounds/hysteria.md +++ b/docs/ru/config/inbounds/hysteria.md @@ -6,6 +6,8 @@ ## InboundConfigurationObject +`InboundConfigurationObject` соответствует элементу `settings` в [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/ru/config/inbounds/shadowsocks.md b/docs/ru/config/inbounds/shadowsocks.md index fad67199..8905f4c8 100644 --- a/docs/ru/config/inbounds/shadowsocks.md +++ b/docs/ru/config/inbounds/shadowsocks.md @@ -29,6 +29,8 @@ ## InboundConfigurationObject +`InboundConfigurationObject` соответствует элементу `settings` в [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/ru/config/inbounds/socks.md b/docs/ru/config/inbounds/socks.md index c127e5e9..dc6b0fec 100644 --- a/docs/ru/config/inbounds/socks.md +++ b/docs/ru/config/inbounds/socks.md @@ -10,6 +10,8 @@ ## InboundConfigurationObject +`InboundConfigurationObject` соответствует элементу `settings` в [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/ru/config/inbounds/trojan.md b/docs/ru/config/inbounds/trojan.md index 74db6eab..90bf1459 100644 --- a/docs/ru/config/inbounds/trojan.md +++ b/docs/ru/config/inbounds/trojan.md @@ -8,6 +8,8 @@ Trojan предназначен для работы в правильно нас ## InboundConfigurationObject +`InboundConfigurationObject` соответствует элементу `settings` в [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/ru/config/inbounds/tun.md b/docs/ru/config/inbounds/tun.md index 04e5d9c8..5c2c0b80 100644 --- a/docs/ru/config/inbounds/tun.md +++ b/docs/ru/config/inbounds/tun.md @@ -4,6 +4,8 @@ ## InboundConfigurationObject +`InboundConfigurationObject` соответствует элементу `settings` в [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/ru/config/inbounds/tunnel.md b/docs/ru/config/inbounds/tunnel.md index 27e5fe07..4acd106d 100644 --- a/docs/ru/config/inbounds/tunnel.md +++ b/docs/ru/config/inbounds/tunnel.md @@ -4,6 +4,8 @@ ## InboundConfigurationObject +`InboundConfigurationObject` соответствует элементу `settings` в [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/ru/config/inbounds/vless.md b/docs/ru/config/inbounds/vless.md index b6a22d12..de8949d7 100644 --- a/docs/ru/config/inbounds/vless.md +++ b/docs/ru/config/inbounds/vless.md @@ -6,6 +6,8 @@ VLESS - это легкий транспортный протокол без с ## InboundConfigurationObject +`InboundConfigurationObject` соответствует элементу `settings` в [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/ru/config/inbounds/vmess.md b/docs/ru/config/inbounds/vmess.md index ceb6302e..182e427d 100644 --- a/docs/ru/config/inbounds/vmess.md +++ b/docs/ru/config/inbounds/vmess.md @@ -8,6 +8,8 @@ VMess полагается на системное время. Убедитес ## InboundConfigurationObject +`InboundConfigurationObject` соответствует элементу `settings` в [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/ru/config/inbounds/wireguard.md b/docs/ru/config/inbounds/wireguard.md index 94b50d35..6dfb4775 100644 --- a/docs/ru/config/inbounds/wireguard.md +++ b/docs/ru/config/inbounds/wireguard.md @@ -8,6 +8,8 @@ ## InboundConfigurationObject +`InboundConfigurationObject` соответствует элементу `settings` в [`InboundObject`](../inbound.md). + ```json { "inbounds": [ diff --git a/docs/ru/config/metrics.md b/docs/ru/config/metrics.md index 0014104c..c7a4916e 100644 --- a/docs/ru/config/metrics.md +++ b/docs/ru/config/metrics.md @@ -2,15 +2,17 @@ Более простой (и, надеемся, лучший) способ экспорта статистики. -## Соответствующая конфигурация +## MetricsObject -Добавьте метрики в основную конфигурацию: +`MetricsObject` соответствует элементу `metrics` в файле конфигурации. ```json - "metrics": { - "tag": "Metrics", - "listen": "127.0.0.1:11111" - } +{ + "metrics": { + "tag": "Metrics", + "listen": "127.0.0.1:11111" + } +} ``` > `tag`: string diff --git a/docs/ru/config/observatory.md b/docs/ru/config/observatory.md index 56152b25..35ef4823 100644 --- a/docs/ru/config/observatory.md +++ b/docs/ru/config/observatory.md @@ -1,23 +1,27 @@ # Мониторинг подключений -Компонент мониторинга подключений использует HTTP-пинги для проверки состояния подключения исходящих прокси. Результаты мониторинга могут использоваться другими компонентами, например, балансировщиком нагрузки. -В настоящее время доступны два режима: [observatory](#observatoryobject) (фоновый мониторинг подключений) и [burstObservatory](#burstobservatoryobject) (мониторинг параллельных подключений). +Компонент мониторинга подключений использует HTTP-пинги для проверки состояния подключения исходящих прокси. Результаты мониторинга могут использоваться другими компонентами, например, балансировщиком нагрузки. +В настоящее время доступны два режима: [observatory](#observatoryobject) (фоновый мониторинг подключений) и [burstObservatory](#burstobservatoryobject) (мониторинг параллельных подключений). Выберите один из них в соответствии с вашими потребностями. ## ObservatoryObject +`ObservatoryObject` соответствует элементу `observatory` в файле конфигурации. + ```json { - "subjectSelector": ["outbound"], - "probeUrl": "https://www.google.com/generate_204", - "probeInterval": "10s", - "enableConcurrency": false + "observatory": { + "subjectSelector": ["outbound"], + "probeUrl": "https://www.google.com/generate_204", + "probeInterval": "10s", + "enableConcurrency": false + } } ``` > `subjectSelector`: \[ string \] -Массив строк, каждый элемент которого будет использоваться для сопоставления с префиксом тега исходящего подключения. +Массив строк, каждый элемент которого будет использоваться для сопоставления с префиксом тега исходящего подключения. Например, для следующих тегов исходящих подключений: `[ "a", "ab", "c", "ba" ]`, `"subjectSelector": ["a"]` будет соответствовать `[ "a", "ab" ]`. > `probeUrl`: string @@ -26,8 +30,8 @@ URL-адрес, используемый для проверки состоян > `probeInterval`: string -Интервал между проверками. -Формат времени: число + единица измерения, например `"10s"`, `"2h45m"`. +Интервал между проверками. +Формат времени: число + единица измерения, например `"10s"`, `"2h45m"`. Поддерживаемые единицы измерения: `ns`, `us`, `ms`, `s`, `m`, `h` (наносекунды, микросекунды, миллисекунды, секунды, минуты, часы). > `enableConcurrency`: true | false @@ -37,16 +41,20 @@ URL-адрес, используемый для проверки состоян ## BurstObservatoryObject +`BurstObservatoryObject` соответствует элементу `burstObservatory` в файле конфигурации. + ```json { - "subjectSelector": ["outbound"], - "pingConfig": {} + "burstObservatory": { + "subjectSelector": ["outbound"], + "pingConfig": {} + } } ``` > `subjectSelector`: \[ string \] -Массив строк, каждый элемент которого будет использоваться для сопоставления с префиксом тега исходящего подключения. +Массив строк, каждый элемент которого будет использоваться для сопоставления с префиксом тега исходящего подключения. Например, для следующих тегов исходящих подключений: `[ "a", "ab", "c", "ba" ]`, `"subjectSelector": ["a"]` будет соответствовать `[ "a", "ab" ]`. > `pingConfig`: [PingConfigObject](#pingconfigobject) @@ -72,7 +80,7 @@ URL-адрес, используемый для проверки состоян > `connectivity`: string -URL-адрес, используемый для проверки подключения к локальной сети. +URL-адрес, используемый для проверки подключения к локальной сети. Пустая строка означает, что проверка подключения к локальной сети не выполняется. > `interval`: string diff --git a/docs/ru/config/outbounds/blackhole.md b/docs/ru/config/outbounds/blackhole.md index 696bb2a9..cd49bf5c 100644 --- a/docs/ru/config/outbounds/blackhole.md +++ b/docs/ru/config/outbounds/blackhole.md @@ -4,6 +4,8 @@ Blackhole - это протокол исходящих данных, котор ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/dns.md b/docs/ru/config/outbounds/dns.md index c44b84aa..82ac76b2 100644 --- a/docs/ru/config/outbounds/dns.md +++ b/docs/ru/config/outbounds/dns.md @@ -8,6 +8,8 @@ DNS — это исходящий протокол, который приним ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/freedom.md b/docs/ru/config/outbounds/freedom.md index a10d89bc..c2be679a 100644 --- a/docs/ru/config/outbounds/freedom.md +++ b/docs/ru/config/outbounds/freedom.md @@ -8,6 +8,8 @@ Freedom — это исходящий протокол, который можн ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/http.md b/docs/ru/config/outbounds/http.md index 51b1877a..0dddaf83 100644 --- a/docs/ru/config/outbounds/http.md +++ b/docs/ru/config/outbounds/http.md @@ -12,6 +12,8 @@ ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/hysteria.md b/docs/ru/config/outbounds/hysteria.md index c910e40d..ba72a610 100644 --- a/docs/ru/config/outbounds/hysteria.md +++ b/docs/ru/config/outbounds/hysteria.md @@ -10,6 +10,8 @@ ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/loopback.md b/docs/ru/config/outbounds/loopback.md index fa09d7af..efc7c29f 100644 --- a/docs/ru/config/outbounds/loopback.md +++ b/docs/ru/config/outbounds/loopback.md @@ -4,6 +4,8 @@ Loopback - это исходящий протокол данных, которы ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/shadowsocks.md b/docs/ru/config/outbounds/shadowsocks.md index 6b7bb5d0..28583e59 100644 --- a/docs/ru/config/outbounds/shadowsocks.md +++ b/docs/ru/config/outbounds/shadowsocks.md @@ -29,6 +29,8 @@ ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/socks.md b/docs/ru/config/outbounds/socks.md index 25dab2e0..f09553c7 100644 --- a/docs/ru/config/outbounds/socks.md +++ b/docs/ru/config/outbounds/socks.md @@ -8,6 +8,8 @@ ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/trojan.md b/docs/ru/config/outbounds/trojan.md index eae34d11..39040c0d 100644 --- a/docs/ru/config/outbounds/trojan.md +++ b/docs/ru/config/outbounds/trojan.md @@ -8,6 +8,8 @@ Trojan предназначен для работы в правильно нас ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/vless.md b/docs/ru/config/outbounds/vless.md index f0b3e0a0..335eef38 100644 --- a/docs/ru/config/outbounds/vless.md +++ b/docs/ru/config/outbounds/vless.md @@ -6,6 +6,8 @@ VLESS - это легкий транспортный протокол без с ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/vmess.md b/docs/ru/config/outbounds/vmess.md index 439e4def..80d91f97 100644 --- a/docs/ru/config/outbounds/vmess.md +++ b/docs/ru/config/outbounds/vmess.md @@ -8,6 +8,8 @@ VMess полагается на системное время. Убедитес ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/outbounds/wireguard.md b/docs/ru/config/outbounds/wireguard.md index 0e0d2d9d..db349f7b 100644 --- a/docs/ru/config/outbounds/wireguard.md +++ b/docs/ru/config/outbounds/wireguard.md @@ -8,6 +8,8 @@ ## OutboundConfigurationObject +`OutboundConfigurationObject` соответствует элементу `settings` в [`OutboundObject`](../outbound.md). + ```json { "outbounds": [ diff --git a/docs/ru/config/transport.md b/docs/ru/config/transport.md index 6452c216..02c0762f 100644 --- a/docs/ru/config/transport.md +++ b/docs/ru/config/transport.md @@ -7,7 +7,7 @@ ## StreamSettingsObject -`StreamSettingsObject` соответствует элементу `streamSettings` во входящем или исходящем подключении. Для каждого входящего или исходящего подключения можно настроить различные параметры передачи, и можно использовать `streamSettings` для настройки некоторых параметров передачи. +`StreamSettingsObject` соответствует элементу `streamSettings` в [`InboundObject`](./inbound.md) или [`OutboundObject`](./outbound.md). ```json { diff --git a/docs/ru/config/transports/grpc.md b/docs/ru/config/transports/grpc.md index 184d2db3..84ddeb2a 100644 --- a/docs/ru/config/transports/grpc.md +++ b/docs/ru/config/transports/grpc.md @@ -34,7 +34,7 @@ gRPC (HTTP/2) имеет встроенное мультиплексирован ## GRPCObject -`GRPCObject` соответствует элементу `grpcSettings` конфигурации передачи. +`GRPCObject` соответствует элементу `grpcSettings` в [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/ru/config/transports/httpupgrade.md b/docs/ru/config/transports/httpupgrade.md index 27839bea..a1509b27 100644 --- a/docs/ru/config/transports/httpupgrade.md +++ b/docs/ru/config/transports/httpupgrade.md @@ -10,7 +10,7 @@ ## HttpUpgradeObject -`HttpUpgradeObject` соответствует пункту `httpupgradeSettings` в настройках передачи. +`HttpUpgradeObject` соответствует элементу `httpupgradeSettings` в [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/ru/config/transports/hysteria.md b/docs/ru/config/transports/hysteria.md index 0e34d667..1314b0dc 100644 --- a/docs/ru/config/transports/hysteria.md +++ b/docs/ru/config/transports/hysteria.md @@ -4,7 +4,7 @@ ## HysteriaObject -`HysteriaObject` соответствует пункту `hysteriaSettings` в конфигурации транспорта. +`HysteriaObject` соответствует элементу `hysteriaSettings` в [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/ru/config/transports/mkcp.md b/docs/ru/config/transports/mkcp.md index 58f9a699..1a3302d9 100644 --- a/docs/ru/config/transports/mkcp.md +++ b/docs/ru/config/transports/mkcp.md @@ -10,7 +10,7 @@ mKCP жертвует пропускной способностью ради у ## KcpObject -`KcpObject` соответствует параметрам передачи `kcpSettings`. +`KcpObject` соответствует элементу `kcpSettings` в [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/ru/config/transports/raw.md b/docs/ru/config/transports/raw.md index 20da1fd2..87292aba 100644 --- a/docs/ru/config/transports/raw.md +++ b/docs/ru/config/transports/raw.md @@ -6,7 +6,7 @@ ## RawObject -`RawObject` соответствует элементу `rawSettings` в конфигурации транспорта. +`RawObject` соответствует элементу `rawSettings` в [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json { diff --git a/docs/ru/config/transports/websocket.md b/docs/ru/config/transports/websocket.md index 24bbbac1..d0fa19e7 100644 --- a/docs/ru/config/transports/websocket.md +++ b/docs/ru/config/transports/websocket.md @@ -14,7 +14,7 @@ WebSocket распознает заголовок X-Forwarded-For в HTTP-зап ## WebSocketObject -`WebSocketObject` соответствует элементу `wsSettings` в конфигурации транспорта. +`WebSocketObject` соответствует элементу `wsSettings` в [`StreamSettingsObject`](../transport.md#streamsettingsobject). ```json {