Public-Mirror/metacubexd
1
0
Fork 0
mirror of https://github.com/MetaCubeX/metacubexd.git synced 2024-12-26 07:24:10 +08:00
Code Issues Projects Releases Wiki Activity

docs: add descriptions for gh-pages

Browse Source 
Signed-off-by: kunish <kunish.butt@gmail.com>
This commit is contained in:
kunish 2023-09-05 18:16:18 +08:00
parent e19e53d0f6
commit 9927f3de7f
No known key found for this signature in database
GPG Key ID: 647A12B4F782C430
1 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -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