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.

The Settings page in the Admin area lets you control every aspect of the panel that is configurable at runtime. Changes take effect immediately after you click Save — no restart is required. Navigate to Admin → Settings to get started.

Application settings

General settings that affect the panel’s branding and behavior.
The display name of your panel instance. This appears in the browser title bar and in email notifications. Maximum 64 characters.
The default locale used for new users and for the admin UI. This is a BCP 47 language tag (for example, en or de). Users may override this individually if Allow changing language is enabled under user settings.
A URL pointing to an image used as the panel icon (favicon/logo area) and an optional banner image shown on the login page. Both fields accept any URL up to 255 characters. You can pick from previously uploaded assets using the autocomplete.
The canonical public URL of your panel — for example, https://panel.example.com. This is used to construct redirect URLs and links in emails. It must be a valid URL.
Controls which users are required to have 2FA enabled before they can log in:
OptionEffect
None2FA is optional for all users
AdminsOnly users with admin access must enroll
All usersEvery user must enroll before accessing the panel
When enabled, anyone can create an account at the login page. When disabled, accounts must be created by an admin via Admin → Users or the CLI. You will be asked to confirm before enabling registration if no CAPTCHA is configured.
Allows Calagopus to send anonymous usage data to help improve the project. No personally identifiable information is included. You can preview the exact payload before sending by clicking Preview Telemetry.

WebAuthn settings

These settings control passkey and hardware security key support.
The domain your panel is served from, without a scheme or port — for example, panel.example.com. This must match the domain in the browser’s address bar exactly. Changing this value after users have enrolled passkeys will invalidate those credentials.
The full origin URL including scheme — for example, https://panel.example.com. Must be a valid URL.
Changing the RP ID or RP origin after users have registered passkeys or security keys will prevent those credentials from working. Affected users will need to re-enroll their devices.

Server settings

Limits and permissions that apply to servers and their file managers.
Maximum size in bytes of a file that can be viewed in the in-browser file editor. Files larger than this limit show a download prompt instead.
Maximum size in bytes of a file that participates in in-browser content search.
Maximum number of results returned by a file manager search query.
Maximum number of subusers (co-owners) that can be added to a single server.
Maximum number of steps allowed in a single server schedule.
When enabled, users can override the Docker image specified by the egg with a custom image string.
When enabled, users can view the output of a server’s installation script while it runs.
When enabled, users can see live progress when a server is being transferred between nodes.

User settings

Limits that apply to user accounts panel-wide.
Maximum number of server groups a user can create.
Maximum number of API keys a user can hold at one time.
Maximum number of saved command snippets per user.
Maximum number of WebAuthn security keys (passkeys) a user can register.
Maximum number of SSH public keys a user can store.
When enabled, users can override the panel’s default language from their account settings.

Activity log settings

Control how long activity logs are retained and what gets logged.
How long (in days, 1–3650) admin activity records are kept. You can also set an optional maximum record count; when both limits are set, whichever is reached first causes older records to be pruned.
Same retention controls as admin logs, applied to user-level activity events.
Retention for server activity events. Additionally:
  • Log admin activity on servers — records actions taken by admins in the server context.
  • Log schedule activity — records when scheduled tasks run.

CAPTCHA settings

CAPTCHA challenges protect the registration and login forms from automated abuse. Select a provider from the Provider dropdown. When you switch providers, new fields appear for the credentials required by that provider.
No CAPTCHA challenge is shown. Suitable for panels that restrict registration or are used in private environments.
Running without CAPTCHA and with open registration exposes your panel to automated account creation. Enable at least one CAPTCHA provider if registration is open.

Rate limit settings

Rate limits protect endpoints from brute-force and abuse. Each endpoint accepts a limit (maximum requests) and a period (window in seconds).
EndpointDefault protection
auth_registerNew account registration
auth_loginPassword login attempts
auth_login_checkpoint2FA checkpoint
auth_login_security_keyWebAuthn login
auth_password_forgotPassword reset requests
clientGeneral client API requests
client_servers_backups_createBackup creation per server
client_servers_files_pullRemote file pull requests
client_servers_files_pull_queryFile pull status queries

Saving settings

Each settings section has its own Save button. Click Save after making changes in a section to apply them. Settings are validated before saving; the form will highlight any invalid fields.
You need the settings.update admin permission to save changes. If the button is disabled, check with your panel owner about your role.

Build docs developers (and LLMs) love