Restore appliance
┌─────────────────────────────────────────────────────────────────────────────┐
│ Restore on node1 (Version X.X.X build XXXX) │
└─────────────────────────────────────────────────────────────────────────────┘
┌─┬───────────────────────────────────────────────────────────────────────────┐
│1│Restore this appliance from a backup │
│2│Import backup PGP keys (Complete this first) │
└─┴───────────────────────────────────────────────────────────────────────────┘
Move the cursor or enter a it's corresponding number (Q to Quit)
Main> System Settings> Restore>
Danger
This is the single most destructive operation available in the console. It replaces everything on this appliance with the content of the chosen backup — there is no undo once you pass the final “Ready to start the restore process?” confirmation. Read every prompt before answering; do not reflexively press Enter/Y.
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
This procedure will completely DESTROY any existing information on this
appliance and fully replace it with the content of the specified backup.
ALL INFORMATION ON THIS APPLIANCE WILL BE LOST.
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
Please ensure you have imported the appropriate backup PGP Key before proceeding.
This should be done from "Main> System Settings> Restore> Import backup PGP keys"
Continue with full appliance restore from a backup? (<Y>/n): y
A full appliance restore can either be done from:
1. A local backup. I.e. a backup created on this appliance.
2. A backup transferred from an another server. (Either manually or automatically)
3. A backup copied to a USB stick.
A restore from the local backup, will restore this appliance to a previous known state
A restore from a backup transferred from an another server will make this appliance
a copy of the appliance the backup was created on.
A restore from a backup stored on a USB stick, will make this appliance a copy of the
appliance the backup was created on.
Optionally, vital system configuration (IP address, DNS settings etc) from this appliance,
can be preserved in all 3 cases.
All local backups will be stored in "/isodevice/persistent/backup"
Any automatically transferred backups will be stored in "/isodevice/var/remote_restore"
Any manually transferred backups will be stored in "/isodevice/var/transfer"
Restore appliance from a local backup? (<Y>/n): n
Restore appliance from an automatically transferred backup from another appliance? (<Y>/n): n
Restore appliance from a manually transferred backup of another appliance? (<Y>/n): y
Choose backup image to restore from (Q to Quit) <node1-StoredSafe-2024-01-15_02-00-01.tar.bz2.gpg>:
Selecting "node1-StoredSafe-2024-01-15_02-00-01.tar.bz2.gpg" as the backup image to restore from.
The backup is PGP encrypted, a passphrase will be needed to decrypt the backup.
Passphrase: <passphrase for the backup PGP key>
Attempting to decrypt the backup image "node1-StoredSafe-2024-01-15_02-00-01.tar.bz2.gpg"
Successfully decrypted image to "/isodevice/var/root/system-restore.tar.bz2"
It is possible to preserve the following local configuration from this appliance:
- Hostname (node1)
- Web FQDN (safe.corp.com)
- IPv4 and IPv6 settings; such as address, subnetmask, static routes and default gateway
- DNS Settings (Domain, searchdomain and nameservers)
- SSH Configuration and host keys
- Firewall rules
- Password for the console user "storedsafe"
- 2FA StoredSafe (RADIUS) settings
- Backup configuration
- NTP settings
- SNMP configuration
- rc.local settings
- X.509 certificate and chains
- syslog settings
- License, custom logo, custom nginx configuration
The net effect is that it is possible to restore another appliance backup
to this appliance, but keep selected local system configuration.
Preserve local configuration? (y/<N>): y
Preserved local configuration as /isodevice/var/root/preserve-config.tar.bz2
Extracting backups from the decrypted restore image
Found appliance backup as "/isodevice/var/root/node1-StoredSafe-filesystem-2024-01-15_02-00-01.tar"
System is now ready to start the full restore.
- MySQL will be stopped, to avoid database inconsistencies
- A full system backup will be restored
- Local configuration files will be preserved
When completed the system needs to be rebooted.
Ready to start the restore process? (<Y>/n): y
Restoring the backup.
Restoring preserved configuration files.
Setting hostname to "node1"
Setting Web FQDN to "safe.corp.com"
Removing temporary files.
NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
Restore complete.
You must now reboot the appliance to complete the restore.
NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
Reboot the appliance? (<Y>/n): y
Note
“Preserve local configuration” is what makes it possible to restore a backup taken on a different appliance onto this one while keeping this appliance’s own identity (hostname, IP, certificates, etc.) — this is the mechanism used, for example, to bring a secondary/passive HA node up to date from the primary’s backup during an upgrade without also copying over the primary’s network identity. If you decline it, the appliance will also adopt the network configuration baked into the backup itself.
Warning
If the backup image is not PGP-encrypted (unusual, but possible for manually created backups), the console proceeds without asking for a passphrase — double-check you selected the correct file before confirming the restore.