Mistgate documentation

What is in the documentation, where to find it, and the order to read it in.

Mistgate is a self-hosted panel for your own VPN fleet: one binary for the panel, one for the node agent, Hysteria2, VLESS REALITY and AmneziaWG in one subscription. This documentation describes what the code does today; features that are still being built are marked Planned.

What is where

Section	For
Getting started	The concepts, what you need, and the path from an empty server to the first user with a working subscription.
Guide	Day-to-day work in the admin: nodes, profiles, protocols, WARP, users, subscriptions, client apps, the user page, DNS.
Operations	Keeping the fleet healthy, updated and safe, and what to do when something breaks.
Roadmap	What is done, what is being tested, what comes next, and the known limits.
Reference	Exact commands, flags, environment variables, the API, the MCP server and how the parts fit together.

Reading order for a new admin

1. Overview and Requirements: what a panel, a node and a profile are, and what servers you need.
2. Install the panel from the official release, by hand or with the install prompt of the AI agent guide. Or, as a preview, on Cloudflare Workers with no server of your own.
3. Install a node over SSH, or add a node with a command you run yourself.
4. First users: a profile on the node, a group, a user, a subscription link.
5. Health, Security and encrypted backups before you give links to other people.
6. The Guide pages as you need them; the Reference when you script or automate.

All pages

Getting started

• Overview: what Mistgate is and its concepts: panel, node, profile, server on a node, user, group, device, subscription, user page.
• Requirements: what the panel and the nodes need, and what you need to build from source.
• Install the panel: from a fresh Linux server to the owner account in the admin.
• Install the Cloudflare edition: the panel on Cloudflare Workers instead of a server, with mistgate edge deploy (a preview).
• Add a node: the two ways to add a node, the manual install command, and removing a node.
• Install a node over SSH: the panel installs the agent itself; install jobs and the saved SSH access.
• AI agent guide: ready prompts to install the panel, run the fleet through MCP and contribute to the code.
• First users: put a profile on a node, give it to a group, create a user and send the link.

Guide

• Nodes: node settings, status and what the agent does on the host.
• Profiles: what a profile is and how it becomes a server on a node.
• Hysteria2: Hysteria2 profile settings, certificates and obfuscation.
• VLESS REALITY: VLESS profiles over TCP and XHTTP, when to choose them over Hysteria2, how to pick a REALITY target, ports and apps.
• VLESS and Hysteria2 on one node: who listens where, what happens to the Hysteria2 site and to Let's Encrypt when VLESS takes TCP 443, and how to try VLESS with a few people.
• AmneziaWG: AmneziaWG 2.0 and 3.1 profiles, userspace or the kernel module, devices and keys.
• WARP: sending a profile's traffic out through Cloudflare WARP.
• Users and groups: users, groups, devices, traffic limits and terms.
• Subscriptions: one link per person and which format each app gets.
• Client apps: which app on which platform, what each receives, one-tap add links, kl!ck, and setting the apps up in the admin and through MCP.
• User page: the person's own page with instructions, a QR code and traffic.
• DNS: DNS presets for users and groups, and the DNS of the nodes.
• Torrent protection: the per-node BitTorrent blocker, what it catches and what its events show.
• Your own decoy site: replace the built-in decoy page with a small site of your own, and a ready prompt for an AI agent that invents a unique one.

Operations

• Health: client-eye checks, the node doctor and alerts.
• Reachability: whether the nodes open from inside a country: Globalping, the block lists, the TSPU probe, each node's week and the alert.
• Telegram alerts: the bot, linking your chat, what is sent and to whom, and the panel watcher.
• Panel watcher: Cloudflare checks the panel once a minute and reports outages in Telegram.
• Updates: node self-update, updating a node now or on a schedule, rollbacks, and updating the panel.
• Releases and signing: the release key, reproducible builds, signing and publishing, a bundle of your own.
• Encrypted backups: configure R2, protect the offline recovery identity and restore a panel.
• Security: admin sign-in, roles, step-up, sessions, audit, the decoy site and the hidden admin, the data directory and backups, recovering access.
• Troubleshooting: common problems and how to find their cause.

Roadmap

• Status and roadmap: what the current release does, what comes next, and the known limits.

Reference

• CLI: every mistgate and mistgate-node command and flag.
• Configuration: every serve and setup flag, every MISTGATE_* environment variable, and the data directory layout.
• API: the Connect API, API tokens and their profiles.
• MCP: the MCP server, the stdio proxy, the tools, plan / apply and approvals.
• Architecture: how the panel, the agents and the clients talk to each other.
• FAQ: short answers to common questions.
• Comparison with other panels: Mistgate next to 3x-ui, Marzban, PasarGuard, Remnawave, Hiddify Manager and s-ui, with sources.
• Benchmarks: memory, CPU, start time and load of Mistgate next to 3x-ui, Remnawave and PasarGuard on the same small server, with the method and the limits.

---

_{Edit this page · View on mistgate.app}