Backups and restore¶
Everything Waylight knows lives in one SQLite database. This page explains what is backed up automatically, how to keep a copy away from the server and how to restore it. The examples use Docker Compose; the Raspberry Pi and native install guides cover the same steps for their paths.
Automatic backups¶
Waylight makes a consistent copy of the database once a day and keeps the
last seven. Both can be changed with BACKUP_INTERVAL and
BACKUP_RETENTION (configuration).
In Docker the backups are stored in the data volume under /data/backups.
Settings → Backups lists them and lets you download each one.
Backups contain the passwords and tokens of your integrations only in
encrypted form. Keep your SECRET_KEY separately, for example in your
password manager. A backup restored without the matching key still works,
but you will have to enter every integration password again.
Copies away from the server¶
A backup on the same disk does not help when that disk dies. Under Settings → Backups you can add an off-site target: any WebDAV folder, such as a Nextcloud folder with an app password. Each new backup is then uploaded there too, and the copies are pruned with their own retention. A failed upload raises a notification.
To copy the backups by hand instead:
sudo docker run --rm -v waylight-data:/data -v "$PWD":/backup alpine \
cp -r /data/backups /backup/
Restore in the web interface¶
Settings → Backups → Restore a backup:
- Pick a local or off-site backup, or upload a file.
- Enter your password, and your two-factor code if it is on.
- Waylight checks the file before touching anything: it must be an intact SQLite database with a Waylight schema that is not newer than the running version.
- The current database is kept as
waylight.db.before-restore, the backup takes its place, and Waylight restarts. Docker and systemd start it again with the restored data.
Restore without the web interface¶
If Waylight does not start any more:
- Stop it:
sudo docker compose stop waylight. - In the data volume, replace
waylight.dbwith the backup file and deletewaylight.db-walandwaylight.db-shmif they exist. - Start it again:
sudo docker compose start waylight.
Export and import¶
Settings → Import & export downloads your data as one JSON file: tabs and widgets, notes, to-dos, bookmarks, feeds and the other content of each module. Passwords, tokens and other secrets are never part of the export.
The export is not a replacement for backups. It is meant for moving data between installations, for keeping a readable copy and for starting over. Importing it into a fresh installation recreates your dashboard; you then enter the integration passwords again.
The same page imports bookmarks exported from a browser as an HTML file.
For settings you want to keep in Git or copy to another instance, the same
page also writes and reads waylight.yaml: see
Settings as a YAML file.