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

mirror

Go to file

github-actions[bot] 41aa606572 chore(main): release 1.144.0 (#886 ) * chore(main): release 1.144.0 * chore: update pnpm-lock.yaml --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: kunish <kunish.butt@gmail.com>		2024-08-09 11:58:58 +08:00
.github	build(deps): bump docker/build-push-action from 5 to 6 (#771 )	2024-06-18 09:28:28 +08:00
.husky	feat: bun -> pnpm	2024-04-08 17:34:57 +08:00
.vscode	chore: eslint flat config	2024-04-16 17:35:12 +08:00
docs	docs: update example docker-compose.yml	2024-03-20 16:18:18 +08:00
public	feat(pwa): add pwa shortcut icon, closes #201	2023-09-17 13:10:53 +08:00
src	fix: use google as default ipv6 test url (#894 )	2024-08-09 09:45:59 +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
.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: use bun instead of pnpm as package manager	2024-02-01 18:12:04 +08:00
.prettierrc	style: set endOfLine as lf instead of crlf	2023-09-14 16:53:33 +08:00
auto-imports.d.ts	fix: respect system ui font & better looking (maybe) for proxy card (#844 )	2024-07-23 20:58:03 +08:00
Caddyfile	feat: publish docker image	2023-08-30 00:40:47 +08:00
CHANGELOG.md	chore(main): release 1.144.0 (#886 )	2024-08-09 11:58:58 +08:00
Dockerfile	feat: bun -> pnpm	2024-04-08 17:34:57 +08:00
eslint.config.mjs	chore: eslint flat config	2024-04-16 17:35:12 +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(main): release 1.144.0 (#886 )	2024-08-09 11:58:58 +08:00
pnpm-lock.yaml	chore(main): release 1.144.0 (#886 )	2024-08-09 11:58:58 +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	feat: bun -> pnpm	2024-04-08 17:34:57 +08:00
tailwind.config.ts	fix: respect system ui font & better looking (maybe) for proxy card (#844 )	2024-07-23 20:58:03 +08:00
tsconfig.json	refactor: skipLibCheck	2023-09-03 20:31:13 +08:00
vite.config.ts	fix: closes #685	2024-04-23 13:56:12 +08:00

README.md

metacubexd

Mihomo 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/mihomo/ui

Make sure you have external-ui directory set correctly in your config file

external-ui: /etc/mihomo/ui

Update

git -C /etc/mihomo/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/mihomo:Alpha
    restart: always
    pid: host
    ipc: host
    network_mode: host
    cap_add:
      - ALL
    volumes:
      - ./config.yaml:/root/.config/mihomo
      - /dev/net/tun:/dev/net/tun

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