Manager
Sign in to Manager, understand its main pages, and perform administrative actions safely.
Manager is WuKongIM's administrative console. It shows node state, runs tasks, manages backups, and controls scaling. Treat it like a database administration console because it has powerful access.
Check these items before opening Manager
- Enable
manager.auth_onin production and replace the default password andmanager.jwt_secret. - Bind Manager to loopback or a management-network address; do not expose node port
5301publicly. - For individual remote access, use the SSH tunnel in Linux deployment. For shared access, use an HTTPS proxy through a management network or VPN.
- Keep the proxy-to-node connection inside the controlled network and allow only the management proxy and authorized operator sources through the firewall.
Keep authentication and transport protection enabled
manager.auth_on=false is not read-only mode. SSH, VPN, and HTTPS protect the access path; Manager login and resource permissions must remain enabled separately.
What the main pages mean
| Page | Think of it as | What to check |
|---|---|---|
| Nodes / Realtime | The state of each WuKongIM server | Readiness, CPU, memory, disk, connections, and queues |
| Controller / Tasks | The cluster coordinator and its administrative jobs | Availability, task completion, and blocking reasons |
| Slots | The 256 fixed data partitions | Leader, replica, and ISR health |
| Channels | The runtime unit for a direct chat or group | Leader, membership, and unusual backlogs |
| Backups | Backup plans, storage, archives, and restore | Storage test, archive completion, and verification |
The Leader is the node currently responsible for the data. A replica is another copy, and the ISR is the set of replicas that are keeping up. New operators normally only need to confirm that these fields are healthy; do not adjust them manually.
Split account permissions
| Work | Common permissions |
|---|---|
| View nodes and scaling state | cluster.node:r |
| Join, activate, drain, or remove nodes | cluster.node:w |
| View or operate Slots | cluster.slot:r / cluster.slot:w |
| View or change backups | cluster.backup:r / cluster.backup:w |
| Restore data | Explicit cluster.restore:w is required |
Do not give every operator permanent full access. At minimum, separate read-only observation, node management, backup management, and restore roles.
Perform one action safely
- Record the operator, target, current state, and expected result.
- Confirm that
/readyzpasses and that no conflicting administrative task is still running. - If the page offers Plan or Preview, run it first and read every blocking reason.
- Perform one step, wait for the task to finish, and refresh the authoritative state.
- Test message send, receive, and reconnect before continuing.
A clickable button is not approval
Scale-in may remove a node only after authoritative state reports safe_to_remove=true. Restore requires full verification, password reauthentication, and a confirmation phrase. Stop when state is missing, stale, or conflicting.
Manager changes WuKongIM cluster state. It does not shut down cloud servers, reduce Kubernetes instances, or hot-reload startup configuration. Continue with Health & Monitoring.