High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
fix(docs): Database dump warnings (#17676)
Matthew Momjian9e063c993c36
diff --git a/docs/docs/administration/backup-and-restore.md b/docs/docs/administration/backup-and-restore.mdindex 817a7dca6d..7e55e4e88f 100644--- a/docs/docs/administration/backup-and-restore.md+++ b/docs/docs/administration/backup-and-restore.md@@ -23,23 +23,32 @@ Refer to the official [postgres documentation](https://www.postgresql.org/docs/cIt is not recommended to directly backup the `DB_DATA_LOCATION` folder. Doing so while the database is running can lead to a corrupted backup that cannot be restored.:::-### Automatic Database Backups+### Automatic Database Dumps-For convenience, Immich will automatically create database backups by default. The backups are stored in `UPLOAD_LOCATION/backups`.-As mentioned above, you should make your own backup of these together with the asset folders as noted below.-You can adjust the schedule and amount of kept backups in the [admin settings](http://my.immich.app/admin/system-settings?isOpen=backup).-By default, Immich will keep the last 14 backups and create a new backup every day at 2:00 AM.+:::warning+The automatic database dumps can be used to restore the database in the event of damage to the Postgres database files.+There is no monitoring for these dumps and you will not be notified if they are unsuccessful.+:::++:::caution+The database dumps do **NOT** contain any pictures or videos, only metadata. They are only usable with a copy of the other files in `UPLOAD_LOCATION` as outlined below.+:::++For disaster-recovery purposes, Immich will automatically create database dumps. The dumps are stored in `UPLOAD_LOCATION/backups`.+Please be sure to make your own, independent backup of the database together with the asset folders as noted below.+You can adjust the schedule and amount of kept database dumps in the [admin settings](http://my.immich.app/admin/system-settings?isOpen=backup).+By default, Immich will keep the last 14 database dumps and create a new dump every day at 2:00 AM.-#### Trigger Backup+#### Trigger Dump-You are able to trigger a backup in the [admin job status page](http://my.immich.app/admin/jobs-status).-Visit the page, open the "Create job" modal from the top right, select "Backup Database" and click "Confirm".-A job will run and trigger a backup, you can verify this worked correctly by checking the logs or the backup folder.-This backup will count towards the last X backups that will be kept based on your settings.+You are able to trigger a database dump in the [admin job status page](http://my.immich.app/admin/jobs-status).+Visit the page, open the "Create job" modal from the top right, select "Create Database Dump" and click "Confirm".+A job will run and trigger a dump, you can verify this worked correctly by checking the logs or the `backups/` folder.+This dumps will count towards the last `X` dumps that will be kept based on your settings.#### Restoring-We hope to make restoring simpler in future versions, for now you can find the backups in the `UPLOAD_LOCATION/backups` folder on your host.+We hope to make restoring simpler in future versions, for now you can find the database dumps in the `UPLOAD_LOCATION/backups` folder on your host.Then please follow the steps in the following section for restoring the database.### Manual Backup and Restorediff --git a/docs/src/pages/roadmap.tsx b/docs/src/pages/roadmap.tsxindex b7ded8e8c9..205b976aed 100644--- a/docs/src/pages/roadmap.tsx+++ b/docs/src/pages/roadmap.tsx@@ -266,8 +266,8 @@ const milestones: Item[] = [withRelease({icon: mdiDatabaseOutline,iconColor: 'brown',- title: 'Automatic database backups',- description: 'Database backups are now integrated into the Immich server',+ title: 'Automatic database dumps',+ description: 'Database dumps are now integrated into the Immich server',release: 'v1.120.0',}),{diff --git a/i18n/en.json b/i18n/en.jsonindex c4b4746871..9951717de6 100644--- a/i18n/en.json+++ b/i18n/en.json@@ -39,11 +39,11 @@"authentication_settings_disable_all": "Are you sure you want to disable all login methods? Login will be completely disabled.","authentication_settings_reenable": "To re-enable, use a <link>Server Command</link>.","background_task_job": "Background Tasks",- "backup_database": "Backup Database",- "backup_database_enable_description": "Enable database backups",- "backup_keep_last_amount": "Amount of previous backups to keep",- "backup_settings": "Backup Settings",- "backup_settings_description": "Manage database backup settings",+ "backup_database": "Create Database Dump",+ "backup_database_enable_description": "Enable database dumps",+ "backup_keep_last_amount": "Amount of previous dumps to keep",+ "backup_settings": "Database Dump Settings",+ "backup_settings_description": "Manage database dump settings. Note: These jobs are not monitored and you will not be notified of failure.","check_all": "Check All","cleanup": "Cleanup","cleared_jobs": "Cleared jobs for: {job}",