mistgate Docs
EN
300

In the admin: Users

Users and groups

How to create and manage users (limits, term, traffic, devices, access), what a group gives, and how to move people between groups.

On this page

A user is a person who gets access. Each user is in one group, and the group decides which profiles they get. On top of that, every user has their own limits (traffic quota, term, device limit), their own app switches and their own choice of nodes. The Users section has two tabs: People and Groups.

What a person gets#

A person gets a server when all of this holds:

  • the person is active (not disabled, not past their term, not over their quota);
  • the profile is in the person's group;
  • the node is enabled for the person's group (a group can leave nodes out);
  • the profile is on a node the person may use (all nodes, or the ones picked for them);
  • that profile on the node is switched on and running or starting;
  • one of the person's app switches allows the protocol (the Telegram proxy switch is the one for MTProto).

Any change to these is pushed to the nodes at once.

Alice is active, in the group Family, may use all nodes, and has the Happ switch on and AmneziaVPN off. Family holds the profiles Hysteria2 and AmneziaWG. On de1 both profiles are switched on, on nl1 Hysteria2 is switched off. Alice gets Hysteria2 on de1; not Hysteria2 on nl1, which is off; not AmneziaWG, because none of her switched-on apps reads it. Alice user Status Active Group Family Nodes all Happ on AmneziaVPN off Family group Hysteria2 AmneziaWG the profiles of the group Servers on nodes de1 · Hysteria2 on de1 · AmneziaWG on nl1 · Hysteria2 off What Alice gets yes Hysteria2 on de1 no Hysteria2 on nl1: switched off on the node no AmneziaWG on de1: none of her apps reads it, AmneziaVPN is off

Two ways to connect#

By subscription link By AmneziaWG key
Apps The subscription apps (Happ and other apps that read share links, apps on the mihomo core) AmneziaVPN and the AmneziaWG apps
Protocol Hysteria2 (and AmneziaWG for apps on the mihomo core) AmneziaWG
What the person adds One link for every device A key of its own on each device
Updates The app refreshes the link by itself A key is imported again by hand
Switch on the user the switch named after the link apps ("Happ", or the app names set in Subscriptions) AmneziaVPN

Both are offered on the person's page side by side. At least one of the two switches stays on. A third switch, Telegram proxy, is separate: it adds a Telegram key and links on top of them (see Telegram proxy). See Subscriptions, AmneziaWG, MTProto and User page.

A fourth row, Mistgate app, is the panel's own desktop app, which is not released publicly yet. It takes a key of its own on each device, and the servers (Hysteria2, VLESS and AmneziaWG) come straight into the app, each with the profile's name so that two profiles of one protocol can be told apart, and, when the person's Telegram row is on, their Telegram proxy links too. Each path also says whether the exit node gives the person IPv6 (ipv6_egress): true only when the panel knows it does (the node's IPv6 exit is on and its doctor reported that IPv6 works, or, through WARP, the WARP account has an IPv6 address), so a node that has no IPv6, whose IPv6 at the hoster does not work or that has not been checked yet says false, and an AmneziaWG path of such a node carries no IPv6 address of the tunnel. For a relay it is the exit's answer. The answer also carries devices (used and limit): how many of the person's devices fill their device limit, the count a new device is refused by, and the limit. Numbers only, nothing of any device. It rides on the subscription link, so it works only while the link switch is on: with the link off, the row is locked and says why. The AmneziaWG in it does not follow the owner's switch AmneziaWG in apps on the link (see Subscriptions): the app gets AmneziaWG as long as its own row is on. The switch is on for everybody by default, so an update changes nothing for people who already connected the app. Switched off for a person, a new device of theirs cannot connect (the app is told "turned off for you"), and the devices already connected get no servers; their keys are kept and work again when the switch goes on. The owner has one more switch for the whole panel in Subscriptions → Who gets what → Mistgate app: off there, the app cannot find the panel and no new device connects, whatever the person's switch says, and the person's row shows "Off for the whole panel" with a link to that setting. The same card sums up how many people have the app on and how many devices are connected with a key.

The People tab#

The header counts people and how many are online. Above the list:

  • Name or group: a search by the user's name or group name;
  • the chips All, Online now, Expiring soon (within 7 days), Over quota and Over device limit, each with its count. Over device limit shows only while someone is over their limit (or while it is selected): it is the list to look at before you switch the device limit from Only count to Limit.
Column What it shows
Name The name; No access when the person gets nothing yet (the group's profiles run on no node, or nothing fits the switched-on apps and the chosen nodes).
Status Active, Expired, Over quota, Device limit or Disabled.
App What the person actually used in the last 7 days: Happ, Amnezia or Both.
Group The group.
Dev. Devices in use and the limit: amber when the limit is full, red ("6/5") when the person is over it.
Traffic Used traffic of the current period, with a bar against the quota.
Term Days left, ∞ for no expiry.
Last seen "now" while online, else how long ago.
Node The node of the newest connection.

Device limit is not a separate state: it is an active person whose devices reached the limit. A disabled person shows Disabled whatever else is true; then Expired, then Over quota.

The list is paged, 50 people to a page (25 or 100 on request): under the card there is "Showing 51–100 of 137", the page buttons and the rows per page. A filter or a search pages its own results; the page number is kept in the address.

Bulk actions#

The owner and the helper tick people in the list: a box in each row, one in the header for the whole page. A read-only admin sees the list without boxes. As soon as someone is ticked, a bar floats at the foot of the page (on a phone, in the place of the bottom dock). It counts the people ("37 people selected"), says how many of them are on other pages or under another filter, and holds the actions. The selection stays when you move between pages, sort or filter; Esc or the cross clears it. At most 5000 people can be selected at once.

Select in the filter row replaces the selection in one click:

  • This page takes the rows on screen.
  • All found takes everybody the current filter, search and group list, not only the page. The panel collects them when the menu opens (a moment for a big list, shown as "…").
  • Expired, Disabled, No access (active, but their page would give nothing) and Never connected take the people in that state among the found ones.

The bar has Extend…, Disable and More ▾, and on a narrow screen Disable moves into More. When most of the selected are off, Enable takes the place of Disable. More holds Reset traffic, the other of Enable and Disable, and Delete…. A number beside an action is how many of the selected it applies to; an action nobody can take is grayed out and says why on hover.

Every action opens a window first. It names who will change ("alice, bob, carol … and 27 more") and who sits out with the reason, for example "No expiry date, nothing to extend" or "Already disabled".

  • Extend… has three ways. Add days (7, 30, 90, 365 or your own number) counts from the later of today and the current end date, and people whose access had run out get it back; people without an expiry date are skipped, because extending would give them one. Until a date ends access at the end of the chosen day in your time zone: people without an expiry get one, and the window warns how many have a later end date that would move earlier. No expiry takes the end date away.
  • Disable cuts the people off at once. Their links and keys stay as they are.
  • Enable switches them back on. Someone whose term has run out is switched on but gets nothing until you extend them; the window says how many.
  • Reset traffic sets the used traffic to zero for those who used some. History and the next reset date stay, and anyone stopped by their traffic limit gets access again.
  • Delete… removes the people for good, with their links, keys and traffic history. You type the number of people to confirm, and the panel asks you to confirm your sign-in, as for any deletion.

Adding days, disable, enable, reset and delete go to the panel in parts of 200 people, one part after another. A date or "no expiry" is one change per person, four at a time. While a batch runs, the bar grows upwards into its progress: what it does and how far ("Disabling · 120 of 500"), Stop, a bar that fills, and, for a long batch, counters (done, running, waiting, skipped) with only the failed people listed below them, each with an Open link to their card. Stop lets the part in flight finish and starts no more. At the end the summary says "Disabled 497 of 500 people · 1 failed · 2 skipped"; Retry runs the failed and the not-started ones again. After a Disable the summary has Enable again for exactly the people it switched off. Leaving the People list for another page, or for the Groups tab, while a batch runs asks first; paging and sorting never do. The audit log records one row per part for adding days, disabling, enabling and deleting, and one row per person for a date, no expiry and a traffic reset.

Subscription links, page passwords and Telegram or AmneziaVPN keys are never fetched, shown or changed in bulk: a link or key is a credential, and handing out hundreds at once in a table is how they leak. They stay in the person's card, one person at a time.

The API takes many users in one call too. See API.

Creating a user#

New user opens the form:

Field Default What it is
Name Required, unique (case does not matter), up to 64 characters.
Group "Everyone" if there is such a group, else the first The line Gets under it says what a person of this group gets: the subscription and AmneziaVPN keys, on how many nodes. A red line says when they would get nothing. Edit group opens the group.
Quota 100 GB Steps of 10 GB; 0 is Unlimited. The hint under it names the period.
Resets Monthly Daily, Weekly, Monthly or Never. See Quota periods.
Term 30 days Steps of 5 days; 0 means it never expires. Access pauses afterwards.
Devices 5 1–100: how many devices can connect.
Apps in the subscription what the group gives The link-app switch and AmneziaVPN. Until you touch them, they follow the group: a way the group gives nothing for starts off, with the reason under it. Telegram proxy is off by default and is not part of this choice: it is an addition, see Telegram proxy.
All nodes on New nodes are added by themselves. Off: tick nodes; new nodes will not be added.
More folded DNS: a preset of the user's own, inherited when empty (see DNS). Speed limits: Speed per person and Speed per device, both unlimited by default (see Limits).

When there is no group yet, the form shows the group form inline. Create makes the user and opens the link window; the link (and the page password, when pages ask for one) is copied for you to send. If the person would get nothing yet, the window says why before the link goes out.

Gigabytes are decimal: 100 GB is 100,000,000,000 bytes.

The user card#

The header shows the name and status, the apps, the group and the term ("until 12 October · 14 d"), with three buttons: Disable (or Enable), Extend 30 days (off for a user without expiry) and Subscription link.

Under it, a strip explains a stop and offers the quick fix:

Stop Strip Button
Term ended "The term ended 3 days ago — access is paused." Extend 30 days
Quota used up "The 100 GB quota is used up — access is paused until it resets or you raise it." +50 GB
Device limit "Device limit (5) reached — a new device can't connect." +1 device

In the Only count mode nothing is refused, so this strip is not shown. A person over the limit gets a quiet line under the heading of Devices instead: "The limit only counts for now: apps over it still connect", with a link to Limit mode.

Traffic#

The used traffic of the current period against the quota, the reset period ("resets every week") and when the next reset comes, in your time, a chart of the last 14 days, and the traffic per node and protocol: the five biggest rows, Show all for the rest.

Devices#

The heading shows the devices in use against the limit ("3 of 5"): amber when it is full, red when the person is over it. The panel counts devices, one place each; what a device is and how it appears is in Devices and the device limit. The card has these parts:

  • Apps on the link: a row for every app that sends a device ID. The row shows the name (the model, or the name you gave it) and a quiet line: "online" with the servers it is connected to ("de1, nl1"), or how long ago the app fetched the link. Hover the row for the system and the app with their versions ("iOS 18.1 · Happ 3.4.2"); the ⋯ menu also shows since when, the traffic of the device over all time and its fingerprint. One device on two servers at once is a sign that its config was copied to another device; the row says so on hover.
  • Apps without a device ID: one row for every app on the link that does not send one (Hiddify, v2rayNG and the like, or Happ with HWID switched off). They share one place. In the Strict mode there is no such place and these apps cannot connect.
  • Telegram proxy: the person's Telegram key, when they have one. It takes no place in the limit; removing it revokes the key, as Revoke does.
  • AmneziaVPN keys: one row per device with its platform, profile and last connection; Show key and, in the menu, Delete…. Add device makes a new key. An outdated badge means the device needs its config again. See AmneziaWG.
  • Blocked (N): folded; see below.

The ⋯ menu of an app on the link:

  • Rename…: a name of your own, shown here and on the person's page.
  • Delete…: the app disconnects, its keys stop working and the place is free. If the app fetches the link again and there is a place, it comes back as a new device with new keys.
  • Block…: as Delete…, and the device ID cannot register again, even when the app fetches the link again, until you unblock it. The person's other devices keep working. Only an app with a device ID can be blocked; the shared place and AmneziaVPN keys cannot. The device ID is what the app reports: an app that reports another one is a new device and takes a free place like any other. If the link was passed to someone else, block their device and issue a New link as well.

Blocked (N) lists the blocked devices. Unblock lets the device in again; it gets new keys at its next refresh of the subscription. The menu of the shared place has Disconnect…: the apps lose the connection now and connect again at their next refresh.

Delete on an AmneziaVPN key disconnects the device and removes its key from every node.

Telegram proxy#

The switch Telegram proxy gives the person the MTProto servers of their group, for the Telegram app only.

  • Turning it on makes the person's Telegram key at once, in the user form or on the card; turning it off revokes the key and its links. It cannot stand alone: at least one of the link apps and AmneziaVPN stays on.
  • The key is one secret for every MTProto server of the person. It appears among the devices as Telegram proxy, and it does not count against the device limit: it never takes a place and never fails for want of room.
  • The block Telegram proxy on the card shows the links (Open in Telegram, copy, a QR code) and has Re-issue and Revoke. Their effect is on MTProto.
  • The links are not part of the subscription. The person finds them on their page (User page).

Subscription page#

Name shown on the subscription page: the name the user page greets the person with, up to 64 characters. Empty uses the account name; the line under the field shows the greeting ("Page greeting: …"). Save name saves it. Anyone with the link sees this name; it changes nothing else about the user. See User page.

DNS picked on the page#

Once a person has picked a DNS on their page (see DNS choice on the page), this section lists their pick for the apps on the link and their choices per server (read only, for every admin). A pick that is no longer offered says what applies instead. Reset removes all their choices, so the usual DNS applies again (their preset, the group's, the default of the list for the apps on the link or the node's default, the instance's). The owner and helpers can reset; it is written to the audit log as user_dns_choices_reset. Turning the option off does not remove choices already made: they work until you reset them here. See DNS.

Limits#

Setting Steps and range
Quota 10 GB, 0–10000 GB; 0 is Unlimited.
Resets Daily, Weekly, Monthly or Never; saved as soon as you pick. A person given a rolling 30-day period through the API or MCP also has Every 30 days.
Term 5 days, up to 3650; ∞ is Never. "−" on ∞ sets 30 days.
Devices 1, from 1 to 100.
Speed per person Steps of 5 Mbit/s, 0–10000; 0 is Unlimited. All the person's devices together, on one node. Experimental.
Speed per device The same steps. Each device on its own. Experimental.

A change is saved as soon as you stop clicking.

The speed limits apply to Hysteria2 and VLESS. AmneziaWG applies neither.

  • Speed per person is the total of the person's devices on one node. A person connected to two nodes at once can get up to twice the limit, because the nodes do not coordinate. This is the former single speed limit: before devices had keys of their own, all the apps shared one credential, so it was already a limit per person.
  • Speed per device caps each device.
  • Both can be set. A byte passes both limits, so a device runs at the smaller of its own limit and what is left of the person's.
  • Sharing the person's limit needs an agent that reports user-rate-limit/1. A node with an older agent holds each device to the smaller of the two limits, and the Agent card on the node's Server tab says so until the agent is updated (see Nodes).

Access#

  • Group: picking another group first asks the server what changes and shows it: "Alice loses: "AWG 3.1" (2 AmneziaVPN keys stop working)", "Gets: …". Change group confirms. An AmneziaVPN key belongs to one profile, so the keys of a lost profile stop working.
  • The group's profiles, in the two ways, each a link to its page.
  • DNS: the user's own preset, or empty for the group's or the default. The line under it says which applies and where it comes from.
  • The app switches, with Telegram proxy.
  • All nodes, or per-node checkboxes. A node where nothing fits the person is greyed out; "Hysteria2 only" marks a node with one protocol. A node's name opens its Profiles tab, where its own port and domain are set.

Danger zone#

  • Reset traffic sets the used traffic of the current period to zero. The period and its end stay, the history stays, and a person stopped by the quota can connect again. The counter cannot be restored.
  • Delete user removes the person for good: their keys are dropped from every node, their connections are cut, the link stops working and their traffic history is deleted. Type the name to confirm; the panel then asks you to confirm your sign-in (see Security).

Quota periods#

The quota starts again at 00:00 UTC: every day, every Monday or on the 1st of every month. Never keeps counting for the whole term; only Reset traffic sets it to zero. A new user resets every month unless you pick another period; the API and MCP can also set a rolling 30-day period. The card shows the period and the next reset. When the period ends, the used traffic starts again from zero and a person stopped by the quota gets access back by themselves.

Devices and the device limit#

A device is one place in the limit.

  • An app on the link that sends a device ID (HWID) is one device per ID. Which apps do: Client apps.
  • All apps on the link that send no device ID share one place, Apps without a device ID.
  • Each AmneziaVPN key is one device.
  • The Telegram key is listed with the devices but is not one: it takes no place.

How a device appears#

  • A device is created by the first fetch of the subscription by an app, one per device ID. Opening the user page, the admin's preview and creating a user never create one: a new person shows "0 of 5" until an app fetches the link, and the first connection waits a few seconds until the nodes have the new keys.
  • Each device has its own keys for Hysteria2, VLESS and AmneziaWG in Mihomo, its own online status and its own traffic. A config copied to another device keeps working until you delete or block that device, but it shows (one device on two servers at once), and removing it leaves the person's other devices alone.
  • The device ID itself is not stored: the panel keeps a hash of it, mixed with the person, so the same phone in two subscriptions is not linked. The card shows the first six characters of the hash as a fingerprint, to tell two identical phones apart.
  • On upgrade nobody has to reconnect. The first app with a device ID takes over the person's old shared device and keeps its keys. Other apps with an ID get keys of their own at their next refresh. Apps without an ID stay on a shared place.

The limit and the mode#

What happens when the limit is full depends on the mode in Subscriptions → Who gets what → Device limit for apps on the link: Only count, Limit or Strict. See Subscriptions. In short: Only count refuses nobody, Limit refuses a new device over the limit, Strict also refuses apps without a device ID.

  • A link device that stays silent for 30 days gives its place to a new app with a device ID, when a place is needed. This happens in Limit and Strict only. An AmneziaVPN key is never replaced. The event "a new device took the place of one silent for 30 days" is written.
  • A key cannot be made when the limit is full, by you or by the person on their page. Raise the limit or delete a device the person no longer uses.
  • A device you delete is cleaned up from the database after 90 days. A blocked device is kept, so the block holds.
  • The refused app is told why: see What the app shows when a device is refused.

A person can also delete and rename their own devices on their page, when Devices on the page is on; see User page. Blocking is for the owner and helpers.

The Groups tab#

A group is a set of profiles that its people get, and the nodes it leaves out. Each group is a card: its name, how many people are in it (a link to the filtered list), its profiles in the two ways with the number of nodes they run on for it, and its DNS preset when it has one. Edit and Delete are on the card.

With no group at all, the tab offers Create "Everyone" with all profiles and New group.

Creating and editing a group#

  • Name, up to 64 characters.
  • Profiles in the group: every profile is ticked for a new group; untick what the group should not give.
  • Nodes enabled for the group: every node is on for a new group; turn one off to take it away from everyone in the group — its servers leave every subscription format and the devices' keys stop going to it. New nodes stay on. A node is switched off at once, without a confirmation: no key stops working, those people just stop reaching that node.
  • More → DNS: the group's preset; empty means the instance default.

Editing a group changes access for everyone in it ("3 users are in this group; the change applies to all of them"). Taking a profile away from a group with people first shows what they lose, with the AmneziaVPN keys that stop working, and the button turns into "Take it away from 3 people".

Profiles can also be added to a group from the profile's page (Add to a group).

Moving people between groups#

  • One person: user card → Access → Group, with the preview of what they lose and get.
  • Everyone of a group: delete the group and move its people (below). There is no bulk group change in the list.

Deleting a group#

  • An empty group goes at once: its profiles stay, only the group is removed.
  • A group with people asks where they go ("3 people are in the group. Where to move them?"), with "Everyone" preselected when it exists. Move 3 people and delete moves them and deletes the group in one step.
  • With no other group, there is nowhere to move them: make another group first.

Who can do what#

Every admin sees users and groups. The owner and helpers create, change and delete users and groups, issue links and keys, pick DNS presets for users and groups and reset the DNS a person picked on their page. Only the owner chooses which presets a node offers to people. See Security.

Edit this page on GitHub