Backup and Restore¶
This section covers configuration backup and restore operations in FloofOS.
Overview¶
FloofOS supports exporting and importing configuration backups as compressed archives (.tar.gz). Backups include all configuration files and can be transferred off-device for safekeeping.
Backup Storage Location¶
By default, backups are stored in:
Backup files can be downloaded using SCP or SFTP for off-device storage.
Exporting Backups¶
Standard Export (Recommended)¶
Syntax¶
Parameters¶
| Parameter | Description |
|---|---|
name | Backup filename (without extension) |
Example¶
The backup is saved to the default location as backup1.tar.gz.
Export to Custom Path¶
Syntax¶
Parameters¶
| Parameter | Description |
|---|---|
name | Backup filename (without extension) |
path | Target directory path |
Example¶
Viewing Backups¶
Syntax¶
Displays exported backup files (name, timestamp, and size) from the default backup directory, followed by the rollback commit history.
Output Description¶
| Section | Description |
|---|---|
| Location | Default backup directory |
| Backup list | Name, timestamp, and size of each backup |
| Rollback History | Commit history for rollback operations |
Backup Display
Backup files are displayed without the .tar.gz extension, but the actual files include this extension. Only backups in the default location (/etc/floofos-config/backups) are shown.
Importing Backups¶
Standard Import (Recommended)¶
Syntax¶
Parameters¶
| Parameter | Description |
|---|---|
name | Backup filename (without extension) |
Example¶
Import from Custom Path¶
Syntax¶
Example¶
Post-Import Procedure¶
After importing a backup:
-
Commit the imported configuration:
-
Reboot the system:
Reboot Required
Configuration from imported backups requires a system reboot to take full effect.
Transferring Backups¶
Downloading Backups (SCP/SFTP)¶
Use SCP or SFTP to download backups from the router:
Uploading Backups¶
Upload previously exported backups:
# To default location
scp backup1.tar.gz floofos@router:/etc/floofos-config/backups/
# To custom location
scp backup1.tar.gz floofos@router:/tmp/
Command Reference¶
| Command | Description |
|---|---|
backup export <name> | Export backup to default location |
backup export <name> path <path> | Export backup to custom path |
backup import <name> | Import backup from default location |
backup import <name> path <path> | Import backup from custom path |
show backups | Display available backups |
commit | Commit imported configuration |
system reboot | Reboot after import |
Best Practices¶
- Regular backups - Create backups before and after major changes
- Off-device storage - Transfer backups to external storage
- Descriptive names - Use meaningful backup names (e.g.,
pre-ixp-migration) - Verify backups - Check
show backupsafter export - Document custom paths - Record path if using non-default location
- Test restore procedure - Periodically verify backup integrity