documentation: Update external-ui download fields

This commit is contained in:
世界 2023-04-09 15:44:19 +08:00
parent 19c6241e10
commit 1eea446e45
No known key found for this signature in database
GPG key ID: CD109927C34A63C4
2 changed files with 28 additions and 0 deletions

View file

@ -8,6 +8,8 @@
"clash_api": { "clash_api": {
"external_controller": "127.0.0.1:9090", "external_controller": "127.0.0.1:9090",
"external_ui": "folder", "external_ui": "folder",
"external_ui_download_url": "",
"external_ui_download_detour": "",
"secret": "", "secret": "",
"default_mode": "rule", "default_mode": "rule",
"store_selected": false, "store_selected": false,
@ -53,6 +55,18 @@ A relative path to the configuration directory or an absolute path to a
directory in which you put some static web resource. sing-box will then directory in which you put some static web resource. sing-box will then
serve it at `http://{{external-controller}}/ui`. serve it at `http://{{external-controller}}/ui`.
#### external_ui_download_url
ZIP download URL for the external UI, will be used if the specified `external_ui` directory is empty.
`https://github.com/Dreamacro/clash-dashboard/archive/refs/heads/gh-pages.zip` will be used if empty.
#### external_ui_download_detour
The tag of the outbound to download the external UI.
Default outbound will be used if empty.
#### secret #### secret
Secret for the RESTful API (optional) Secret for the RESTful API (optional)

View file

@ -8,6 +8,8 @@
"clash_api": { "clash_api": {
"external_controller": "127.0.0.1:9090", "external_controller": "127.0.0.1:9090",
"external_ui": "folder", "external_ui": "folder",
"external_ui_download_url": "",
"external_ui_download_detour": "",
"secret": "", "secret": "",
"default_mode": "rule", "default_mode": "rule",
"store_selected": false, "store_selected": false,
@ -51,6 +53,18 @@ RESTful web API 监听地址。如果为空,则禁用 Clash API。
到静态网页资源目录的相对路径或绝对路径。sing-box 会在 `http://{{external-controller}}/ui` 下提供它。 到静态网页资源目录的相对路径或绝对路径。sing-box 会在 `http://{{external-controller}}/ui` 下提供它。
#### external_ui_download_url
静态网页资源的 ZIP 下载 URL如果指定的 `external_ui` 目录为空,将使用。
默认使用 `https://github.com/Dreamacro/clash-dashboard/archive/refs/heads/gh-pages.zip`
#### external_ui_download_detour
用于下载静态网页资源的出站的标签。
如果为空,将使用默认出站。
#### secret #### secret
RESTful API 的密钥(可选) RESTful API 的密钥(可选)