Backup

---

This documentation is deprecated/obsolete. Lute v2 has been replaced by Lute v3, a full Python rewrite. Please see the Lute v3 manual which includes notes on installation. If you have Lute v2, you can easily migrate to v3. Thank you!

---

Lute provides a simple backup facility that creates copies your Sqlite database and all of your term images to a backup folder that you specify.

Sample config section (for non-Docker users):

BACKUP_ENABLED=true
BACKUP_DIR=/full/path/to/your/backup/folder
BACKUP_AUTO=yes
BACKUP_WARN=yes
BACKUP_COUNT=5

The Docker backup configuration is similar, but Docker users must set a BACKUP_HOST_DIR key, instead of BACKUP_DIR.

Configuration key	Values	Notes
BACKUP_ENABLED	yes or no	This key is required. Set BACKUP_ENABLED=no if you're handling your own backups with scripts or whatever, and BACKUP_ENABLED=yes if you want to run them through the Lute UI or have Lute do daily backups.
BACKUP_DIR (Non-Docker users only)	Full directory path	This is the existing directory where a gzipped database export, and copy of all of your images, will be sent. Set this to something that is backed up, such as to a DropBox folder or similar. For me on my mac, I have this set to BACKUP_DIR=/Users/jeff/Dropbox/LuteBackup.
BACKUP_HOST_DIR (Docker users only)	Full directory path	This is the existing directory where a gzipped database export, and copy of all of your images, will be sent. Set this to something that is backed up, such as to a DropBox folder or similar. This folder is mounted to the Docker container, so that the backup actually gets written onto your machine.
BACKUP_AUTO	yes or no	If yes, Lute will run the backup from the Home page every day. Note that this is only from the Home page, so if you have a book open for reading for 2 weeks, it won't be backed up. :-)
BACKUP_WARN	yes or no	If yes, Lute will print a warning on the Home page if the last backup was run more than one week ago. Again, this is only from the home page.
BACKUP_COUNT	Number	The number of automatic backup files to keep. Backups are created with date-time stamp added (e.g. lute_backup_2023-04-19_204452.db.gz), and Lute only keeps the BACKUP_COUNT most recent backups. Note that this number is only used for automatic backups (if you have BACKUP_AUTO set to "yes" or "true"). For "manual" backups (where you click the link to create a backup from the Home page), you have to delete old files.