metacubexd/README.md

54 lines
650 B
Markdown
Raw Normal View History

2023-08-27 16:13:44 +08:00
# metacubexd
2023-08-24 04:20:53 +08:00
CF pages: https://metacubexd.pages.dev
GH pages: https://metacubex.github.io/metacubexd
2023-08-27 16:13:44 +08:00
Clash-Meta Dashboard
2023-08-24 04:20:53 +08:00
![preview](docs/preview.webp)
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
2023-09-01 17:45:40 +08:00
### Build locally
2023-08-27 16:13:44 +08:00
Install npm dependencies
2023-08-24 04:20:53 +08:00
2023-08-27 16:13:44 +08:00
```shell
pnpm install
```
2023-08-24 04:20:53 +08:00
2023-08-27 16:13:44 +08:00
Build artifacts
2023-08-24 04:20:53 +08:00
2023-08-27 16:13:44 +08:00
```shell
pnpm build
```
2023-08-24 04:20:53 +08:00
2023-08-27 16:13:44 +08:00
Serve static files
2023-08-24 04:20:53 +08:00
2023-08-27 16:13:44 +08:00
```shell
pnpm preview
```
2023-09-01 17:45:40 +08:00
### Run inside Docker
docker cli
```shell
docker run -d --restart always -p 80:80 --name metacubexd ghcr.io/metacubex/metacubexd
```
docker-compose.yml
```yaml
version: '3'
services:
metacubexd:
container_name: metacubexd
image: ghcr.io/metacubex/metacubexd
restart: always
ports:
- 80:80
```