Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/calagopus/panel/llms.txt

Use this file to discover all available pages before exploring further.

Calagopus has two levels of access: the admin panel and individual server access. Admin access is controlled through user accounts and roles. Server-level access is controlled through sub-users assigned directly to each server.

User accounts

Every person who logs into Calagopus has a user account. Accounts require a username, email address, first name, last name, and password. An optional language preference controls which locale the interface uses.

Creating a user

1

Open Users

In the admin panel, navigate to Users and click Create.
2

Fill in account details

Enter the username, email, first name, last name, and a temporary password. The user can change their password after logging in.
3

Assign a role (optional)

Select a role from the Role dropdown to grant the user specific admin permissions. Leave this blank for a regular user with no admin access.
4

Set admin flag (optional)

Enable the Admin toggle to give the user full, unrestricted access to the admin panel. This bypasses role-based permission checks.
5

Save

Click Save. The user can now log in immediately.
The Admin flag grants complete access to every admin function regardless of the user’s assigned role. Reserve it for trusted administrators only.

Managing existing users

From a user’s detail page you can:
  • Edit account details and reset their password
  • Send a password reset email to their address
  • Disable their two-factor authentication if they are locked out
  • Impersonate the user to troubleshoot issues as them
  • Delete the account
Impersonation lets an admin log in as any user without knowing their password. All actions taken during an impersonation session are attributed to the original user account, not the admin.

Two-factor authentication

Users can enable two-factor authentication (2FA) from their account settings. Once enabled, they must enter a TOTP code on every login. Admins can force-disable a user’s 2FA from the user’s detail page using the Disable Two Factor button. This is useful if a user loses access to their authenticator app.

Roles

Roles let you delegate specific admin tasks without granting full admin access. A role is a named collection of admin permissions and server permissions that you can assign to one or more users.

Creating a role

1

Open Roles

In the admin panel, navigate to Roles and click Create.
2

Name the role

Enter a descriptive name such as Node Manager or Support Agent.
3

Enable two-factor requirement (optional)

Toggle Require Two Factor to force all users assigned this role to have 2FA enabled before they can access admin functions.
4

Select admin permissions

Under Admin Permissions, choose which parts of the admin panel the role can access. Permissions are grouped by resource type.
5

Select server permissions

Under Server Permissions, choose which server-level actions users with this role can perform by default across all servers.
6

Save

Click Save. Assign the role to users from their account page.

Permission groups

Admin permissions are grouped by the resources they govern:

Servers

Create, read, update, delete, suspend, and transfer servers. Manage server allocations, databases, backups, and variables.

Nodes

Create, read, update, and delete nodes. Manage node allocations, configuration, logs, and transfers.

Users

Create, read, update, and delete user accounts. Send password reset emails, disable 2FA, and impersonate users.

Roles

Create, read, update, and delete roles. Assign roles to users.

Nests and eggs

Create, read, update, delete, and move eggs. Manage egg variables and install scripts.

Locations

Create, read, update, and delete locations.

Backup configurations

Create, read, update, and delete backup configurations and their S3 or Restic settings.

Activity logs

Read admin and server activity logs.

Sub-users

Sub-users are a separate concept from roles. A sub-user is a user who has been granted access to a specific server by its owner or an admin. Sub-users cannot access the admin panel; they can only interact with the servers they have been invited to. For instructions on adding and managing sub-users, see Server management — Subusers.

Build docs developers (and LLMs) love