Everything there is to know about using our backups!

What makes us different?

Ember Host uses something called Borg backups, which has some huge benefits over the S3 backup system that comes with Pterodactyl by default: de-duplicated and incremental backups. This means that each individual backup taken will only include changes since the last backup - hugely decreasing the amount of time backups take after the first one is created.

Creating a backup

Here's how to make a backup - start by heading over to the backups tab on our panel, and click Create Backup.

Selecting files to include here will override the existing backupPattern.lst

Creating scheduled backups

Schduled backups are simple - you can use our inbuilt schedules feature in our panel, which allows for automated backup creation at whatever times you specify. When you reach the backup limited, the oldest non-locked backup will be deleted to make space for the new one the schedule creates. Curious on how to create a schedule? Check out our page on schedules!

Choosing which files are included in a scheduled backup

Go into the files tab of the panel. Then, click 'New File' -> type up your patternfile -> save it as backupPattern.lst

P sh
- ./backups/**
- ./bluemap/web/maps/**/tiles/**
- ./dynmap/web/tiles/**
- ./crash-reports/**
- ./logs/**

P sh dictates the start of the backupPattern.lst file

For Borg, lines in a pattern file start with + for include patterns and - for exclude patterns. - ./backups/** tells Borg to exclude the backups directory and all its contents. The ** pattern matches any files and subdirectories recursively.

- ./bluemap/web/maps/**/tiles/** excludes all tiles directories under any directory within ./bluemap/web/maps/, including their contents.

- ./dynmap/web/tiles/** excludes all content within the ./dynmap/web/tiles/ directory, recursively.

- ./crash-reports/** and - ./logs/** exclude the crash-reports and logs directories respectively, along with all their contents.

Further Examples

To include a specific directory and all its contents: + /path/to/directory/**

To exclude a specific directory: - /path/to/directory/**

To include all .yml files in a specific directory: + /path/to/directory/**/*.yml

To exclude all .log files: - *.log

By @goldenedit and @icewaffles

Last updated