From 9927f3de7f5f6215e9cefbed016463e46e4969db Mon Sep 17 00:00:00 2001 From: kunish Date: Tue, 5 Sep 2023 18:16:18 +0800 Subject: [PATCH] docs: add descriptions for gh-pages Signed-off-by: kunish --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cfad944..8f4407b 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,32 @@ Cloudflare Pages: https://metacubexd.pages.dev ## Usage +### Enable external-controller in your config file + +```yaml +external-controller: 0.0.0.0:9090 +``` + +### Use pre-built assets from gh-pages branch + +> First time setup + +```shell +git clone https://github.com/metacubex/metacubexd.git -b gh-pages /etc/clash-meta/ui +``` + +Make sure you have external-ui directory set correctly in your config file + +> Update + +```shell +git -C /etc/clash-meta/ui pull +``` + +```yaml +external-ui: /etc/clash-meta/ui +``` + ### Run inside Docker > docker cli @@ -35,7 +61,7 @@ Running docker run -d --restart always -p 80:80 --name metacubexd ghcr.io/metacubex/metacubexd ``` -Update and restart +Update and Restart ```shell docker pull ghcr.io/metacubex/metacubexd && docker restart metacubexd @@ -72,7 +98,7 @@ Running docker compose up -d ``` -Update and restart +Update and Restart ```shell docker compose pull && docker compose up -d