mirror of https://github.com/MetaCubeX/metacubexd.git synced 2024-09-20 01:52:47 +08:00

mirror

Go to file

kunish 9927f3de7f docs: add descriptions for gh-pages Signed-off-by: kunish <kunish.butt@gmail.com>		2023-09-05 18:17:37 +08:00
.github	fix: build issue, `Cannot redefine property: File`	2023-09-05 14:15:05 +08:00
.husky	docs: add MIT license	2023-08-28 00:13:00 +08:00
.vscode	feat(proxies): sortProxiesByOrderingType	2023-09-03 05:40:49 +08:00
docs	docs: update preview image	2023-09-03 18:38:53 +08:00
src	feat: a stable table	2023-09-05 17:02:43 +08:00
.commitlintrc.yml	docs: add MIT license	2023-08-28 00:13:00 +08:00
.dockerignore	feat: publish docker image	2023-08-30 00:40:47 +08:00
.eslintrc.yml	chore(eslint): remove extends prettier rules for now	2023-09-05 02:18:57 +08:00
.gitignore	refactor: skipLibCheck	2023-09-03 20:31:13 +08:00
.lintstagedrc.yml	chore: add eslint to enforce code quality	2023-09-03 15:30:56 +08:00
.prettierrc	chore: add prettier-plugin-organize-imports	2023-08-28 22:36:38 +08:00
Caddyfile	feat: publish docker image	2023-08-30 00:40:47 +08:00
CHANGELOG.md	chore(main): release 1.67.5 (#137 )	2023-09-05 14:16:06 +08:00
Dockerfile	build(docker): declare EXPOSE	2023-09-01 17:46:55 +08:00
index.html	feat: add safe area paddings	2023-09-05 02:15:37 +08:00
LICENSE	docs: add MIT license	2023-08-28 00:13:00 +08:00
package.json	refactor: use window size	2023-09-05 16:25:10 +08:00
pnpm-lock.yaml	refactor: use window size	2023-09-05 16:25:10 +08:00
postcss.config.js	chore: initial commit	2023-08-27 15:34:12 +08:00
README.md	docs: add descriptions for gh-pages	2023-09-05 18:17:37 +08:00
tailwind.config.ts	fix: better toggle twemoji implementation	2023-09-05 12:18:32 +08:00
tsconfig.json	refactor: skipLibCheck	2023-09-03 20:31:13 +08:00
vite.config.ts	feat: display current version	2023-09-03 18:16:09 +08:00

README.md

metacubexd

Clash-Meta Dashboard

Preview

Published Official Links

GH Pages Custom Domain: http://d.metacubex.one

GH Pages: https://metacubex.github.io/metacubexd

Cloudflare Pages: https://metacubexd.pages.dev

Usage

Enable external-controller in your config file

external-controller: 0.0.0.0:9090

Use pre-built assets from gh-pages branch

First time setup

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

git -C /etc/clash-meta/ui pull

external-ui: /etc/clash-meta/ui

Run inside Docker

docker cli

Running

docker run -d --restart always -p 80:80 --name metacubexd ghcr.io/metacubex/metacubexd

Update and Restart

docker pull ghcr.io/metacubex/metacubexd && docker restart metacubexd

docker-compose.yml

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

Running

docker compose up -d

Update and Restart

docker compose pull && docker compose up -d

Build locally

Install npm dependencies

pnpm install

Build artifacts

pnpm build

Serve static files

pnpm serve