mirror of
https://github.com/immich-app/immich.git
synced 2025-05-24 01:12:58 -04:00
fix(docs): Database dump warnings (#17676)
* docs * admin page * roadmap * whitespace * whitespace * no danger
This commit is contained in:
parent
dd1fcd5be5
commit
9e063c993c
@ -23,23 +23,32 @@ Refer to the official [postgres documentation](https://www.postgresql.org/docs/c
|
|||||||
It 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.
|
It 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`.
|
:::warning
|
||||||
As mentioned above, you should make your own backup of these together with the asset folders as noted below.
|
The automatic database dumps can be used to restore the database in the event of damage to the Postgres database files.
|
||||||
You can adjust the schedule and amount of kept backups in the [admin settings](http://my.immich.app/admin/system-settings?isOpen=backup).
|
There is no monitoring for these dumps and you will not be notified if they are unsuccessful.
|
||||||
By default, Immich will keep the last 14 backups and create a new backup every day at 2:00 AM.
|
:::
|
||||||
|
|
||||||
#### Trigger Backup
|
:::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.
|
||||||
|
:::
|
||||||
|
|
||||||
You are able to trigger a backup in the [admin job status page](http://my.immich.app/admin/jobs-status).
|
For disaster-recovery purposes, Immich will automatically create database dumps. The dumps are stored in `UPLOAD_LOCATION/backups`.
|
||||||
Visit the page, open the "Create job" modal from the top right, select "Backup Database" and click "Confirm".
|
Please be sure to make your own, independent backup of the database together with the asset folders as noted below.
|
||||||
A job will run and trigger a backup, you can verify this worked correctly by checking the logs or the backup folder.
|
You can adjust the schedule and amount of kept database dumps in the [admin settings](http://my.immich.app/admin/system-settings?isOpen=backup).
|
||||||
This backup will count towards the last X backups that will be kept based on your settings.
|
By default, Immich will keep the last 14 database dumps and create a new dump every day at 2:00 AM.
|
||||||
|
|
||||||
|
#### Trigger Dump
|
||||||
|
|
||||||
|
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
|
#### 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.
|
Then please follow the steps in the following section for restoring the database.
|
||||||
|
|
||||||
### Manual Backup and Restore
|
### Manual Backup and Restore
|
||||||
|
@ -266,8 +266,8 @@ const milestones: Item[] = [
|
|||||||
withRelease({
|
withRelease({
|
||||||
icon: mdiDatabaseOutline,
|
icon: mdiDatabaseOutline,
|
||||||
iconColor: 'brown',
|
iconColor: 'brown',
|
||||||
title: 'Automatic database backups',
|
title: 'Automatic database dumps',
|
||||||
description: 'Database backups are now integrated into the Immich server',
|
description: 'Database dumps are now integrated into the Immich server',
|
||||||
release: 'v1.120.0',
|
release: 'v1.120.0',
|
||||||
}),
|
}),
|
||||||
{
|
{
|
||||||
|
10
i18n/en.json
10
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_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>.",
|
"authentication_settings_reenable": "To re-enable, use a <link>Server Command</link>.",
|
||||||
"background_task_job": "Background Tasks",
|
"background_task_job": "Background Tasks",
|
||||||
"backup_database": "Backup Database",
|
"backup_database": "Create Database Dump",
|
||||||
"backup_database_enable_description": "Enable database backups",
|
"backup_database_enable_description": "Enable database dumps",
|
||||||
"backup_keep_last_amount": "Amount of previous backups to keep",
|
"backup_keep_last_amount": "Amount of previous dumps to keep",
|
||||||
"backup_settings": "Backup Settings",
|
"backup_settings": "Database Dump Settings",
|
||||||
"backup_settings_description": "Manage database backup 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",
|
"check_all": "Check All",
|
||||||
"cleanup": "Cleanup",
|
"cleanup": "Cleanup",
|
||||||
"cleared_jobs": "Cleared jobs for: {job}",
|
"cleared_jobs": "Cleared jobs for: {job}",
|
||||||
|
Loading…
x
Reference in New Issue
Block a user