Skip to content

Commit 26adcd0

Browse files
nekohasekainekohasekai
committed
Update documentation
1 parent 1108800 commit 26adcd0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+765
-386
lines changed

‎docs/changelog.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
icon: material/alert-decagram
33
---
44

5-
# ChangeLog
6-
7-
#### 1.8.0-alpha.9
5+
#### 1.8.0-alpha.10
86

97
* Add `idle_timeout` for URLTest outbound **1**
108
* Fixes and improvements

‎docs/configuration/dns/rule.zh.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -181,15 +181,15 @@ DNS 查询类型。值可以为整数或者类型名称字符串。
181181

182182
!!! failure "已在 sing-box 1.8.0 废弃"
183183

184-
Geosite 已废弃且可能在不久的将来移除，参阅 [迁移指南](/migration/#migrate-geosite-to-rule-sets)。
184+
Geosite 已废弃且可能在不久的将来移除，参阅 [迁移指南](/zh/migration/#geosite)。
185185

186186
匹配 Geosite。
187187

188188
#### source_geoip
189189

190190
!!! failure "已在 sing-box 1.8.0 废弃"
191191

192-
GeoIp 已废弃且可能在不久的将来移除，参阅 [迁移指南](/migration/#migrate-geoip-to-rule-sets)。
192+
GeoIP 已废弃且可能在不久的将来移除，参阅 [迁移指南](/zh/migration/#geoip)。
193193

194194
匹配源 GeoIP。
195195

‎docs/configuration/dns/server.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -45,20 +45,12 @@ The address of the dns server.
4545

4646
!!! warning ""
4747

48-
To ensure that system DNS is in effect, rather than Go's built-in default resolver, enable CGO at compile time.
49-
50-
!!! warning ""
51-
52-
QUIC and HTTP3 transport is not included by default, see [Installation](./#installation).
48+
To ensure that Android system DNS is in effect, rather than Go's built-in default resolver, enable CGO at compile time.
5349

5450
!!! info ""
5551

5652
the RCode transport is often used to block queries. Use with rules and the `disable_cache` rule option.
5753

58-
!!! warning ""
59-
60-
DHCP transport is not included by default, see [Installation](./#installation).
61-
6254
| RCode | Description |
6355
|-------------------|-----------------------|
6456
| `success` | `No error` |

‎docs/configuration/dns/server.zh.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -45,20 +45,12 @@ DNS 服务器的地址。
4545

4646
!!! warning ""
4747

48-
为了确保系统 DNS 生效，而不是 Go 的内置默认解析器，请在编译时启用 CGO。
49-
50-
!!! warning ""
51-
52-
默认安装不包含 QUIC 和 HTTP3 传输层，请参阅 [安装](/zh/#_2)。
48+
为了确保 Android 系统 DNS 生效，而不是 Go 的内置默认解析器，请在编译时启用 CGO。
5349

5450
!!! info ""
5551

5652
RCode 传输层传输层常用于屏蔽请求. 与 DNS 规则和 `disable_cache` 规则选项一起使用。
5753

58-
!!! warning ""
59-
60-
默认安装不包含 DHCP 传输层，请参阅 [安装](/zh/#_2)。
61-
6254
| RCode | 描述 |
6355
|-------------------|----------|
6456
| `success` | `无错误` |

‎docs/configuration/experimental/cache-file.zh.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
icon: material/new-box
3+
---
4+
5+
!!! question "自 sing-box 1.8.0 起"
6+
7+
### 结构
8+
9+
```json
10+
{
11+
"enabled": true,
12+
"path": "",
13+
"cache_id": "",
14+
"store_fakeip": false
15+
}
16+
```
17+
18+
### 字段
19+
20+
#### enabled
21+
22+
启用缓存文件。
23+
24+
#### path
25+
26+
缓存文件路径，默认使用`cache.db`。
27+
28+
#### cache_id
29+
30+
缓存文件中的标识符。
31+
32+
如果不为空，配置特定的数据将使用由其键控的单独存储。

‎docs/configuration/experimental/clash-api.md

+1-8
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@ icon: material/alert-decagram
1010
:material-delete-alert: [cache_file](#cache_file)
1111
:material-delete-alert: [cache_id](#cache_id)
1212

13-
14-
!!! quote ""
15-
16-
Clash API is not included by default, see [Installation](./#installation).
17-
1813
### Structure
1914

2015
```json
@@ -48,8 +43,6 @@ A relative path to the configuration directory or an absolute path to a
4843
directory in which you put some static web resource. sing-box will then
4944
serve it at `http://{{external-controller}}/ui`.
5045

51-
52-
5346
#### external_ui_download_url
5447

5548
ZIP download URL for the external UI, will be used if the specified `external_ui` directory is empty.
@@ -118,4 +111,4 @@ Cache file path, `cache.db` will be used if empty.
118111

119112
Identifier in cache file.
120113

121-
If not empty, configuration specified data will use a separate store keyed by it.
114+
If not empty, configuration specified data will use a separate store keyed by it.

‎docs/configuration/experimental/clash-api.zh.md

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
icon: material/alert-decagram
3+
---
4+
5+
!!! quote "sing-box 1.8.0 中的更改"
6+
7+
:material-delete-alert: [store_mode](#store_mode)
8+
:material-delete-alert: [store_selected](#store_selected)
9+
:material-delete-alert: [store_fakeip](#store_fakeip)
10+
:material-delete-alert: [cache_file](#cache_file)
11+
:material-delete-alert: [cache_id](#cache_id)
12+
13+
### 结构
14+
15+
```json
16+
{
17+
"external_controller": "127.0.0.1:9090",
18+
"external_ui": "",
19+
"external_ui_download_url": "",
20+
"external_ui_download_detour": "",
21+
"secret": "",
22+
"default_mode": "",
23+
24+
// Deprecated
25+
26+
"store_mode": false,
27+
"store_selected": false,
28+
"store_fakeip": false,
29+
"cache_file": "",
30+
"cache_id": ""
31+
}
32+
```
33+
34+
### Fields
35+
36+
#### external_controller
37+
38+
RESTful web API 监听地址。如果为空，则禁用 Clash API。
39+
40+
#### external_ui
41+
42+
到静态网页资源目录的相对路径或绝对路径。sing-box 会在 `http://{{external-controller}}/ui` 下提供它。
43+
44+
#### external_ui_download_url
45+
46+
静态网页资源的 ZIP 下载 URL，如果指定的 `external_ui` 目录为空，将使用。
47+
48+
默认使用 `https://github.com/MetaCubeX/Yacd-meta/archive/gh-pages.zip`。
49+
50+
#### external_ui_download_detour
51+
52+
用于下载静态网页资源的出站的标签。
53+
54+
如果为空，将使用默认出站。
55+
56+
#### secret
57+
58+
RESTful API 的密钥（可选）
59+
通过指定 HTTP 标头 `Authorization: Bearer ${secret}` 进行身份验证
60+
如果 RESTful API 正在监听 0.0.0.0，请始终设置一个密钥。
61+
62+
#### default_mode
63+
64+
Clash 中的默认模式，默认使用 `Rule`。
65+
66+
此设置没有直接影响，但可以通过 `clash_mode` 规则项在路由和 DNS 规则中使用。
67+
68+
#### store_mode
69+
70+
!!! failure "已在 sing-box 1.8.0 废弃"
71+
72+
`store_mode` 已在 Clash API 中废弃，且默认启用当 `cache_file.enabled`。
73+
74+
将 Clash 模式存储在缓存文件中。
75+
76+
#### store_selected
77+
78+
!!! failure "已在 sing-box 1.8.0 废弃"
79+
80+
`store_selected` 已在 Clash API 中废弃，且默认启用当 `cache_file.enabled`。
81+
82+
!!! note ""
83+
84+
必须为目标出站设置标签。
85+
86+
将 `Selector` 中出站的选定的目标出站存储在缓存文件中。
87+
88+
#### store_fakeip
89+
90+
!!! failure "已在 sing-box 1.8.0 废弃"
91+
92+
`store_selected` 已在 Clash API 中废弃，且已迁移到 `cache_file.store_fakeip`。
93+
94+
将 fakeip 存储在缓存文件中。
95+
96+
#### cache_file
97+
98+
!!! failure "已在 sing-box 1.8.0 废弃"
99+
100+
`cache_file` 已在 Clash API 中废弃，且已迁移到 `cache_file.enabled` 和 `cache_file.path`。
101+
102+
缓存文件路径，默认使用`cache.db`。
103+
104+
#### cache_id
105+
106+
!!! failure "已在 sing-box 1.8.0 废弃"
107+
108+
`cache_id` 已在 Clash API 中废弃，且已迁移到 `cache_file.cache_id`。
109+
110+
缓存 ID。
111+
112+
如果不为空，配置特定的数据将使用由其键控的单独存储。

‎docs/configuration/experimental/index.zh.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
icon: material/alert-decagram
3+
---
4+
5+
# 实验性
6+
7+
!!! quote "sing-box 1.8.0 中的更改"
8+
9+
:material-plus: [cache_file](#cache_file)
10+
:material-alert-decagram: [clash_api](#clash_api)
11+
12+
### 结构
13+
14+
```json
15+
{
16+
"experimental": {
17+
"cache_file": {},
18+
"clash_api": {},
19+
"v2ray_api": {}
20+
}
21+
}
22+
```
23+
24+
### 字段
25+
26+
| 键 | 格式 |
27+
|--------------|--------------------------|
28+
| `cache_file` | [缓存文件](./cache-file) |
29+
| `clash_api` | [Clash API](./clash-api) |
30+
| `v2ray_api` | [V2Ray API](./v2ray-api) |

‎docs/configuration/experimental/v2ray-api.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
### Structure
2-
31
!!! quote ""
42

5-
V2Ray API is not included by default, see [Installation](./#installation).
3+
V2Ray API is not included by default, see [Installation](/installation/build-from-source/#build-tags).
4+
5+
### Structure
66

77
```json
88
{

‎docs/configuration/experimental/v2ray-api.zh.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
!!! quote ""
2+
3+
默认安装不包含 V2Ray API，参阅 [安装](/zh/installation/build-from-source/#_5)。
4+
5+
### 结构
6+
7+
```json
8+
{
9+
"listen": "127.0.0.1:8080",
10+
"stats": {
11+
"enabled": true,
12+
"inbounds": [
13+
"socks-in"
14+
],
15+
"outbounds": [
16+
"proxy",
17+
"direct"
18+
],
19+
"users": [
20+
"sekai"
21+
]
22+
}
23+
}
24+
```
25+
26+
### 字段
27+
28+
#### listen
29+
30+
gRPC API 监听地址。如果为空，则禁用 V2Ray API。
31+
32+
#### stats
33+
34+
流量统计服务设置。
35+
36+
#### stats.enabled
37+
38+
启用统计服务。
39+
40+
#### stats.inbounds
41+
42+
统计流量的入站列表。
43+
44+
#### stats.outbounds
45+
46+
统计流量的出站列表。
47+
48+
#### stats.users
49+
50+
统计流量的用户列表。

‎docs/configuration/inbound/hysteria.md

-4
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@
2929
}
3030
```
3131

32-
!!! warning ""
33-
34-
QUIC, which is required by hysteria is not included by default, see [Installation](./#installation).
35-
3632
### Listen Fields
3733

3834
See [Listen Fields](/configuration/shared/listen) for details.

‎docs/configuration/inbound/hysteria.zh.md

-4
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@
2929
}
3030
```
3131

32-
!!! warning ""
33-
34-
默认安装不包含被 Hysteria 依赖的 QUIC，参阅 [安装](/zh/#_2)。
35-
3632
### 监听字段
3733

3834
参阅 [监听字段](/zh/configuration/shared/listen/)。

‎docs/configuration/inbound/hysteria2.md

-4
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,6 @@
2626
}
2727
```
2828

29-
!!! warning ""
30-
31-
QUIC, which is required by Hysteria2 is not included by default, see [Installation](./#installation).
32-
3329
!!! warning "Difference from official Hysteria2"
3430

3531
The official program supports an authentication method called **userpass**,

‎docs/configuration/inbound/hysteria2.zh.md

-4
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,6 @@
2626
}
2727
```
2828

29-
!!! warning ""
30-
31-
默认安装不包含被 Hysteria2 依赖的 QUIC，参阅 [安装](/zh/#_2)。
32-
3329
!!! warning "与官方 Hysteria2 的区别"
3430

3531
官方程序支持一种名为 **userpass** 的验证方式，

‎docs/configuration/inbound/naive.md

-4
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@
1818
}
1919
```
2020

21-
!!! warning ""
22-
23-
HTTP3 transport is not included by default, see [Installation](./#installation).
24-
2521
### Listen Fields
2622

2723
See [Listen Fields](/configuration/shared/listen) for details.

0 commit comments

Comments
 (0)