From 8d8becd0f7478cd83c5528ccb0333dd411195feb Mon Sep 17 00:00:00 2001 From: Thariq Shanavas Date: Wed, 6 Nov 2024 14:09:53 -0700 Subject: [PATCH] docs: Added a note about avoiding redundant database backups (#13958) * Add note about built-in backups * npm run format:fix --- docs/docs/guides/template-backup-script.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/docs/guides/template-backup-script.md b/docs/docs/guides/template-backup-script.md index a0cd890a49..dd0b94ebb1 100644 --- a/docs/docs/guides/template-backup-script.md +++ b/docs/docs/guides/template-backup-script.md @@ -6,6 +6,15 @@ This script assumes you have a second hard drive connected to your server for on The database is saved to your Immich upload folder in the `database-backup` subdirectory. The database is then backed up and versioned with your assets by Borg. This ensures that the database backup is in sync with your assets in every snapshot. +:::info +This script makes backups of your database along with your photo/video library. This is redundant with the [automatic database backup tool](https://immich.app/docs/administration/backup-and-restore#automatic-database-backups) built into Immich. Using this script to backup your database has two advantages over the built-in backup tool: + +- This script uses storage more efficiently by versioning your backups instead of making multiple copies. +- The database backups are performed at the same time as the library backup, ensuring that the backups of your database and the library are always in sync. + +If you are using this script, it is therefore safe to turn off the built-in automatic database backups from your admin panel to save storage space. +::: + ### Prerequisites - Borg needs to be installed on your server as well as the remote machine. You can find instructions to install Borg [here](https://borgbackup.readthedocs.io/en/latest/installation.html).