Declare required fields in the documentation

This commit is contained in:
世界
2022-07-09 09:26:50 +08:00
parent 8fa953a516
commit 211d97ff8a
16 changed files with 107 additions and 6 deletions

View File

@@ -6,7 +6,7 @@
"servers": [],
"rules": [],
"final": "",
"strategy": "prefer_ipv6",
"strategy": "",
"disable_cache": false,
"disable_expire": false
}
@@ -23,7 +23,9 @@
#### final
Default dns server tag. the first server will be used if empty.
Default dns server tag.
The first server will be used if empty.
#### strategy

View File

@@ -140,4 +140,6 @@ Included default rules.
#### server
==Required==
Tag of the target dns server.

View File

@@ -25,6 +25,8 @@ The tag of the dns server.
#### address
==Required==
The address of the dns server.
| Protocol | Format |
@@ -41,6 +43,8 @@ The address of the dns server.
#### address_resolver
==Required if address contains domain==
Tag of a another server to resolve the domain name in the address.
#### address_strategy
@@ -55,4 +59,4 @@ One of `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
Tag of an outbound for connecting to the dns server.
Requests will be sent directly if the empty.
Default outbound will be used if empty.

View File

@@ -29,10 +29,14 @@
#### listen
==Required==
Listen address.
#### listen_port
==Required==
Listen port.
#### tcp_fast_open

View File

@@ -31,10 +31,14 @@
#### listen
==Required==
Listen address.
#### listen_port
==Required==
Listen port.
#### tcp_fast_open

View File

@@ -31,10 +31,14 @@
#### listen
==Required==
Listen address.
#### listen_port
==Required==
Listen port.
#### tcp_fast_open

View File

@@ -29,10 +29,14 @@
#### listen
==Required==
Listen address.
#### listen_port
==Required==
Listen port.
#### tcp_fast_open
@@ -75,6 +79,8 @@ Both if empty.
#### method
==Required==
| Method | Key Length |
|-------------------------------|------------|
| 2022-blake3-aes-128-gcm | 16 |
@@ -89,6 +95,8 @@ Both if empty.
#### password
==Required==
| Method | Password Format |
|---------------|-------------------------------------|
| none | / |

View File

@@ -31,10 +31,14 @@
#### listen
==Required==
Listen address.
#### listen_port
==Required==
Listen port.
#### tcp_fast_open

View File

@@ -31,10 +31,14 @@
#### server
==Required==
The server address.
#### server_port
==Required==
The server port.
#### username

View File

@@ -32,14 +32,20 @@
#### server
==Required==
The server address.
#### server_port
==Required==
The server port.
#### method
==Required==
Encryption methods:
* `2022-blake3-aes-128-gcm`
@@ -66,6 +72,8 @@ Legacy encryption methods:
#### password
==Required==
The shadowsocks password.
#### network

View File

@@ -33,10 +33,14 @@
#### server
==Required==
The server address.
#### server_port
==Required==
The server port.
#### version