immich/docs/docs/administration/backup-and-restore.md

Backup and Restore

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

A 3-2-1 backup strategy is recommended to protect your data. You should keep copies of your uploaded photos/videos as well as the Immich database for a comprehensive backup solution. This page provides an overview on how to backup the database and the location of user-uploaded pictures and videos. A template bash script that can be run as a cron job is provided here

Database

:::caution Immich saves file paths in the database, it does not scan the library folder to update the database so backups are crucial. :::

:::info Refer to the official postgres documentation for details about backing up and restoring a postgres database. :::

The recommended way to backup and restore the Immich database is to use the pg_dumpall command. When restoring, you need to delete the DB_DATA_LOCATION folder (if it exists) to reset the database.

docker exec -t immich_postgres pg_dumpall --clean --if-exists --username=postgres | gzip > "/path/to/backup/dump.sql.gz"

docker compose down -v  # CAUTION! Deletes all Immich data to start from scratch.
# rm -rf DB_DATA_LOCATION # CAUTION! Deletes all Immich data to start from scratch.
docker compose pull     # Update to latest version of Immich (if desired)
docker compose create   # Create Docker containers for Immich apps without running them.
docker start immich_postgres    # Start Postgres server
sleep 10    # Wait for Postgres server to start up
gunzip < "/path/to/backup/dump.sql.gz" \
| sed "s/SELECT pg_catalog.set_config('search_path', '', false);/SELECT pg_catalog.set_config('search_path', 'public, pg_catalog', true);/g" \
| docker exec -i immich_postgres psql --username=postgres    # Restore Backup
docker compose up -d    # Start remainder of Immich apps

docker exec -t immich_postgres pg_dumpall --clean --if-exists --username=postgres > "\path\to\backup\dump.sql"

docker compose down -v  # CAUTION! Deletes all Immich data to start from scratch.
# Remove-Item -Recurse -Force DB_DATA_LOCATION # CAUTION! Deletes all Immich data to start from scratch.
docker compose pull     # Update to latest version of Immich (if desired)
docker compose create   # Create Docker containers for Immich apps without running them.
docker start immich_postgres    # Start Postgres server
sleep 10    # Wait for Postgres server to start up
gc "C:\path\to\backup\dump.sql" | docker exec -i immich_postgres psql --username=postgres    # Restore Backup
docker compose up -d    # Start remainder of Immich apps

Note that for the database restore to proceed properly, it requires a completely fresh install (i.e. the Immich server has never run since creating the Docker containers). If the Immich app has run, Postgres conflicts may be encountered upon database restoration (relation already exists, violated foreign key constraints, multiple primary keys, etc.).

:::tip Some deployment methods make it difficult to start the database without also starting the server or microservices. In these cases, you may set the environmental variable DB_SKIP_MIGRATIONS=true before starting the services. This will prevent the server from running migrations that interfere with the restore process. Note that both the server and microservices must have this variable set to prevent the migrations from running. Be sure to remove this variable and restart the services after the database is restored. :::

The database dumps can also be automated (using this image) by editing the docker compose file to match the following:

services:
  ...
  backup:
    container_name: immich_db_dumper
    image: prodrigestivill/postgres-backup-local:14
    env_file:
      - .env
    environment:
      POSTGRES_HOST: database
      POSTGRES_CLUSTER: 'TRUE'
      POSTGRES_USER: ${DB_USERNAME}
      POSTGRES_PASSWORD: ${DB_PASSWORD}
      POSTGRES_DB: ${DB_DATABASE_NAME}
      SCHEDULE: "@daily"
      POSTGRES_EXTRA_OPTS: '--clean --if-exists'
      BACKUP_DIR: /db_dumps
    volumes:
      - ./db_dumps:/db_dumps
    depends_on:
      - database

Then you can restore with the same command but pointed at the latest dump.

gunzip < db_dumps/last/immich-latest.sql.gz \
| sed "s/SELECT pg_catalog.set_config('search_path', '', false);/SELECT pg_catalog.set_config('search_path', 'public, pg_catalog', true);/g" \
| docker exec -i immich_postgres psql --username=postgres

:::note If you see the error ERROR: type "earth" does not exist, or you have problems with Reverse Geocoding after a restore, add the following sed fragment to your restore command.

Example: gunzip < "/path/to/backup/dump.sql.gz" | sed "s/SELECT pg_catalog.set_config('search_path', '', false);/SELECT pg_catalog.set_config('search_path', 'public, pg_catalog', true);/g" | docker exec -i immich_postgres psql --username=postgres :::

Filesystem

Immich stores two types of content in the filesystem: (1) original, unmodified assets (photos and videos), and (2) generated content. Only the original content needs to be backed-up, which is stored in the following folders:

1. UPLOAD_LOCATION/library
2. UPLOAD_LOCATION/upload
3. UPLOAD_LOCATION/profile

:::caution If you moved some of these folders onto a different storage device, such as profile/, make sure to adjust the backup path to match your setup :::

Asset Types and Storage Locations

Some storage locations are impacted by the Storage Template. See below for more details.

:::note The UPLOAD_LOCATION/library folder is not used by default on new machines running version 1.92.0. It is used only if the system administrator activated the storage template engine, for more info read the release notes. :::

1. User-Specific Folders:

• Each user has a unique string representing them.
• You can find your user ID in Account Account Settings -> Account -> User ID.

2. Asset Types and Storage Locations:

• Source Assets:
  • Original assets uploaded through the browser interface & mobile & CLI.
  • Stored in UPLOAD_LOCATION/upload/<userID>.
• Avatar Images:
  • User profile images.
  • Stored in UPLOAD_LOCATION/profile/<userID>.
• Thumbs Images:
  • Preview images (small thumbnails and large previews) for each asset and thumbnails for recognized faces.
  • Stored in UPLOAD_LOCATION/thumbs/<userID>.
• Encoded Assets:
  • Videos that have been re-encoded from the original for wider compatibility. The original is not removed.
  • Stored in UPLOAD_LOCATION/encoded-video/<userID>.

:::note If you choose to activate the storage template engine, it will move all assets to UPLOAD_LOCATION/library/<userID>.

When you turn off the storage template engine, it will leave the assets in UPLOAD_LOCATION/library/<userID> and will not return them to UPLOAD_LOCATION/upload.
New assets will be saved to UPLOAD_LOCATION/upload. :::

1. User-Specific Folders:

• Each user has a unique string representing them.
  • The administrator can set a Storage Label for a user, which will be used instead of <userID> for the library/ folder.
  • The Admin has a default storage label of admin.
• You can find your user ID and Storage Label in Account Account Settings -> Account -> User ID.

2. Asset Types and Storage Locations:

• Source Assets:
  • Original assets uploaded through the browser interface, mobile, and CLI.
  • Stored in UPLOAD_LOCATION/library/<userID>.
• Avatar Images:
  • User profile images.
  • Stored in UPLOAD_LOCATION/profile/<userID>.
• Thumbs Images:
  • Preview images (blurred, small, large) for each asset and thumbnails for recognized faces.
  • Stored in UPLOCAD_LOCATION/thumbs/<userID>.
• Encoded Assets:
  • Videos that have been re-encoded from the original for wider compatibility. The original is not removed.
  • Stored in UPLOAD_LOCATION/encoded-video/<userID>.
• Files in Upload Queue (Mobile):
  • Files uploaded through mobile apps.
  • Temporarily located in UPLOAD_LOCATION/upload/<userID>.
  • Transferred to UPLOAD_LOCATION/library/<userID> upon successful upload.

:::danger Do not touch the files inside these folders under any circumstances except taking a backup, changing or removing an asset can cause untracked and missing files. You can think of it as App-Which-Must-Not-Be-Named, the only access to viewing, changing and deleting assets is only through the mobile or browser interface. :::