mirror of https://github.com/MetaCubeX/metacubexd.git synced 2024-11-30 11:25:38 +08:00

mirror

Go to file

dependabot[bot] 37f111b10d build(deps): bump commitlint from 19.5.0 to 19.6.0 (#1178 ) Bumps [commitlint](https://github.com/conventional-changelog/commitlint/tree/HEAD/@alias/commitlint) from 19.5.0 to 19.6.0. - [Release notes](https://github.com/conventional-changelog/commitlint/releases) - [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/@alias/commitlint/CHANGELOG.md) - [Commits](https://github.com/conventional-changelog/commitlint/commits/v19.6.0/@alias/commitlint) --- updated-dependencies: - dependency-name: commitlint dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>		2024-11-23 21:17:09 +08:00
.github	build: update release workflow to include dynamic tag for Docker image	2024-11-23 17:02:56 +08:00
.husky	feat: bun -> pnpm	2024-04-08 17:34:57 +08:00
.vscode	chore: vscode setting eslint useFlatConfig	2024-10-11 23:35:19 +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	feat: support to set icon color to the theme color when proxy icon starts with `data:image/svg+xml` (#1166 )	2024-11-23 20:53:28 +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	fix(pwa): items in includeAssets cannot be empty string	2024-10-10 19:25:08 +08:00
.prettierrc	style: set endOfLine as lf instead of crlf	2023-09-14 16:53:33 +08:00
auto-imports.d.ts	fix(pwa): items in includeAssets cannot be empty string	2024-10-10 19:25:08 +08:00
Caddyfile	feat: publish docker image	2023-08-30 00:40:47 +08:00
CHANGELOG.md	chore(main): release 1.171.0 (#1167 )	2024-11-13 20:29:39 +08:00
Dockerfile	build(docker): fix Dockerfile `FromAsCasing` lint issue	2024-08-22 16:57:38 +08:00
eslint.config.mjs	chore: eslint flat config	2024-04-16 17:35:12 +08:00
index.html	feat: show current page title, closes #474	2024-10-10 00:49:58 +08:00
LICENSE	docs: add MIT license	2023-08-28 00:13:00 +08:00
package.json	build(deps): bump commitlint from 19.5.0 to 19.6.0 (#1178 )	2024-11-23 21:17:09 +08:00
pnpm-lock.yaml	build(deps): bump commitlint from 19.5.0 to 19.6.0 (#1178 )	2024-11-23 21:17:09 +08:00
postcss.config.js	chore: initial commit	2023-08-27 15:34:12 +08:00
pwa-assets.config.ts	chore(pwa): replace preset with minimal2023Preset	2024-11-13 20:22:46 +08:00
README.md	feat: hidden api & remove domain unmaintained (#939 )	2024-08-22 16:43:23 +08:00
tailwind.config.ts	feat(connections): reduce default visible columns	2024-10-13 03:38:20 +08:00
tsconfig.json	refactor: skipLibCheck	2023-09-03 20:31:13 +08:00
vite.config.ts	feat(config): check for frontend version update	2024-10-10 23:42:48 +08:00

README.md

metacubexd

Mihomo Dashboard, The Official One, XD

Preview

Published Official Links

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