Backup and Restore Immich from TrueNAS Scale to Docker using pg_dumpall

[ra7bi]

Backup and Restore Immich from TrueNAS Scale to Docker

This guide will walk you through the steps to backup your Immich database and relevant folders from a TrueNAS Scale environment and restore them to a Docker-based system.

Backup Immich Database and Folders from TrueNAS Scale

1. SSH into your TrueNAS Scale server:

   ssh <your_truenas_scale_server>

2. Get the PostgreSQL pod name:

   sudo k3s kubectl get pods -n ix-immich

   Look for the pod name that starts with immich-postgres.

3. Dump the PostgreSQL database:

   sudo k3s kubectl exec -it <immich-postgres-pod-name> -n ix-immich -- sh -c "pg_dumpall --clean --if-exists --username=immich" | gzip > /tmp/dump.sql.gz

4. Move the dump file to a desired location:

   mv /tmp/dump.sql.gz /home/xxxx

5. Copy the required folders:

   mkdir /home/xxxx/backupLibrary
   cp -r /path_to_library_folder /home/xxxx/backupLibrary/library
   cp -r /path_to_upload_folder /home/xxxx/backupLibrary/upload
   cp -r /path_to_profile_folder /home/xxxx/backupLibrary/profile

6. Download the dump file and backupLibrary folder to your local machine:

   Use scp or any other method to download the dump file and backupLibrary folder to your local machine.

Restore Immich Database and Folders on Docker

1. Copy the backupLibrary folder to your new Docker server:

   Use scp or any other method to upload the backupLibrary folder to your new Docker server.

2. Download and set up Immich on your Docker server:

   Follow the Immich Docker installation guide to download and set up Immich.

3. Update the UPLOAD_LOCATION in your .env file:

   Set the UPLOAD_LOCATION to point to the backupLibrary folder:

   UPLOAD_LOCATION=/path_to_backupLibrary

4. Check the PostgreSQL version in TrueNAS Scale:

   sudo k3s kubectl exec -it <immich-postgres-pod-name> -n ix-immich -- psql --username=immich -c "SELECT version();"

   Make sure the version matches with the PostgreSQL version in your Docker setup. If not, update your Docker YAML file to match the PostgreSQL version.

5. Prepare the dump file:

   sudo gunzip < "/path_to_your_local_copy/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" \
   | sudo docker exec -i immich_postgres psql --username=postgres

Notes

• Replace <immich-postgres-pod-name> with the actual PostgreSQL pod name obtained in step 2.
• Replace /home/xxxx with the actual path where you want to move the dump file.
• Replace /path_to_backupLibrary with the actual path to the backupLibrary folder on your Docker server.
• Ensure you have sed and gzip installed on your local machine for processing the dump file.

This guide should help you smoothly backup and restore your Immich database and relevant folders between TrueNAS Scale and any Docker-based system. If you encounter any issues, please refer to the relevant PostgreSQL and Docker documentation for further assistance.

Thanks you

[ramondsq]

Hello there.
My Truenas immich app broke when updating and could never start. I tried to use the postgres backup SQL files generated automatically by the Truenas immich app and follow your instructions to restore in my local docker. When I go though the step 5. Prepare the dump file. I would encounter the ERROR: role "immich" does not exist and could not get my previous configs restored. I'd like to know how can I solve this.

[ra7bi]

In PostgreSQL, roles are used to manage permissions and access control to the database.
regarding the error "role 'immich' does not exist" during a backup restore, it means that PostgreSQL is trying to restore data for a user (role) named "immich," but that role hasn't been created in the target database.

So ig , before restoring the backup, you can create the missing role by running:
CREATE ROLE immich WITH LOGIN;
LOGIN => allows it to log in

[DarkLordGMS]

In PostgreSQL, roles are used to manage permissions and access control to the database. regarding the error "role 'immich' does not exist" during a backup restore, it means that PostgreSQL is trying to restore data for a user (role) named "immich," but that role hasn't been created in the target database.

So ig , before restoring the backup, you can create the missing role by running: CREATE ROLE immich WITH LOGIN; LOGIN => allows it to log in

But how do we run that?

[steve1123456]

Hey @ra7bi , thanks for this excellent guide!

There are a couple of steps that I'm a little unclear about, and I'm wondering if they're even required, given the way that I setup Immich initially (using 7 separate datasets via HostPaths per the community guide here.). Since my database is relatively easily accessible inside the pgData dataset (I can mount via SMB to copy it), do I have to do the steps of "dump"ing the database? Can I simply copy the library/upload/profile folders and put those 3 folders under UPLOAD_LOCATION=/path_to_backupLibrary, and then copy the pgData folder to DB_DATA_LOCATION=./postgres and update the .env file with these paths? Or would this not be sufficient?

Sorry, I'm just a little n00b with the command line and try to avoid it when I can lol.

[ra7bi]

The main point is how you can get the db backup and restore it. Some steps are not really necessary The main point is how you can get the db backup and restore it. Some steps are not really necessary .

Good luck 🤞

[steve1123456]

Thanks for the fast reply! Ok I think I follow. I suppose some steps are required if Immich was installed without datasets/HostPaths, and you have to "go into the postgres inner workings" so-to-speak to find and pullout the db, but since I installed mine by using datasets, I should be able to do a copy/paste from the pgData folder to it's new home on the Proxmox LXC container under DB_DATA_LOCATION=./postgres, along with copying the 3 folders (library/upload/profile) inside the UPLOAD_LOCATION=/path, and be good to go? If I'm following correctly?
Thanks again! Appreciate your advice.

[ra7bi]

ig yes , the path in the DB for each folder should match the path where you placed your actual files .