Create a restorable copy of your Buttons configuration after initial setup and before making substantial changes. Backups remain on the Buttons host until you copy or protect them elsewhere.
Before you begin#
A backup rule can include secret values used by connections. This makes a complete restore easier, but it also makes the backup file sensitive. Store backups somewhere that is accessible only to authorized people and included in your normal backup protection.
Add a backup rule#
- Open Settings → Backups.
- Select Add Backup Rule.
- In Rule Name, enter a recognizable name such as
Daily Buttons backup. - Leave the rule Enabled so it can run automatically.
- Choose whether to Include secrets.
Keep secrets included when the backup is intended for a complete recovery. Exclude them when the file will be handled somewhere that should not receive connection credentials; those values will need to be entered again after a restore.
- Under Cron Schedule, choose when the automatic backup should run. The schedule follows the time on the Buttons host.
- Under Backup Path, leave the field empty to use the default backup directory within the Buttons storage location, or enter a directory available to the Buttons host.
- Review Backup Name Pattern. The default produces names such as
buttons-backup-20260812-153000.zip. - Under Number of Backups to Keep, choose how many files should remain before Buttons removes the oldest files.
- Select Save.
A newly created rule starts enabled, runs daily at midnight according to the Buttons host, includes secrets, keeps 10 files, and uses the default backup location unless you change those settings.
Create a backup now#
After saving the rule, select Run Now. Save first because Run Now uses the stored rule rather than unsaved changes still shown in the form.
Buttons displays Backup created with the filename and size. The file then appears under Previous Backups, where you can see:
- Its filename and size
- When it was created
- The Buttons version that created it
- Whether it came from a beta release
- No secrets when secret values were excluded
The backup is stored on the Buttons host; Run Now does not download it through the browser.
Keep the backup useful#
Check Settings → Backups periodically for each rule's last successful run or latest error. Keep several files so a newer backup does not replace your last known-good state, and protect or copy the backup directory elsewhere so loss of the Buttons host does not destroy every copy.
Do not select a backup's restore icon merely to test that the file exists. Restoring replaces configuration and restarts Buttons. See
Restore a backup and verify it and use a suitable maintenance window when you need to test recovery.
Where to go next#
- Restore a backup and verify it, when you need to recover from one of these backups.
- Continue configuring Buttons, then create another known-good backup before major upgrades or changes to routing, access, connections, or automation.
