-
Notifications
You must be signed in to change notification settings - Fork 0
Backup and Restore
SCM Helper can backup all the data available via the API.
NOTE: Not all data in SCM is backed up - some things are not available via the API. But most is.
Press the backup
button in the GUI, or run scm --backup
The backups are stored encrypted (Fernet AES 128 in CBC mode) in a backup
folder in the scm-helper
folder.
Only one backup per-day is kept. I.e., if you run backup multiple times in a day, only the last one will be kept.
You will not be able to read the backup files - they are encrypted. Use scm --dump
to view them.
Restore is only available via the command line.
Run
scm -restore <type>
where <type>
refers to what you want to restore: member, list, session etc.
You will then be prompted for the name of the member, list, session etc that you wish to restore.
NOTE: The restore is work in progress, and very scenario dependent on exactly need to be restored. Not everything be restored via the API - some manual intervention via the GUI is likely in some scenarios - but at least you have the data to refer to (via the scm --dump
option).
If you need to perform a recovery, and have exhausted options with the SCM Help team, contact me and we can look at how the tool may be able to help.
If you change the Swimming Club Name in config.yaml
or forget your password, backups will not be accessible.
Each backup set stores a copy of the config and encrypted password, so if you recall the password used at the time, recovery might be possible. Raise an issue and seek help!