Public-Mirror/metacubexd
1
0
Fork 0
mirror of https://github.com/MetaCubeX/metacubexd.git synced 2024-11-24 09:45:35 +08:00
Code Issues Projects Releases Wiki Activity
mirror
590 Commits 4 Branches 265 Tags 40 MiB
TypeScript 98.1%
JavaScript 0.8%
CSS 0.5%
HTML 0.4%
Dockerfile 0.2%
07d3e7fdce
Go to file
kunish 07d3e7fdce
feat(config): i18n support for port numbers
2023-09-23 02:13:17 +08:00
.github chore(dependabot): add docker, github-actions 2023-09-21 13:34:00 +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): i18n support for port numbers 2023-09-23 02:13:17 +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.108.2 (#272) 2023-09-23 00:35:35 +08: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 refactor(i18n): add i18n context provider 2023-09-23 01:38:36 +08:00
pnpm-lock.yaml refactor(i18n): add i18n context provider 2023-09-23 01:38:36 +08: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): markdown syntax 2023-09-17 02:31:01 +08:00
tailwind.config.ts feat(proxy): regression on render proxies in two columns 2023-09-21 23:58:06 +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-overview

pr-closed last-commit build downloads license

Preview

preview-overview preview-connections

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

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.

contributors

Credits