Merge branch 'paperless-ngx:dev' into dev

.github/workflows/ci.yml

@@ -2,7 +2,8 @@ name: ci
 
 on:
   push:
-    tags: ngx-*
+    tags:
+      - ngx-*
     branches-ignore:
       - 'translations**'
   pull_request:
@@ -177,37 +178,37 @@ jobs:
         name: Move files
         run: |
           mkdir dist
-          mkdir dist/paperless-ng
+          mkdir dist/paperless-ngx
-          mkdir dist/paperless-ng/scripts
+          mkdir dist/paperless-ngx/scripts
-          cp .dockerignore .env Dockerfile Pipfile Pipfile.lock LICENSE README.md requirements.txt dist/paperless-ng/
+          cp .dockerignore .env Dockerfile Pipfile Pipfile.lock LICENSE README.md requirements.txt dist/paperless-ngx/
-          cp paperless.conf.example dist/paperless-ng/paperless.conf
+          cp paperless.conf.example dist/paperless-ngx/paperless.conf
-          cp gunicorn.conf.py dist/paperless-ng/gunicorn.conf.py
+          cp gunicorn.conf.py dist/paperless-ngx/gunicorn.conf.py
-          cp docker/ dist/paperless-ng/docker -r
+          cp docker/ dist/paperless-ngx/docker -r
-          cp scripts/*.service scripts/*.sh dist/paperless-ng/scripts/
+          cp scripts/*.service scripts/*.sh dist/paperless-ngx/scripts/
-          cp src/ dist/paperless-ng/src -r
+          cp src/ dist/paperless-ngx/src -r
-          cp docs/_build/html/ dist/paperless-ng/docs -r
+          cp docs/_build/html/ dist/paperless-ngx/docs -r
       -
         name: Compile messages
         run: |
-          cd dist/paperless-ng/src
+          cd dist/paperless-ngx/src
           python3 manage.py compilemessages
       -
         name: Collect static files
         run: |
-          cd dist/paperless-ng/src
+          cd dist/paperless-ngx/src
           python3 manage.py collectstatic --no-input
       -
         name: Make release package
         run: |
           cd dist
           find . -name __pycache__ | xargs rm -r
-          tar -cJf paperless-ng.tar.xz paperless-ng/
+          tar -cJf paperless-ngx.tar.xz paperless-ngx/
       -
         name: Upload release artifact
         uses: actions/upload-artifact@v2
         with:
           name: release
-          path: dist/paperless-ng.tar.xz
+          path: dist/paperless-ngx.tar.xz
 
   publish-release:
     runs-on: ubuntu-latest
@@ -224,7 +225,7 @@ jobs:
         name: Get version
         id: get_version
         run: |
-          echo ::set-output name=version::${GITHUB_REF#refs/tags/ng-}
+          echo ::set-output name=version::${GITHUB_REF#refs/tags/ngx-}
       -
         name: Create release
         id: create_release
@@ -232,12 +233,12 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          tag_name: ng-${{ steps.get_version.outputs.version }}
+          tag_name: ngx-${{ steps.get_version.outputs.version }}
-          release_name: Paperless-ng ${{ steps.get_version.outputs.version }}
+          release_name: Paperless-ngx ${{ steps.get_version.outputs.version }}
           draft: false
           prerelease: false
           body: |
-            For a complete list of changes, see the changelog at https://paperless-ng.readthedocs.io/en/latest/changelog.html.
+            For a complete list of changes, see the changelog at https://paperless-ngx.readthedocs.io/en/latest/changelog.html.
       -
         name: Upload release archive
         id: upload-release-asset
@@ -246,13 +247,13 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
-          asset_path: ./paperless-ng.tar.xz
+          asset_path: ./paperless-ngx.tar.xz
-          asset_name: paperless-ng-${{ steps.get_version.outputs.version }}.tar.xz
+          asset_name: paperless-ngx-${{ steps.get_version.outputs.version }}.tar.xz
           asset_content_type: application/x-xz
 
   # build and push image to docker hub.
   build-docker-image:
-    if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev' || startsWith(github.ref, 'refs/tags/ng-'))
+    if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev' || startsWith(github.ref, 'refs/tags/ngx-'))
     runs-on: ubuntu-latest
     needs: [tests, codeformatting, codestyle]
     steps:
@@ -261,8 +262,8 @@ jobs:
         id: prepare
         run: |
           IMAGE_NAME=ghcr.io/${{ github.repository }}
-          if [[ $GITHUB_REF == refs/tags/ng-* ]]; then
+          if [[ $GITHUB_REF == refs/tags/ngx-* ]]; then
-            TAGS=${IMAGE_NAME}:${GITHUB_REF#refs/tags/ng-},${IMAGE_NAME}:latest
+            TAGS=${IMAGE_NAME}:${GITHUB_REF#refs/tags/ngx-},${IMAGE_NAME}:latest
             INSPECT_TAG=${IMAGE_NAME}:latest
           elif [[ $GITHUB_REF == refs/heads/* ]]; then
             TAGS=${IMAGE_NAME}:${GITHUB_REF#refs/heads/}

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.
+
 <!-- omit in toc -->
 ### Documentation
 

docs/setup.rst

@@ -468,8 +468,39 @@ 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 both from 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. if using Docker Compose, edit ``docker-compose.yml`` and change:
+
+.. code::
+
+  image: jonaswinkler/paperless-ng:latest
+
+to
+
+.. code::
+
+  image: ghcr.io/paperless-ngx/paperless-ngx:latest
+    
+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``, 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
+========================
 
 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 +665,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

src-ui/src/locale/messages.fr_FR.xlf

@@ -511,7 +511,7 @@
           <context context-type="sourcefile">src/app/components/dashboard/dashboard.component.ts</context>
           <context context-type="linenumber">33</context>
         </context-group>
-        <target state="translated">Bonjour <x id="PH" equiv-text="this.displayName"/>, bienvenue sur Paperless-ngx!</target>
+        <target state="translated">Bonjour <x id="PH" equiv-text="this.displayName"/>, bienvenue dans Paperless-ngx!</target>
       </trans-unit>
       <trans-unit id="795745990148149834" datatype="html">
         <source>Welcome to Paperless-ngx!</source>
@@ -519,7 +519,7 @@
           <context context-type="sourcefile">src/app/components/dashboard/dashboard.component.ts</context>
           <context context-type="linenumber">35</context>
         </context-group>
-        <target state="translated">Bienvenue sur Paperless-ngx!</target>
+        <target state="translated">Bienvenue dans Paperless-ngx!</target>
       </trans-unit>
       <trans-unit id="2946624699882754313" datatype="html" approved="yes">
         <source>Show all</source>

src/locale/da_DK/LC_MESSAGES/django.po

@@ -3,7 +3,7 @@ msgstr ""
 "Project-Id-Version: paperless-ngx\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2022-03-02 11:20-0800\n"
-"PO-Revision-Date: 2022-03-02 22:29\n"
+"PO-Revision-Date: 2022-03-03 16:53\n"
 "Last-Translator: \n"
 "Language-Team: Danish\n"
 "Language: da_DK\n"
@@ -344,7 +344,7 @@ msgstr "mere som dette"
 
 #: documents/models.py:353
 msgid "has tags in"
-msgstr ""
+msgstr "har etiketter i"
 
 #: documents/models.py:363
 msgid "rule type"
@@ -378,11 +378,11 @@ msgstr "Filtype %(type)s understøttes ikke"
 
 #: documents/templates/index.html:22
 msgid "Paperless-ngx is loading..."
-msgstr ""
+msgstr "Paperless-ngx indlæses..."
 
 #: documents/templates/registration/logged_out.html:14
 msgid "Paperless-ngx signed out"
-msgstr ""
+msgstr "Paperless-ngx logget ud"
 
 #: documents/templates/registration/logged_out.html:59
 msgid "You have been successfully logged out. Bye!"
@@ -394,7 +394,7 @@ msgstr "Log ind igen"
 
 #: documents/templates/registration/login.html:15
 msgid "Paperless-ngx sign in"
-msgstr ""
+msgstr "Paperless-ngx log ind"
 
 #: documents/templates/registration/login.html:61
 msgid "Please sign in."
@@ -422,11 +422,11 @@ msgstr "Engelsk (USA)"
 
 #: paperless/settings.py:300
 msgid "Czech"
-msgstr ""
+msgstr "Tjekkisk"
 
 #: paperless/settings.py:301
 msgid "Danish"
-msgstr ""
+msgstr "Dansk"
 
 #: paperless/settings.py:302
 msgid "German"
@@ -450,7 +450,7 @@ msgstr "Italiensk"
 
 #: paperless/settings.py:307
 msgid "Luxembourgish"
-msgstr ""
+msgstr "Luxemburgsk"
 
 #: paperless/settings.py:308
 msgid "Dutch"
@@ -482,7 +482,7 @@ msgstr "Svensk"
 
 #: paperless/urls.py:139
 msgid "Paperless-ngx administration"
-msgstr ""
+msgstr "Paperless-ngx administration"
 
 #: paperless_mail/admin.py:29
 msgid "Authentication"

src/locale/fr_FR/LC_MESSAGES/django.po

@@ -3,7 +3,7 @@ msgstr ""
 "Project-Id-Version: paperless-ngx\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2022-03-02 11:20-0800\n"
-"PO-Revision-Date: 2022-03-02 22:29\n"
+"PO-Revision-Date: 2022-03-03 15:34\n"
 "Last-Translator: \n"
 "Language-Team: French\n"
 "Language: fr_FR\n"
@@ -344,7 +344,7 @@ msgstr "documents relatifs"
 
 #: documents/models.py:353
 msgid "has tags in"
-msgstr ""
+msgstr "porte une étiquette parmi"
 
 #: documents/models.py:363
 msgid "rule type"
@@ -378,11 +378,11 @@ msgstr "Type de fichier %(type)s non pris en charge"
 
 #: documents/templates/index.html:22
 msgid "Paperless-ngx is loading..."
-msgstr ""
+msgstr "Paperless-ngx est en cours de chargement..."
 
 #: documents/templates/registration/logged_out.html:14
 msgid "Paperless-ngx signed out"
-msgstr ""
+msgstr "Déconnexion de Paperless-ngx"
 
 #: documents/templates/registration/logged_out.html:59
 msgid "You have been successfully logged out. Bye!"
@@ -394,7 +394,7 @@ msgstr "Se reconnecter"
 
 #: documents/templates/registration/login.html:15
 msgid "Paperless-ngx sign in"
-msgstr ""
+msgstr "Connexion à Paperless-ngx"
 
 #: documents/templates/registration/login.html:61
 msgid "Please sign in."
@@ -422,11 +422,11 @@ msgstr "Anglais (US)"
 
 #: paperless/settings.py:300
 msgid "Czech"
-msgstr ""
+msgstr "Tchèque"
 
 #: paperless/settings.py:301
 msgid "Danish"
-msgstr ""
+msgstr "Danois"
 
 #: paperless/settings.py:302
 msgid "German"
@@ -450,7 +450,7 @@ msgstr "Italien"
 
 #: paperless/settings.py:307
 msgid "Luxembourgish"
-msgstr ""
+msgstr "Luxembourgeois"
 
 #: paperless/settings.py:308
 msgid "Dutch"
@@ -482,7 +482,7 @@ msgstr "Suédois"
 
 #: paperless/urls.py:139
 msgid "Paperless-ngx administration"
-msgstr ""
+msgstr "Administration de Paperless-ngx"
 
 #: paperless_mail/admin.py:29
 msgid "Authentication"