From 174a609449d4ed7d9210175d98f33407ac2f0533 Mon Sep 17 00:00:00 2001 From: Trenton H Date: Mon, 3 Oct 2022 10:16:53 -0700 Subject: [PATCH 1/3] Adds a few steps for migration from the LinuxServer.io image --- docs/setup.rst | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/docs/setup.rst b/docs/setup.rst index ca07c1032..f6aa4fa41 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -634,6 +634,48 @@ Migration to paperless-ngx is then performed in a few simple steps: 10. Optionally, follow the instructions below to migrate your existing data to PostgreSQL. +Migrating from LinuxServer.io Docker Image +======================== + +As with any upgrades and large changes, it is highly recommended to create a backup before +starting. This assumes the image was running using Docker Compose, but the instructions +are translatable to Docker commands as well. + +1. Stop and remove the paperless container +2. If using an external database, stop the container +3. Update Redis configuration + + a) If ``REDIS_URL`` is already set, change it to ``PAPERLESS_REDIS`` and continue + to step 3. + b) Otherwise, in the ``docker-compose.yml`` add a new service for Redis, + following `the example compose files ` + b) Set the environment variable ``PAPERLESS_REDIS`` so it points to the new Redis container + +4. Update user mapping + + a) If set, change the environment variable ``PUID`` to ``USERMAP_UID`` + b) If set, change the environment variable ``PGID`` to ``USERMAP_GID`` + +5. Update configuration paths + + a) Set the environment variable ``PAPERLESS_DATA_DIR`` + to ``/config`` + +6. Update media paths + + a) Set the environment variable ``PAPERLESS_MEDIA_ROOT`` + to ``/data`` + +7. Update timezone + + a) Set the environment variable ``PAPERLESS_TIME_ZONE`` + to the same value as ``TZ`` + +8. Modify the ``image:`` to point to ``ghcr.io/paperless-ngx/paperless-ngx:latest`` or + a specific version if preferred. + +9. Start the containers as before, using ``docker-compose``. + .. _setup-sqlite_to_psql: Moving data from SQLite to PostgreSQL From 8c03d9c63837a47f328711d33d154a33aae8685b Mon Sep 17 00:00:00 2001 From: Trenton H Date: Mon, 3 Oct 2022 11:11:51 -0700 Subject: [PATCH 2/3] Corrects a re-numbered step --- docs/setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup.rst b/docs/setup.rst index f6aa4fa41..e7eccbfbc 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -646,7 +646,7 @@ are translatable to Docker commands as well. 3. Update Redis configuration a) If ``REDIS_URL`` is already set, change it to ``PAPERLESS_REDIS`` and continue - to step 3. + to step 4. b) Otherwise, in the ``docker-compose.yml`` add a new service for Redis, following `the example compose files ` b) Set the environment variable ``PAPERLESS_REDIS`` so it points to the new Redis container From 821c14fbce0e776e26317366c7a4e1ed0bc449d0 Mon Sep 17 00:00:00 2001 From: Trenton H Date: Mon, 3 Oct 2022 11:14:18 -0700 Subject: [PATCH 3/3] Corrects how the link to example compose files looks --- docs/setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup.rst b/docs/setup.rst index e7eccbfbc..282770376 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -648,7 +648,7 @@ are translatable to Docker commands as well. a) If ``REDIS_URL`` is already set, change it to ``PAPERLESS_REDIS`` and continue to step 4. b) Otherwise, in the ``docker-compose.yml`` add a new service for Redis, - following `the example compose files ` + following `the example compose files `_ b) Set the environment variable ``PAPERLESS_REDIS`` so it points to the new Redis container 4. Update user mapping