mirror of
https://github.com/telemt/telemt.git
synced 2026-04-14 17:14:09 +03:00
Fixed server.listeners and upstreams description
This commit is contained in:
@@ -2106,7 +2106,7 @@ Note: This section also accepts the legacy alias `[server.admin_api]` (same sche
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[server.listeners]
|
[[server.listeners]]
|
||||||
ip = "0.0.0.0"
|
ip = "0.0.0.0"
|
||||||
```
|
```
|
||||||
## announce
|
## announce
|
||||||
@@ -2115,7 +2115,7 @@ Note: This section also accepts the legacy alias `[server.admin_api]` (same sche
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[server.listeners]
|
[[server.listeners]]
|
||||||
ip = "0.0.0.0"
|
ip = "0.0.0.0"
|
||||||
announce = "proxy.example.com"
|
announce = "proxy.example.com"
|
||||||
```
|
```
|
||||||
@@ -2125,7 +2125,7 @@ Note: This section also accepts the legacy alias `[server.admin_api]` (same sche
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[server.listeners]
|
[[server.listeners]]
|
||||||
ip = "0.0.0.0"
|
ip = "0.0.0.0"
|
||||||
announce_ip = "203.0.113.10"
|
announce_ip = "203.0.113.10"
|
||||||
```
|
```
|
||||||
@@ -2138,7 +2138,7 @@ Note: This section also accepts the legacy alias `[server.admin_api]` (same sche
|
|||||||
[server]
|
[server]
|
||||||
proxy_protocol = false
|
proxy_protocol = false
|
||||||
|
|
||||||
[server.listeners]
|
[[server.listeners]]
|
||||||
ip = "0.0.0.0"
|
ip = "0.0.0.0"
|
||||||
proxy_protocol = true
|
proxy_protocol = true
|
||||||
```
|
```
|
||||||
@@ -2149,7 +2149,7 @@ Note: This section also accepts the legacy alias `[server.admin_api]` (same sche
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[server.listeners]
|
[[server.listeners]]
|
||||||
ip = "0.0.0.0"
|
ip = "0.0.0.0"
|
||||||
reuse_allow = false
|
reuse_allow = false
|
||||||
```
|
```
|
||||||
@@ -2907,7 +2907,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
# [upstreams]
|
# [[upstreams]]
|
||||||
|
|
||||||
|
|
||||||
| Key | Type | Default |
|
| Key | Type | Default |
|
||||||
@@ -2926,18 +2926,18 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
|
|
||||||
## type
|
## type
|
||||||
- **Constraints / validation**: Required field. Must be one of: `"direct"`, `"socks4"`, `"socks5"`, `"shadowsocks"`.
|
- **Constraints / validation**: Required field. Must be one of: `"direct"`, `"socks4"`, `"socks5"`, `"shadowsocks"`.
|
||||||
- **Description**: Selects the upstream transport implementation for this `[upstreams]` entry.
|
- **Description**: Selects the upstream transport implementation for this `[[upstreams]]` entry.
|
||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "direct"
|
type = "direct"
|
||||||
|
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "127.0.0.1:9050"
|
address = "127.0.0.1:9050"
|
||||||
|
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "shadowsocks"
|
type = "shadowsocks"
|
||||||
url = "ss://2022-blake3-aes-256-gcm:BASE64PASSWORD@127.0.0.1:8388"
|
url = "ss://2022-blake3-aes-256-gcm:BASE64PASSWORD@127.0.0.1:8388"
|
||||||
```
|
```
|
||||||
@@ -2947,7 +2947,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "direct"
|
type = "direct"
|
||||||
weight = 10
|
weight = 10
|
||||||
```
|
```
|
||||||
@@ -2957,7 +2957,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "127.0.0.1:9050"
|
address = "127.0.0.1:9050"
|
||||||
enabled = false
|
enabled = false
|
||||||
@@ -2968,7 +2968,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks4"
|
type = "socks4"
|
||||||
address = "10.0.0.10:1080"
|
address = "10.0.0.10:1080"
|
||||||
scopes = "me, fetch, dc2"
|
scopes = "me, fetch, dc2"
|
||||||
@@ -2982,11 +2982,11 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "direct"
|
type = "direct"
|
||||||
interface = "eth0"
|
interface = "eth0"
|
||||||
|
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "203.0.113.10:1080"
|
address = "203.0.113.10:1080"
|
||||||
interface = "192.0.2.10" # explicit local bind IP
|
interface = "192.0.2.10" # explicit local bind IP
|
||||||
@@ -2999,7 +2999,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "direct"
|
type = "direct"
|
||||||
bind_addresses = ["192.0.2.10", "192.0.2.11"]
|
bind_addresses = ["192.0.2.10", "192.0.2.11"]
|
||||||
```
|
```
|
||||||
@@ -3015,7 +3015,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
[general]
|
[general]
|
||||||
use_middle_proxy = false
|
use_middle_proxy = false
|
||||||
|
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "shadowsocks"
|
type = "shadowsocks"
|
||||||
url = "ss://2022-blake3-aes-256-gcm:BASE64PASSWORD@127.0.0.1:8388"
|
url = "ss://2022-blake3-aes-256-gcm:BASE64PASSWORD@127.0.0.1:8388"
|
||||||
```
|
```
|
||||||
@@ -3025,7 +3025,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "127.0.0.1:9050"
|
address = "127.0.0.1:9050"
|
||||||
```
|
```
|
||||||
@@ -3035,7 +3035,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks4"
|
type = "socks4"
|
||||||
address = "127.0.0.1:1080"
|
address = "127.0.0.1:1080"
|
||||||
user_id = "telemt"
|
user_id = "telemt"
|
||||||
@@ -3046,7 +3046,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "127.0.0.1:9050"
|
address = "127.0.0.1:9050"
|
||||||
username = "alice"
|
username = "alice"
|
||||||
@@ -3057,7 +3057,7 @@ If your backend or network is very bandwidth-constrained, reduce cap first. If p
|
|||||||
- **Example**:
|
- **Example**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "127.0.0.1:9050"
|
address = "127.0.0.1:9050"
|
||||||
username = "alice"
|
username = "alice"
|
||||||
|
|||||||
@@ -2112,7 +2112,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[server.listeners]
|
[[server.listeners]]
|
||||||
ip = "0.0.0.0"
|
ip = "0.0.0.0"
|
||||||
```
|
```
|
||||||
## announce
|
## announce
|
||||||
@@ -2121,7 +2121,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[server.listeners]
|
[[server.listeners]]
|
||||||
ip = "0.0.0.0"
|
ip = "0.0.0.0"
|
||||||
announce = "proxy.example.com"
|
announce = "proxy.example.com"
|
||||||
```
|
```
|
||||||
@@ -2131,7 +2131,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[server.listeners]
|
[[server.listeners]]
|
||||||
ip = "0.0.0.0"
|
ip = "0.0.0.0"
|
||||||
announce_ip = "203.0.113.10"
|
announce_ip = "203.0.113.10"
|
||||||
```
|
```
|
||||||
@@ -2144,7 +2144,7 @@
|
|||||||
[server]
|
[server]
|
||||||
proxy_protocol = false
|
proxy_protocol = false
|
||||||
|
|
||||||
[server.listeners]
|
[[server.listeners]]
|
||||||
ip = "0.0.0.0"
|
ip = "0.0.0.0"
|
||||||
proxy_protocol = true
|
proxy_protocol = true
|
||||||
```
|
```
|
||||||
@@ -2155,7 +2155,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[server.listeners]
|
[[server.listeners]]
|
||||||
ip = "0.0.0.0"
|
ip = "0.0.0.0"
|
||||||
reuse_allow = false
|
reuse_allow = false
|
||||||
```
|
```
|
||||||
@@ -2912,7 +2912,7 @@
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
# [upstreams]
|
# [[upstreams]]
|
||||||
|
|
||||||
|
|
||||||
| Ключ | Тип | По умолчанию |
|
| Ключ | Тип | По умолчанию |
|
||||||
@@ -2931,18 +2931,18 @@
|
|||||||
|
|
||||||
## type
|
## type
|
||||||
- **Ограничения / валидация**: Обязательный параметр.`"direct"`, `"socks4"`, `"socks5"`, `"shadowsocks"`.
|
- **Ограничения / валидация**: Обязательный параметр.`"direct"`, `"socks4"`, `"socks5"`, `"shadowsocks"`.
|
||||||
- **Описание**: Выбирает реализацию upstream-транспорта для этой записи в `[upstreams]`.
|
- **Описание**: Выбирает реализацию upstream-транспорта для этой записи в `[[upstreams]]`.
|
||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "direct"
|
type = "direct"
|
||||||
|
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "127.0.0.1:9050"
|
address = "127.0.0.1:9050"
|
||||||
|
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "shadowsocks"
|
type = "shadowsocks"
|
||||||
url = "ss://2022-blake3-aes-256-gcm:BASE64PASSWORD@127.0.0.1:8388"
|
url = "ss://2022-blake3-aes-256-gcm:BASE64PASSWORD@127.0.0.1:8388"
|
||||||
```
|
```
|
||||||
@@ -2952,7 +2952,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "direct"
|
type = "direct"
|
||||||
weight = 10
|
weight = 10
|
||||||
```
|
```
|
||||||
@@ -2962,7 +2962,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "127.0.0.1:9050"
|
address = "127.0.0.1:9050"
|
||||||
enabled = false
|
enabled = false
|
||||||
@@ -2973,7 +2973,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks4"
|
type = "socks4"
|
||||||
address = "10.0.0.10:1080"
|
address = "10.0.0.10:1080"
|
||||||
scopes = "me, fetch, dc2"
|
scopes = "me, fetch, dc2"
|
||||||
@@ -2987,11 +2987,11 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "direct"
|
type = "direct"
|
||||||
interface = "eth0"
|
interface = "eth0"
|
||||||
|
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "203.0.113.10:1080"
|
address = "203.0.113.10:1080"
|
||||||
interface = "192.0.2.10" # explicit local bind IP
|
interface = "192.0.2.10" # explicit local bind IP
|
||||||
@@ -3004,7 +3004,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "direct"
|
type = "direct"
|
||||||
bind_addresses = ["192.0.2.10", "192.0.2.11"]
|
bind_addresses = ["192.0.2.10", "192.0.2.11"]
|
||||||
```
|
```
|
||||||
@@ -3020,7 +3020,7 @@
|
|||||||
[general]
|
[general]
|
||||||
use_middle_proxy = false
|
use_middle_proxy = false
|
||||||
|
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "shadowsocks"
|
type = "shadowsocks"
|
||||||
url = "ss://2022-blake3-aes-256-gcm:BASE64PASSWORD@127.0.0.1:8388"
|
url = "ss://2022-blake3-aes-256-gcm:BASE64PASSWORD@127.0.0.1:8388"
|
||||||
```
|
```
|
||||||
@@ -3030,7 +3030,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "127.0.0.1:9050"
|
address = "127.0.0.1:9050"
|
||||||
```
|
```
|
||||||
@@ -3040,7 +3040,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks4"
|
type = "socks4"
|
||||||
address = "127.0.0.1:1080"
|
address = "127.0.0.1:1080"
|
||||||
user_id = "telemt"
|
user_id = "telemt"
|
||||||
@@ -3051,7 +3051,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "127.0.0.1:9050"
|
address = "127.0.0.1:9050"
|
||||||
username = "alice"
|
username = "alice"
|
||||||
@@ -3062,7 +3062,7 @@
|
|||||||
- **Пример**:
|
- **Пример**:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[upstreams]
|
[[upstreams]]
|
||||||
type = "socks5"
|
type = "socks5"
|
||||||
address = "127.0.0.1:9050"
|
address = "127.0.0.1:9050"
|
||||||
username = "alice"
|
username = "alice"
|
||||||
|
|||||||
Reference in New Issue
Block a user