metacubexd/README.md

126 lines
2.5 KiB
Markdown
Raw Normal View History

2023-08-27 16:13:44 +08:00
# metacubexd
2023-08-24 04:20:53 +08:00
2023-09-03 06:46:37 +08:00
<p align="center">
<img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fmetacubex%2Fmetacubexd&count_bg=%235C3DC8&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false" alt="hits" />
<img src="https://custom-icon-badges.herokuapp.com/github/issues-pr-closed/metacubex/metacubexd?color=purple&logo=git-pull-request&logoColor=white" alt="pr/issue" />
<img src="https://custom-icon-badges.herokuapp.com/github/last-commit/metacubex/metacubexd?logo=history&logoColor=white" alt="lastcommit" />
<img src="https://github.com/metacubex/metacubexd/actions/workflows/release.yml/badge.svg" alt="build-status" />
<img src="https://custom-icon-badges.herokuapp.com/github/v/release/metacubex/metacubexd?logo=rocket" alt="version">
<img src="https://custom-icon-badges.herokuapp.com/github/license/metacubex/metacubexd?logo=law&color=orange" alt="license" />
</p>
<p align="center">Clash-Meta Dashboard</p>
2023-09-03 16:53:39 +08:00
## Preview
![preview](docs/preview.webp)
2023-09-02 01:23:42 +08:00
## Published Official Links
2023-09-02 01:23:42 +08:00
GH Pages Custom Domain: http://d.metacubex.one
GH Pages: https://metacubex.github.io/metacubexd
Cloudflare Pages: https://metacubexd.pages.dev
2023-08-24 04:20:53 +08:00
2023-08-27 16:13:44 +08:00
## Usage
2023-08-24 04:20:53 +08:00
### 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
2023-09-05 18:19:32 +08:00
```yaml
external-ui: /etc/clash-meta/ui
```
> Update
```shell
git -C /etc/clash-meta/ui pull
```
### Run inside Docker
2023-08-24 04:20:53 +08:00
> docker cli
2023-08-24 04:20:53 +08:00
Running
2023-08-24 04:20:53 +08:00
2023-08-27 16:13:44 +08:00
```shell
docker run -d --restart always -p 80:80 --name metacubexd ghcr.io/metacubex/metacubexd
2023-08-27 16:13:44 +08:00
```
2023-09-01 17:45:40 +08:00
Update and Restart
2023-09-01 17:45:40 +08:00
```shell
docker pull ghcr.io/metacubex/metacubexd && docker restart metacubexd
2023-09-01 17:45:40 +08:00
```
> docker-compose.yml
2023-09-01 17:45:40 +08:00
```yaml
version: '3'
services:
metacubexd:
container_name: metacubexd
image: ghcr.io/metacubex/metacubexd
restart: always
ports:
- '80:80'
# optional
meta:
container_name: meta
image: docker.io/metacubex/clash-meta:Alpha
restart: always
network_mode: host
cap_add:
- NET_ADMIN
volumes:
- ./config.yaml:/root/.config/clash
2023-09-01 17:45:40 +08:00
```
Running
```shell
docker compose up -d
```
Update and Restart
```shell
docker compose pull && docker compose up -d
```
### Build locally
> Install npm dependencies
```shell
pnpm install
```
> Build artifacts
```shell
pnpm build
```
> Serve static files
```shell
pnpm serve
```