mirror of https://github.com/MetaCubeX/metacubexd.git synced 2024-11-10 05:15:35 +08:00

mirror

Go to file

dependabot[bot] e582d64f43 chore(deps): bump zod from 3.22.3 to 3.22.4 (#342 )		2023-10-04 20:24:49 -05:00
.github	feat: publish gh-pages with tag name as commit message	2023-09-28 15:57:58 +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: add connections page preview	2023-09-06 00:38:12 +08:00
public	feat(pwa): add pwa shortcut icon, closes #201	2023-09-17 13:10:53 +08:00
src	feat(config): toast error message when dns query failed for some reason, closes #321	2023-10-04 18:16:37 +08:00
typings	chore: add tailwindcss-safe-area module type declaration	2023-09-26 18:35:40 +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
.eslintignore	chore(package.json): add lint script	2023-09-14 17:01:54 +08:00
.eslintrc.yml	chore: refine eslint config	2023-09-09 03:00:04 +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
.prettierignore	chore(package.json): add lint script	2023-09-14 17:01:54 +08:00
.prettierrc	style: set endOfLine as lf instead of crlf	2023-09-14 16:53:33 +08:00
Caddyfile	feat: publish docker image	2023-08-30 00:40:47 +08:00
CHANGELOG.md	chore(main): release 1.124.0 (#338 )	2023-10-04 05:17:55 -05:00
Dockerfile	build(docker): unlock node:alpine image version	2023-09-16 00:21:05 +08:00
index.html	feat(pwa): add pwa shortcut icon, closes #201	2023-09-17 13:10:53 +08:00
LICENSE	docs: add MIT license	2023-08-28 00:13:00 +08:00
package.json	chore(deps): bump zod from 3.22.3 to 3.22.4 (#342 )	2023-10-04 20:24:49 -05:00
pnpm-lock.yaml	chore(deps): bump zod from 3.22.3 to 3.22.4 (#342 )	2023-10-04 20:24:49 -05:00
postcss.config.js	chore: initial commit	2023-08-27 15:34:12 +08:00
pwa-assets.config.ts	feat(pwa): add pwa shortcut icon, closes #201	2023-09-17 13:10:53 +08:00
README.md	docs(README): update git pull gh-pages instruction as we are only force pushing latest changes	2023-09-28 16:57:52 +08:00
tailwind.config.ts	chore: add tailwindcss-safe-area module type declaration	2023-09-26 18:35:40 +08:00
tsconfig.json	refactor: skipLibCheck	2023-09-03 20:31:13 +08:00
vite.config.ts	feat(pwa): add pwa shortcut icon, closes #201	2023-09-17 13:10:53 +08:00

README.md

metacubexd

Clash.Meta Dashboard, The Official One, XD

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

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

Update

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

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

Contributors

This project is only possible thanks to these amazing people.