Backup & Restore

The Backup page allows you to create manual backups, schedule automatic backups, and restore deployments from backup archives.

Backups Overview

The main backup list shows all available backups across your deployments:

• Deployment — Source deployment name
• Created — Backup timestamp
• Size — Archive file size
• Type — Manual or scheduled
• Status — Completed, in progress, or failed

Filtering Backups

Use the filter options to find specific backups:

• Deployment — Filter by deployment
• Date Range — Select time period
• Type — Manual or scheduled

Creating a Backup

1. Click "Create Backup"
2. Select the deployment to backup
3. Configure backup options:
   • Include Files — Backup filesystem data
   • Include Database — Backup database dump
   • Description — Add a note (optional)
4. Click "Start Backup"

The backup runs in the background. You can monitor progress in the Jobs section.

Backup from Deployment Page

You can also create a backup directly from a deployment's detail page:

1. Navigate to the deployment
2. Go to the Backups tab
3. Click "Create Backup"

Restoring from Backup

Restore a deployment to a previous state using a backup.

1. Find the backup you want to restore
2. Click the restore icon (↻) or "Restore" button
3. Configure restore options:
   • Target Deployment — Restore to original or different deployment
   • Restore Files — Restore filesystem data
   • Restore Database — Restore database from dump
   • Auto Start — Start deployment after restore
4. Review the warning about data overwrite
5. Click "Restore"

Restore to New Deployment

You can restore a backup as a new deployment:

1. Select the backup
2. Click "Restore"
3. Choose "New Deployment" as target
4. Enter a name for the new deployment
5. Complete the restore

Downloading Backups

Download a backup archive to your local machine:

1. Find the backup in the list
2. Click the download icon (⬇)
3. Save the .tar.gz file

Deleting Backups

1. Select the backup(s) to delete
2. Click "Delete Selected" or the trash icon
3. Confirm deletion

Backup Jobs

The Jobs tab shows the status of ongoing and recent backup/restore operations:

Click on a job to see detailed progress and logs.

Scheduled Backups

Configure automatic backups from the deployment's backup settings or via the Scheduler.

From Deployment Settings

1. Navigate to the deployment
2. Go to Settings → Backups
3. Enable "Scheduled Backups"
4. Configure the schedule:
   • Frequency — Daily, weekly, or custom cron
   • Time — When to run the backup
   • Retention — How many backups to keep
5. Save settings

Using the Scheduler

For more control, use the Scheduler to create backup tasks with custom cron expressions.

Backup Configuration

Fine-tune backup settings for each deployment:

Exclusion Patterns

Exclude files from backups using glob patterns:

• *.log — Exclude log files
• cache/* — Exclude cache directory
• node_modules/* — Exclude npm packages
• .git/* — Exclude git history

Database Selection

If your deployment has multiple databases, select which ones to include in backups.

Backup Storage

Backups are stored on the server at the configured backup path. The backup list shows:

• Total storage used
• Available space
• Backup count per deployment

Best Practices

• Regular backups — Schedule daily backups for important deployments
• Test restores — Periodically verify backups by restoring to a test environment
• Off-site copies — Download critical backups for off-site storage
• Pre-change backups — Always backup before updates or migrations
• Retention policy — Balance storage space with backup history needs

Keyboard Shortcuts