https://github.com/metacubex/metacubexd

Mihomo Dashboard, The Official One, XD
https://github.com/metacubex/metacubexd

daisyui dashboard docker solidjs

Last synced: 11 days ago
JSON representation

Mihomo Dashboard, The Official One, XD

• Host: GitHub
• URL: https://github.com/metacubex/metacubexd
• Owner: MetaCubeX
• License: mit
• Created: 2023-07-11T04:04:14.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2026-05-23T09:49:35.000Z (12 days ago)
• Last Synced: 2026-05-23T11:34:32.928Z (12 days ago)
• Topics: daisyui, dashboard, docker, solidjs
• Language: Vue
• Homepage:
• Size: 174 MB
• Stars: 3,638
• Watchers: 18
• Forks: 461
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# metacubexd

**Mihomo Dashboard, The Official One, XD**

[![pr-closed](https://img.shields.io/github/issues-pr-closed/metacubex/metacubexd?style=for-the-badge)](https://github.com/metacubex/metacubexd/pulls)

[![last-commit](https://img.shields.io/github/last-commit/metacubex/metacubexd?style=for-the-badge)](https://github.com/metacubex/metacubexd/commits)

[![build](https://img.shields.io/github/actions/workflow/status/metacubex/metacubexd/release.yml?style=for-the-badge)](https://github.com/metacubex/metacubexd/actions)

[![downloads](https://img.shields.io/github/downloads/metacubex/metacubexd/total?style=for-the-badge)](https://github.com/metacubex/metacubexd/releases)

[![license](https://img.shields.io/github/license/metacubex/metacubexd?style=for-the-badge)](./LICENSE)

## ✨ Features

- 📊 Real-time traffic monitoring and statistics

- 🔄 Proxy group management with latency testing

- 📡 Connection tracking and management

- 📋 Rule viewer with search functionality

- 📝 Live log streaming

- 🎨 Beautiful UI with light/dark theme support

- 📱 Fully responsive design for mobile devices

- 🌐 Multi-language support (English, 中文, Русский)

## 🖼️ Preview

Desktop Screenshots

|                           Overview                            |                           Proxies                           |

| :-----------------------------------------------------------: | :---------------------------------------------------------: |

|  |  |

|                             Connections                             |                          Rules                          |

| :-----------------------------------------------------------------: | :-----------------------------------------------------: |

|  |  |

|                         Logs                          |                          Config                           |

| :---------------------------------------------------: | :-------------------------------------------------------: |

|  |  |

Mobile Screenshots

|                             Overview                              |                             Proxies                             |                               Connections                               |

| :---------------------------------------------------------------: | :-------------------------------------------------------------: | :---------------------------------------------------------------------: |

|  |  |  |

|                            Rules                            |                           Logs                            |                            Config                             |

| :---------------------------------------------------------: | :-------------------------------------------------------: | :-----------------------------------------------------------: |

|  |  |  |

## 🔗 Official Links

| Platform         | URL                                    |

| :--------------- | :------------------------------------- |

| GitHub Pages     | https://metacubex.github.io/metacubexd |

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

## 🚀 Quick Start

### Prerequisites

Enable external-controller in your mihomo config:

```yaml

external-controller: 0.0.0.0:9090

```

### Option 1: Use Pre-built Assets

```shell

# Clone the gh-pages branch

git clone https://github.com/metacubex/metacubexd.git -b gh-pages /etc/mihomo/ui

# Set external-ui in your config

# external-ui: /etc/mihomo/ui

# Update to latest version

git -C /etc/mihomo/ui pull -r

```

### Option 2: Docker

```shell

# Basic usage

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

# With custom default backend URL

docker run -d --restart always -p 80:80 --name metacubexd \

  -e DEFAULT_BACKEND_URL=http://192.168.1.1:9090 \

  ghcr.io/metacubex/metacubexd

# Update

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

```

Docker Compose

```yaml

services:

  metacubexd:

    container_name: metacubexd

    image: ghcr.io/metacubex/metacubexd

    restart: always

    ports:

      - '80:80'

    # environment:

    #   - DEFAULT_BACKEND_URL=http://192.168.1.1:9090

  # Optional: mihomo instance

  mihomo:

    container_name: mihomo

    image: docker.io/metacubex/mihomo:Alpha

    restart: always

    pid: host

    network_mode: host

    cap_add:

      - ALL

    volumes:

      - ./config.yaml:/root/.config/mihomo/config.yaml

      - /dev/net/tun:/dev/net/tun

```

```shell

docker compose up -d

# Update

docker compose pull && docker compose up -d

```

### Option 3: Build from Source

```shell

# Install dependencies

pnpm install

# Build for static hosting (gh-pages, etc.)

pnpm generate

# Preview

pnpm preview

```

## 🛠️ Development

```shell

# Start dev server

pnpm dev

# Start dev server with mock data

pnpm dev:mock

# Lint & Format

pnpm lint

pnpm format

```

## 📄 License

[MIT](./LICENSE)

## 🙏 Credits

- [Nuxt](https://github.com/nuxt/nuxt) - The Intuitive Vue Framework

- [Vue.js](https://github.com/vuejs/core) - The Progressive JavaScript Framework

- [daisyUI](https://github.com/saadeghi/daisyui) - Tailwind CSS components

- [Tailwind CSS](https://tailwindcss.com) - Utility-first CSS framework