From 1eea446e454d9cf72f391dd29960b508226ae44f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=96=E7=95=8C?= Date: Sun, 9 Apr 2023 15:44:19 +0800 Subject: [PATCH] documentation: Update external-ui download fields --- docs/configuration/experimental/index.md | 14 ++++++++++++++ docs/configuration/experimental/index.zh.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/docs/configuration/experimental/index.md b/docs/configuration/experimental/index.md index 63e3b464..81dde199 100644 --- a/docs/configuration/experimental/index.md +++ b/docs/configuration/experimental/index.md @@ -8,6 +8,8 @@ "clash_api": { "external_controller": "127.0.0.1:9090", "external_ui": "folder", + "external_ui_download_url": "", + "external_ui_download_detour": "", "secret": "", "default_mode": "rule", "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 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 for the RESTful API (optional) diff --git a/docs/configuration/experimental/index.zh.md b/docs/configuration/experimental/index.zh.md index 562cca0a..e6ca7a7b 100644 --- a/docs/configuration/experimental/index.zh.md +++ b/docs/configuration/experimental/index.zh.md @@ -8,6 +8,8 @@ "clash_api": { "external_controller": "127.0.0.1:9090", "external_ui": "folder", + "external_ui_download_url": "", + "external_ui_download_detour": "", "secret": "", "default_mode": "rule", "store_selected": false, @@ -51,6 +53,18 @@ RESTful web API 监听地址。如果为空,则禁用 Clash API。 到静态网页资源目录的相对路径或绝对路径。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 RESTful API 的密钥(可选)