Backups
Pro only
Create backups via CLI
Self-Hosted
Backups can be created via a CLI command or an API request. The backup archive contains a database export and all uploaded files.
Execute following command to create a backup:
Create backup via CLI | |
---|---|
1 |
|
Backups can be encrypted using a 256-bit AES key.
Specify the key as hex string via the --key
CLI argument.
Create encrypted backup via CLI | |
---|---|
1 |
|
Create a backup during update
When updating SysReptor, you can use the --backup
switch, which will create a backup before applying the update.
Create backups via web interface
Cloud · Self-Hosted
Users with superuser
permissions and access to the BACKUP_KEY
can create backups using the web interface.
If no BACKUP_KEY
is configured, you cannot create backups via the web interface.
Create backups via API
Cloud · Self-Hosted
Users with superuser
permissions and system
users can create backups via the API in combination with the configured BACKUP_KEY
.
If no BACKUP_KEY
is configured, the backup API endpoint is disabled.
The backup can optionally be encrypted via a 256-bit AES key provided in the HTTP request body or pushed to an S3 bucket (see API parameters).
API Requests
1 2 3 4 5 |
|
Restore backups
Self-Hosted
Make sure that you have an empty database and empty data directories (i.e. empty docker volumes). Otherwise, you will lose your old data. During the backup restore, all existing data in the database and file storages is deleted.
It is recommended to import the backup into the same SysReptor version like the one that was used to create the backup. If a different version is used the database schema might not be compatible.
Restore backup via CLI | |
---|---|
1 |
|
Encrypted backups can be restored as well. Specify the AES key as hex string via the --key
CLI argument.
Restore encrypted backup via CLI | |
---|---|
1 |
|