Imugi-Panel

KO | EN

gitlite — search

#html #shell #redis #pdf #ai-agents #web #cli #tailwindcss #php #pytorch

(★ 9)

Web admin panel for mieru/mita proxy server. Docker, users, ports, QR, routing, metrics.

File Explorer

ZIP Download

- - ci.yml
  - release.yml
- dependabot.yml
- release.yml
- - main.go
- - main.go
- - Dockerfile
  - entrypoint.sh
- Dockerfile
- - advanced-tuning.md
  - backup-restore.md
  - chaining-panels.md
  - geoip-routing.md
  - hardening.md
  - how-it-works.md
  - metrics.md
  - README.md
  - reverse-proxy-tls.md
  - sharing-configs.md
  - split-deployment.md
- - advanced.png
  - dashboard.png
  - login.png
  - mobile.png
  - routing.png
  - share.png
  - users.png
- COMPATIBILITY.md
- DEVELOPMENT.md
- - advanced.go
  - advanced_test.go
  - authhandlers.go
  - backup.go
  - chain.go
  - dashboard.go
  - dashboard_test.go
  - egress.go
  - errors.go
  - geoip.go
  - health.go
  - mita.go
  - network.go
  - ports.go
  - proxy.go
  - router.go
  - server_test.go
  - settings.go
  - share.go
  - sharepage.go
  - subscription.go
  - subscription_test.go
  - users.go
  - users_test.go
  - version.go
  - version_test.go
- - auth.go
  - auth_test.go
  - bootstrap.go
- - backup.go
  - backup_test.go
  - crypto.go
  - restore.go
- - chain.go
  - chain_test.go
- - clashsub.go
  - clashsub_test.go
- - dat.go
  - geoip.go
  - geoip_test.go
  - sitedat.go
- - metrics.go
- - client.go
  - config.go
  - heal.go
  - metrics.go
- - portspec.go
  - portspec_test.go
- - sharelink.go
  - sharelink_test.go
- - sqlite.go
  - store.go
  - store_test.go
- - supervisor.go
  - supervisor_test.go
- - webfs.go
- backup.sh
- update-mieru.sh
- - favicon.svg
- - App.vue
  - base.ts
  - i18n.ts
  - main.ts
- env.d.ts
- index.html
- package-lock.json
- package.json
- tsconfig.json
- vite.config.ts
.dockerignore
.env.example
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
docker-compose.dev.yml
docker-compose.nginx.yml
docker-compose.override.example.yml
docker-compose.yml
go.mod
go.sum
LICENSE
Makefile
README.md
SECURITY.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

# Project Badges

CI Visit
License: GPL v3 Visit

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

**Imugi Panel** is a web admin panel for the
[mieru](https://github.com/enfein/mieru) proxy server (`mita`), in the spirit of
3x-ui for Xray. Manage users, ports, routing, and share links from the browser.
English and Russian UI.

Single Go binary with the Vue SPA embedded, shipped as one Docker image that
bundles and supervises `mita`.

![Dashboard](https://raw.githubusercontent.com/FJCrux/Imugi-Panel/main/docs/screenshots/dashboard.png)

English &amp; Russian · responsive down to phones

## Features

- **Users & quotas** - CRUD mieru users, traffic quotas, private-IP toggle.
- **Network** - port bindings (single ports and ranges, TCP/UDP), MTU, logging.
- **Dashboard** - mita status, live sessions, traffic, logs; restart from the UI.
- **Sharing & subscriptions** - per-user `mieru://` / `mierus://` links and QR
  codes, expiring tokenized links, and permanent auto-refreshing subscriptions
  (Clash/Mihomo profile or native link list) on their own path or port.
  See [sharing](docs/guides/sharing-configs.md).
- **Outbound routing & Geo** - SOCKS5 outbounds and rules by domain, CIDR,
  GeoIP category (xray `geoip.dat`), or GeoSite domain category (`geosite.dat`).
  See [routing](docs/guides/geoip-routing.md).
- **Panel chaining** - route egress through another panel with a pasted key.
  See [chaining](docs/guides/chaining-panels.md).
- **Advanced mieru tuning** - traffic obfuscation (fragmentation, nonce,
  padding), DNS dual-stack preference and static hosts, mandatory user hint.
  Every field has an explanatory tooltip.
- **Metrics** - OpenTelemetry (OTLP / Prometheus). See [metrics](docs/guides/metrics.md).
- **Hardening** - TLS, secret base path, Host validation, rate-limited login,
  crawler blocking (`robots.txt` + `X-Robots-Tag`).
  See [hardening](docs/guides/hardening.md).
- **Localization** - English and Russian out of the box; add a language by
  dropping a JSON file into [`web/src/locales`](web/src/locales/)
  (contributions welcome).

## Quick start (Docker)

```bash
git clone https://github.com/fjcrux/mieru-web-ui &&
cd mieru-web-ui &&
cp .env.example .env &&
docker compose up -d
```

This pulls `ghcr.io/fjcrux/imugi-panel:latest` and starts the panel with
working defaults; tweak [`.env`](.env.example) later as needed. On first run
the panel generates the admin password — print it with:

```bash
docker compose logs | grep -A4 "Panel admin"
```

First login is `admin` with that password. Change it under **Settings**.

To build from source instead of pulling the image:

```bash
docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
```

The compose file publishes the panel on `127.0.0.1:8686` and the proxy ports in
bridge mode. Reach the panel via an SSH tunnel — replace `user@your-server`
with your SSH login, then open <http://localhost:8686>:

```bash
ssh -L 8686:127.0.0.1:8686 user@your-server
```

…or via a [reverse proxy](docs/guides/reverse-proxy-tls.md). For a production
setup with a domain, use the bundled nginx compose instead — it terminates TLS
in a dockerized nginx on the same network and never exposes the panel port
itself (see the reverse-proxy guide):

```bash
docker compose -f docker-compose.nginx.yml up -d
```

### First-time setup

1. **Settings**: set the Public host (address clients connect to) and, behind a
   proxy, the Panel URL.
2. **Network**: add a port binding (open it in your firewall / `PROXY_PORTS`).
3. **Users**: add a user; the proxy starts once there's a user and a port.
4. **Users → Connect**: hand out a subscription link, a one-off link, or a QR.

## Client apps

Users connect with any mieru-capable client: open the **Connect** dialog, then
add the subscription URL, or import the `mieru://` / `mierus://` link or scan
the QR. Recommended apps:

- **Android** — [NekoBox](https://github.com/MatsuriDayo/NekoBoxForAndroid) (+ [mieru plugin](https://github.com/enfein/NekoBoxPlugins)), [Exclave](https://github.com/dyhkwong/Exclave), [Karing](https://karing.app/), or [ClashMi](https://clashmi.app/)
- **iOS** — [Shadowrocket](https://apps.apple.com/app/id932747118), [Karing](https://karing.app/), or [ClashMi](https://clashmi.app/)
- **Windows / macOS / Linux** — [Mihomo Party](https://mihomo.party/), [Clash Verge Rev](https://www.clashverge.dev/), or the official [mieru CLI](https://github.com/enfein/mieru/blob/main/docs/client-install.md)

mieru maintains the [full, up-to-date client list](https://github.com/enfein/mieru#third-party-client-software).

For Clash-family apps (Mihomo Party, Clash Verge Rev, FlClash, ClashMi — anything on mihomo ≥ 1.19.0), the **Subscription** tab in the Connect dialog issues a permanent URL that serves a ready-to-import Clash profile and auto-refreshes in the client. The same URL with `?format=mierus` or `?format=mieru` returns the native links as a base64 line list for URI-subscription clients (NekoBox/Exclave with the mieru plugin), and `?flavor=proxies` returns a proxies-only document for `proxy-provider` setups.

## Configuration

All options live in `.env` - see [`.env.example`](.env.example) for the full,
commented list (ports, admin, TLS, panel URL, base path, share/subscription
path and port, GeoIP, metrics). `docker compose` reads `.env` automatically.

For local compose tweaks (extra networks, published ports, mounts, limits)
copy [`docker-compose.override.example.yml`](docker-compose.override.example.yml)
to `docker-compose.override.yml` — compose merges it automatically and it's
gitignored, so updates never conflict with your changes.

## How it works

See [docs/guides/how-it-works.md](docs/guides/how-it-works.md) for the mental
model: one container supervising mita (and any chained clients), ports driven by
a single `PROXY_PORTS`, and the admin/share paths.

## Guides

Task-oriented how-tos are in [docs/guides](docs/guides/): how it works,
TLS/reverse-proxy, hardening, routing & GeoIP, chaining panels, sharing, metrics.

## Updating mieru/mita

One script bumps `go.mod`, the Dockerfiles, `.env`, and compose to the given
version:

```bash
scripts/update-mieru.sh v3.35.0
```

Then verify and rebuild:

```bash
make test && make docker
```

Which panel release pins which mieru version:
[docs/COMPATIBILITY.md](docs/COMPATIBILITY.md).

## Releases

Pushing a `vX.Y.Z` tag builds and publishes the image (amd64 + arm64) to
`ghcr.io/fjcrux/imugi-panel` (`X.Y.Z`, `X.Y`, `latest`) and creates a GitHub
Release. Branch pushes only run the checks; nothing is published from them.

## Security

See [SECURITY.md](SECURITY.md). Key points: serve over TLS; the panel stores
mieru user passwords in plaintext (mode 0600) to build client configs, so
protect the `/data` volume; treat share links as secrets.

## Development

See [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md).

## License

GPL-3.0 - Imugi Panel imports the GPL-3.0 `mieru` module. See [LICENSE](LICENSE).

Imugi-Panel

File Explorer

# Use via CDN

# Project Badges

Was this content helpful?

Recent Feedback

Download README