From 2484563ac7c9807bc8501987863fa00ffdbc5bad Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 3 Mar 2022 10:11:58 -0800 Subject: [PATCH 1/5] Add information about switching from -ng to -ngx Closes #204 --- docs/setup.rst | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/docs/setup.rst b/docs/setup.rst index 5ab54fa96..d57fa774f 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -468,8 +468,36 @@ writing. Windows is not and will never be supported. to compile this by yourself, because this software has been patented until around 2017 and binary packages are not available for most distributions. -Migration to paperless-ngx -######################### +Migrating to Paperless-ngx +########################## + +Migration is possible from both Paperless-ng or directly from the 'original' Paperless. + +Migrating from Paperless-ng +=========================== + +Paperless-ngx is meant to be a drop-in replacement for Paperless-ng and thus upgrading should be +trivial for most users, especially when using docker. However, as with any major change, it is +recommended to take a full backup first. Once you are ready, simply change the docker image to +point to the new source, e.g. change: + +.. code:: + + image: jonaswinkler/paperless-ng:latest + +to + +.. code:: + + image: ghcr.io/paperless-ngx/paperless-ngx:latest + +Then restart your container and that's it! + +Users who installed with the bare-metal route should +also update their Git clone to point to ``https://github.com/paperless-ngx/paperless-ngx``. + +Migrating from Paperless +======================== At its core, paperless-ngx is still paperless and fully compatible. However, some things have changed under the hood, so you need to adapt your setup depending on @@ -634,7 +662,7 @@ management commands as below. 7. Start paperless. -Moving back to paperless +Moving back to Paperless ======================== Lets say you migrated to Paperless-ngx and used it for a while, but decided that From a233e5d4046c5439ccd8b76c9e9b91953eeeef2b Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 3 Mar 2022 11:07:48 -0800 Subject: [PATCH 2/5] Add note to pull new image --- docs/setup.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/setup.rst b/docs/setup.rst index d57fa774f..6c2e8248c 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -491,7 +491,8 @@ to image: ghcr.io/paperless-ngx/paperless-ngx:latest -Then restart your container and that's it! +Then make sure you pull the new image (e.g. ``docker-compose pull`` if using compose), restart +your container and that's it! Users who installed with the bare-metal route should also update their Git clone to point to ``https://github.com/paperless-ngx/paperless-ngx``. From 0545d9bab7ae643da016a70fb344709d736fc3f2 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 3 Mar 2022 12:55:34 -0800 Subject: [PATCH 3/5] More explicit instructions --- docs/setup.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/setup.rst b/docs/setup.rst index 6c2e8248c..7bcb6d615 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -479,7 +479,7 @@ Migrating from Paperless-ng Paperless-ngx is meant to be a drop-in replacement for Paperless-ng and thus upgrading should be trivial for most users, especially when using docker. However, as with any major change, it is recommended to take a full backup first. Once you are ready, simply change the docker image to -point to the new source, e.g. change: +point to the new source. E.g. if using Docker Compose, edit ``docker-compose.yml`` and change: .. code:: @@ -491,11 +491,13 @@ to image: ghcr.io/paperless-ngx/paperless-ngx:latest -Then make sure you pull the new image (e.g. ``docker-compose pull`` if using compose), restart -your container and that's it! +and then run ``docker-compose up -d`` which will pull the new image recreate the container. +That's it! -Users who installed with the bare-metal route should -also update their Git clone to point to ``https://github.com/paperless-ngx/paperless-ngx``. +Users who installed with the bare-metal route should also update their Git clone to point to +``https://github.com/paperless-ngx/paperless-ngx``, e.g. using the command +``git remote set-url origin https://github.com/paperless-ngx/paperless-ngx`` and then pull the +lastest version. Migrating from Paperless ======================== From 67efda7cf48469502ddc64723e64ab83dbb0a407 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 3 Mar 2022 13:02:58 -0800 Subject: [PATCH 4/5] Add migration line to readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8e20aeb73..e7b27d855 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,8 @@ bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx Alternatively, you can install the dependencies and setup apache and a database server yourself. The [documentation](https://paperless-ngx.readthedocs.io/en/latest/setup.html#installation) has a step by step guide on how to do it. +Migrating from Paperless-ng is easy, just drop in the new docker image! See the [documentation on migrating](https://paperless-ngx.readthedocs.io/en/latest/setup.html#migrating-from-paperless-ng) for more details. + ### Documentation From d1032e4d7da51c6cfac2de5043d132dfaf8f6161 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 3 Mar 2022 13:20:29 -0800 Subject: [PATCH 5/5] Fix the grammars in setup.rst --- docs/setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup.rst b/docs/setup.rst index 7bcb6d615..bd8421fe4 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -471,7 +471,7 @@ writing. Windows is not and will never be supported. Migrating to Paperless-ngx ########################## -Migration is possible from both Paperless-ng or directly from the 'original' Paperless. +Migration is possible both from Paperless-ng or directly from the 'original' Paperless. Migrating from Paperless-ng ===========================