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 supports server backups with pluggable storage backends. Backups can be taken manually at any time or created automatically via schedules. Each server has a backup limit set by an admin, and backups can optionally be locked to prevent accidental deletion.

Creating a backup

1

Open the Backups tab

Navigate to your server and click Backups in the sidebar.
2

Click Create

Click the Create button. A dialog appears where you can configure the backup.
3

Set a name

Enter a descriptive name. A timestamped name is pre-filled automatically.
4

Add ignored files (optional)

Enter any file paths or glob patterns to exclude from the backup. For example, logs/*.log to skip log files.
5

Create

Click Create. The backup starts immediately. You can track its status in the backup list.
If you have reached your server’s backup limit, the Create button is disabled. Ask an admin to raise your limit or delete an existing backup first.

Backup list

The backup list shows all backups for the server. Each row displays:
ColumnDescription
NameThe backup name you provided
ChecksumSHA-256 hash of the backup archive, useful for integrity verification
SizeCompressed size of the backup
FilesNumber of files included
CreatedTimestamp of when the backup completed
LockedWhether the backup is protected from deletion

Restoring a backup

1

Open the context menu

In the backup list, click the actions menu (three dots) on the backup you want to restore.
2

Click Restore

Select Restore from the menu. A confirmation dialog appears.
3

Choose restore options

  • Truncate directory: When enabled, all existing files in the server’s working directory are deleted before the backup is extracted. When disabled, the backup contents are overlaid on top of the existing files.
  • Restore startup: When enabled (and if the backup contains startup metadata), the server’s startup command and Docker image are also restored to the state captured in the backup.
4

Confirm

Click Restore. The server will be put into a restoring state and restarted automatically when the restore is complete.
Restoring with Truncate directory enabled permanently deletes all current server files before extracting the backup. This action cannot be undone.

Backup configurations

Backup configurations define where backups are stored. They are created by admins and assigned to nodes or individual servers. A server inherits its backup configuration from its node, which in turn inherits from its location — unless a specific configuration is assigned at a lower level.

Backup storage types

Backups are stored directly on the Wings node’s filesystem in a directory managed by the daemon. No additional configuration is required. This is the default when no backup configuration is set.

Creating a backup configuration

1

Open Backup Configurations

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

Name the configuration

Enter a name and optional description.
3

Select the backup disk

Choose Local, S3, or Restic from the Backup Disk dropdown.
4

Fill in storage-specific settings

For S3, provide the access key, secret key, bucket, region, endpoint, and part size. Enable Using path-style URLs if your provider requires it (common with MinIO and Cloudflare R2).For Restic, provide the repository URL and any environment variables your Restic backend requires (for example, credentials for an S3-backed Restic repository).
5

Set sharing (optional)

Enable Shared if backups on this configuration are stored in a location accessible by all nodes (for example, a shared NFS mount or a common S3 bucket). This allows backup transfers between nodes without copying data.
6

Save

Click Save. Assign the configuration to a location or node from its detail page.

S3 settings reference

FieldDescription
Access KeyThe S3 access key ID
Secret KeyThe S3 secret access key
BucketThe name of the S3 bucket
RegionThe AWS region or provider-specific region string
EndpointThe S3-compatible endpoint URL (omit for native AWS S3)
Part SizeMultipart upload chunk size in bytes. Default is 1 GB
Using path-style URLsUse endpoint/bucket/key URLs instead of bucket.endpoint/key. Required for MinIO and some other providers
Maintenance mode on a backup configuration prevents new backups from being created while allowing existing ones to be read and restored.

Build docs developers (and LLMs) love