Backup storage
Choose where your nodes put the server backups they take.
One setting covers every node. Open Admin > Backup Storage, which needs the server backups license feature.
The three places
| Type | Where the backups go |
|---|---|
| Local | On each node, on its own disk. No node can read another one. |
| S3 / MinIO | Any S3-compatible storage, including Amazon S3, MinIO, Backblaze B2, Wasabi and DigitalOcean Spaces. |
| SFTP | A remote SFTP server. |
MinIO is not a type of its own. Pick S3 / MinIO and turn on path-style URLs.
A new install starts on Local, at /var/lib/badger-daemon/backups.
Local
| Field | Description | Default |
|---|---|---|
| Storage Path | The directory on each node that holds the backups. Give a full path. | /var/lib/badger-daemon/backups |
S3 and MinIO
| Field | Description | Default |
|---|---|---|
| Endpoint URL | The address of the storage, such as s3.amazonaws.com. | empty |
| Bucket Name | The bucket the backups go in. | badger-backups |
| Access Key ID | The access key. | empty |
| Secret Access Key | The secret key. The panel masks it once saved. | empty |
| Region | The storage region. | us-east-1 |
| Presigned URL Expiry (seconds) | How long a download link works for. | 3600 |
| Use SSL/TLS | Connect over HTTPS. | on |
| Use Path-Style URLs (required for MinIO) | Puts the bucket in the path instead of the hostname. Turn it on for MinIO. | off |
SFTP
| Field | Description | Default |
|---|---|---|
| Host | The address of the server. | empty |
| Port | The port. | 22 |
| Username | The login name. | empty |
| Password (optional) | Fill this in to sign in with a password, or leave it blank to use a key. | empty |
| Private Key (PEM format, optional) | Your private key. | empty |
| Key Passphrase (optional) | The passphrase, when the key has one. | empty |
| Base Path | The directory the backups go in. | /backups |
| Known Hosts Entry (optional) | The host key line. Fill it in to check the server is the one you expect. | empty |
Give either a password or a private key. The test fails with neither.
Saving it
- Pick the type.
- Fill in the fields.
- Click Test Connection.
- Click Save.
Saving sends the settings to every connected node, and each one keeps them across a restart. A node that reconnects later gets them then.
Push to All Daemons sends them again. Use it after a node has been offline a long while, or when one reports settings you do not recognise.
Backups you already have stay where they are. A change of type applies to new ones.
Full and incremental
The server owner picks the type in the Create Backup dialog.
| Type | What it does |
|---|---|
| Incremental | Uploads only the parts of a file that changed. This is the default. |
| Full | Writes one archive for each backup. Slower and larger. |
An incremental backup follows the path filters set on the game. Set those on the Backup Paths tab of the egg, and a server owner can set them per server. See Eggs.
Lock this backup in the same dialog stops it being deleted. Unlock it first to delete it.
How many a server keeps
That count belongs to the server, not to this page.
- Backup Limit on the server sets how many it keeps.
- Your license sets the highest that field can go.
Storage that comes with your panel
Your installation includes object storage of its own, with a bucket named badger-backups ready to use. Its credentials are in the credentials file the installer wrote.
Nothing points at it until you say so.
- Open Admin > Backup Storage and pick S3 / MinIO.
- Enter its address, the access key and the secret key.
- Turn on Use Path-Style URLs (required for MinIO).
- Click Test Connection, then Save.
Next steps
- Server management to take and restore a backup
- Eggs to set which files a backup includes
- Panel configuration for the rest of the panel settings