]> git.ipfire.org Git - thirdparty/paperless-ngx.git/commitdiff
Add information about switching from -ng to -ngx
authorshamoon <4887959+shamoon@users.noreply.github.com>
Thu, 3 Mar 2022 18:11:58 +0000 (10:11 -0800)
committerGitHub <noreply@github.com>
Thu, 3 Mar 2022 18:11:58 +0000 (10:11 -0800)
Closes #204

docs/setup.rst

index 5ab54fa96f1849b449ee280ce5e7da5e5f23e8e1..d57fa774f183d49423b1ee0ebd4bd118534017ed 100644 (file)
@@ -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