(delete me)

Feature split dockerimage

.dockerignore

@@ -17,3 +17,5 @@
 **/htmlcov
 /src/.pytest_cache
 .idea
+.venv/
+.vscode/

.editorconfig

@@ -18,7 +18,13 @@ max_line_length = off
 indent_size = 4
 indent_style = space
 
-[*.yml]
+[*.{yml,yaml}]
+indent_style = space
+
+[*.rst]
+indent_style = space
+
+[*.md]
 indent_style = space
 
 # Tests don't get a line width restriction.  It's still a good idea to follow
@@ -26,3 +32,6 @@ indent_style = space
 # violate it.
 [**/test_*.py]
 max_line_length = off
+
+[Dockerfile]
+indent_style = space

.env

@@ -1 +1,2 @@
-COMPOSE_PROJECT_NAME=paperless
+COMPOSE_PROJECT_NAME=paperless
+export PROMPT="(pipenv-projectname)$P$G"

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,20 +1,19 @@
 ---
 name: Bug report
 about: Something is not working
-title: "[BUG] Concise description of the issue"
+title: '[BUG] Concise description of the issue'
 labels: ''
 assignees: ''
-
 ---
 
 <!---
-=> Before opening an issue, please check the documentation and see if it helps you resolve your issue: https://paperless-ng.readthedocs.io/en/latest/troubleshooting.html
+=> Before opening an issue, please check the documentation and see if it helps you resolve your issue: https://paperless-ngx.readthedocs.io/en/latest/troubleshooting.html
 => Please also make sure that you followed the installation instructions.
 => Please search the issues and look for similar issues before opening a bug report.
 
-=> If you would like to submit a feature request please submit one under https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests
+=> If you would like to submit a feature request please submit one under https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests
 
-=> If you encounter issues while installing of configuring Paperless-ng, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably an issue with your system, and not an issue of paperless.
+=> If you encounter issues while installing of configuring Paperless-ngx, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably an issue with your system, and not an issue of paperless.
 
 => Don't remove the [BUG] prefix from the title.
 -->
@@ -24,6 +23,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -36,13 +36,15 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Webserver logs**
+
 ```
 If available, post any logs from the web server related to your issue.
 ```
 
 **Relevant information**
- - Host OS of the machine running paperless: [e.g. Archlinux / Ubuntu 20.04]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 1.0.0]
- - Installation method: [docker / bare metal]
- - Any configuration changes you made in `docker-compose.yml`, `docker-compose.env` or `paperless.conf`.
+
+- Host OS of the machine running paperless: [e.g. Archlinux / Ubuntu 20.04]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 1.0.0]
+- Installation method: [docker / bare metal]
+- Any configuration changes you made in `docker-compose.yml`, `docker-compose.env` or `paperless.conf`.

.github/ISSUE_TEMPLATE/other.md

@@ -1,19 +1,18 @@
 ---
 name: Other
 about: Anything that is not a feature request or bug.
-title: "[Other] Title of your issue"
+title: '[Other] Title of your issue'
 labels: ''
 assignees: ''
-
 ---
 
 <!--
 
 => Discussions, Feedback and other suggestions belong in the "Discussion" section and not on the issue tracker.
 
-=> If you would like to submit a feature request please submit one under https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests
+=> If you would like to submit a feature request please submit one under https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests
 
-=> If you encounter issues while installing of configuring Paperless-ng, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably is an issue with your system, and not an issue of paperless.
+=> If you encounter issues while installing of configuring Paperless-ngx, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably is an issue with your system, and not an issue of paperless.
 
 => Don't remove the [Other] prefix from the title.
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,40 @@
+<!-- 
+Note: All PRs with code changes should be targeted to the `dev` branch, pure documentation changes can target `main`
+-->
+
+## Proposed change
+
+<!--
+Please include a summary of the change and which issue is fixed (if any) and any relevant motivation / context. List any dependencies that are required for this change. If appropriate, please include an explanation of how your poposed change can be tested. Screenshots and / or videos can also be helpful if appropriate.
+-->
+
+Fixes # (issue)
+
+<!--
+Please also tag the relevant team to help with review. You can tag any of the following:
+@paperless-ngx/backend (Python / django, database, etc.)
+@paperless-ngx/frontend (JavaScript/Typescript, HTML, CSS, etc.)
+@paperless-ngx/ci-cd (GitHub Actions, deployment)
+@paperless-ngx/test (General testing for larger PRs)
+-->
+
+## Type of change
+
+<!--
+What type of change does your PR introduce to Paperless-ngx?
+NOTE: Please check only one box!
+-->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Other (please explain)
+
+## Checklist:
+
+- [ ] I have read & agree with the [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md).
+- [ ] If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
+- [ ] If applicable, I have checked that all tests pass, see [documentation](https://paperless-ngx.readthedocs.io/en/latest/extending.html#back-end-development).
+- [ ] I have run all `pre-commit` hooks, see [documentation](https://paperless-ngx.readthedocs.io/en/latest/extending.html#code-formatting-with-pre-commit-hooks).
+- [ ] I have made corresponding changes to the documentation as needed.
+- [ ] I have checked my modifications for any breaking changes.

.github/dependabot.yml

@@ -0,0 +1,41 @@
+# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#package-ecosystem
+
+version: 2
+updates:
+
+  # Enable version updates for npm
+  - package-ecosystem: "npm"
+    target-branch: "dev"
+    # Look for `package.json` and `lock` files in the `root` directory
+    directory: "/src-ui"
+    # Check the npm registry for updates every month
+    schedule:
+      interval: "monthly"
+    # Add reviewers
+    reviewers:
+      - "paperless-ngx/frontend"
+
+  # Enable version updates for Python
+  - package-ecosystem: "pip"
+    target-branch: "dev"
+    # Look for a `Pipfile` in the `root` directory
+    directory: "/"
+    # Check for updates once a week
+    schedule:
+      interval: "weekly"
+    labels:
+      - "backend"
+      - "dependencies"
+
+  # Enable updates for Github Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every month
+      interval: "monthly"
+    labels:
+      - "ci-cd"
+      - "dependencies"
+    # Add reviewers
+    reviewers:
+      - "paperless-ngx/backend"

.github/stale.yml

@@ -0,0 +1,18 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 30
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - fixpending
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.github/workflows/ansible.yml

@@ -1,76 +0,0 @@
----
-name: Ansible Role
-
-on:
-  push:
-    branches-ignore:
-      - 'translations**'
-  pull_request:
-    branches-ignore:
-      - 'translations**'
-
-jobs:
-  # https://molecule.readthedocs.io/en/latest/ci.html#github-actions
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the codebase
-        uses: actions/checkout@v2
-        if: github.event_name != 'pull_request'
-        with:
-          path: "${{ github.repository }}"
-      - name: Check out the codebase
-        uses: actions/checkout@v2
-        if: github.event_name == 'pull_request'
-        with:
-          # merge commit is not available from tree at this point in time
-          # https://github.com/actions/checkout#checkout-pull-request-head-commit-instead-of-merge-commit
-          ref: "${{ github.event.pull_request.head.sha }}"
-          path: "${{ github.repository }}"
-      - name: Set up Python
-        uses: actions/setup-python@v2
-      - name: Set up Docker
-        uses: docker-practice/actions-setup-docker@master
-      - name: Install dependencies
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install molecule[ansible,docker] jmespath
-          ansible --version
-          docker --version
-          molecule --version
-          python --version
-      - name: Test installation/build/upgrade with molecule
-        run: |
-          cd ansible
-          molecule create
-          molecule verify
-          molecule converge
-          molecule idempotence
-          molecule verify
-        working-directory: "${{ github.repository }}"
-  # # https://galaxy.ansible.com/docs/contributing/importing.html
-  # release:
-  #   runs-on: ubuntu-latest
-  #   needs:
-  #     - test
-  #   # https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions#github-context
-  #   if: contains(github.ref, 'refs/tags/')
-  #   steps:
-  #     - name: Check out the codebase
-  #       uses: actions/checkout@v2
-  #       with:
-  #         path: "${{ github.repository }}"
-  #     - name: Set up Python
-  #       uses: actions/setup-python@v2
-  #     - name: Install dependencies
-  #       run: |
-  #         python3 -m pip install --upgrade ansible-base
-  #         ansible --version
-  #         python --version
-  #     - name: Trigger a new import on Galaxy
-  #     # TODO Check if source if pulled from cwd or imported from github
-  #     # https://github.com/ansible/ansible/blob/devel/lib/ansible/cli/galaxy.py
-  #       run: |
-  #         cd ansible
-  #         ansible-galaxy role import --api-key ${{ secrets.GALAXY_API_KEY }} $(echo ${{ github.repository }} | cut -d/ -f1) $(echo ${{ github.repository }} | cut -d/ -f2)
-  #       working-directory: "${{ github.repository }}"

.github/workflows/ci.yml

@@ -2,7 +2,9 @@ name: ci
 
 on:
   push:
-    tags: ng-*
+    tags:
+      - ngx-*
+      - beta-*
     branches-ignore:
       - 'translations**'
   pull_request:
@@ -11,179 +13,264 @@ on:
 
 jobs:
   documentation:
+    name: "Build Documentation"
     runs-on: ubuntu-20.04
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+      -
+        name: Install pipenv
+        run: pipx install pipenv
       -
         name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
-          python-version: 3.7
-      -
-        name: Get pip cache dir
-        id: pip-cache
-        run: |
-          echo "::set-output name=dir::$(pip cache dir)"
-      -
-        name: Persistent Github pip cache
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip3.8}
+          python-version: 3.9
+          cache: "pipenv"
+          cache-dependency-path: 'Pipfile.lock'
       -
         name: Install dependencies
         run: |
-          pip install --upgrade pipenv
-          pipenv install --system --dev --ignore-pipfile
+          pipenv sync --dev
       -
         name: Make documentation
         run: |
           cd docs/
-          make html
+          pipenv run make html
       -
         name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: documentation
           path: docs/_build/html/
 
-  codestyle:
+  code-checks-backend:
+    name: "Backend Code Checks"
     runs-on: ubuntu-20.04
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       -
-        name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.7
-      -
-        name: Get pip cache dir
-        id: pip-cache
+        name: Install checkers
         run: |
-          echo "::set-output name=dir::$(pip cache dir)"
+          pipx install reorder-python-imports
+          pipx install yesqa
+          pipx install add-trailing-comma
+          pipx install flake8
       -
-        name: Persistent Github pip cache
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip${{ matrix.python-version }}
-      -
-        name: Install dependencies
+        name: Run reorder-python-imports
         run: |
-          pip install --upgrade pipenv
-          pipenv install --system --dev --ignore-pipfile
+          find src/ -type f -name '*.py' ! -path "*/migrations/*" | xargs reorder-python-imports
       -
-        name: Codestyle
+        name: Run yesqa
+        run: |
+          find src/ -type f -name '*.py' ! -path "*/migrations/*" | xargs yesqa
+      -
+        name: Run add-trailing-comma
+        run: |
+          find src/ -type f -name '*.py' ! -path "*/migrations/*" | xargs add-trailing-comma
+      # black is placed after add-trailing-comma because it may format differently
+      # if a trailing comma is added
+      -
+        name: Run black
+        uses: psf/black@stable
+        with:
+          options: "--check --diff"
+          version: "22.3.0"
+      -
+        name: Run flake8 checks
         run: |
           cd src/
-          pycodestyle
+          flake8 --max-line-length=88 --ignore=E203,W503
 
-  tests:
+  code-checks-frontend:
+    name: "Frontend Code Checks"
+    runs-on: ubuntu-20.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+      -
+        name: Install prettier
+        run: |
+          npm install prettier
+      -
+        name: Run prettier
+        run:
+          npx prettier --check --ignore-path Pipfile.lock **/*.js **/*.ts *.md **/*.md
+
+  tests-backend:
+    needs: [code-checks-backend]
+    name: "Backend Tests (${{ matrix.python-version }})"
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python-version: ['3.6', '3.7', '3.8', '3.9']
+        python-version: ['3.8', '3.9']
       fail-fast: false
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+      -
+        name: Install pipenv
+        run: pipx install pipenv
       -
         name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: "${{ matrix.python-version }}"
+          cache: "pipenv"
+          cache-dependency-path: 'Pipfile.lock'
       -
-        name: Get pip cache dir
-        id: pip-cache
-        run: |
-          echo "::set-output name=dir::$(pip cache dir)"
-      -
-        name: Persistent Github pip cache
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip${{ matrix.python-version }}
-      -
-        name: Install dependencies
+        name: Install system dependencies
         run: |
           sudo apt-get update -qq
           sudo apt-get install -qq --no-install-recommends unpaper tesseract-ocr imagemagick ghostscript optipng
-          pip install --upgrade pipenv
-          pipenv install --system --dev --ignore-pipfile
+      -
+        name: Install Python dependencies
+        run: |
+          pipenv sync --dev
       -
         name: Tests
         run: |
           cd src/
-          pytest
+          pipenv run pytest
+      -
+        name: Get changed files
+        id: changed-files-specific
+        uses: tj-actions/changed-files@v18.1
+        with:
+          files: |
+            src/**
+      -
+        name: List all changed files
+        run: |
+          for file in ${{ steps.changed-files-specific.outputs.all_changed_files }}; do
+            echo "${file} was changed"
+          done
       -
         name: Publish coverage results
-        if: matrix.python-version == '3.8'
+        if: matrix.python-version == '3.9' && steps.changed-files-specific.outputs.any_changed == 'true'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         # https://github.com/coveralls-clients/coveralls-python/issues/251
         run: |
           cd src/
-          coveralls --service=github
+          pipenv run coveralls --service=github
 
-  frontend:
+  tests-frontend:
+    needs: [code-checks-frontend]
+    name: "Frontend Tests"
     runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        node-version: [16.x]
     steps:
-    -
-      name: Checkout
-      uses: actions/checkout@v2
-    -
-      uses: actions/setup-node@v2
-      with:
-        node-version: '15'
-    -
-      name: Configure version on dev branches
-      if: startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev'
-      run: |
-        git_hash=$(git rev-parse --short "$GITHUB_SHA")
-        git_branch=${GITHUB_REF#refs/heads/}
-        sed -i -E "s/version: \"(.*)\"/version: \"${git_branch} ${git_hash}\"/g" src-ui/src/environments/environment.prod.ts
-    -
-      name: Build frontend
-      run: ./compile-frontend.sh
-    -
-      name: Upload artifact
-      uses: actions/upload-artifact@v2
-      with:
-        name: frontend-compiled
-        path: src/documents/static/frontend/
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: cd src-ui && npm ci
+      - run: cd src-ui && npm run test
+      - run: cd src-ui && npm run e2e:ci
+
+  # 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' || github.ref == 'refs/heads/beta' || startsWith(github.ref, 'refs/tags/ngx-') || startsWith(github.ref, 'refs/tags/beta-'))
+    runs-on: ubuntu-20.04
+    needs: [tests-backend, tests-frontend]
+    steps:
+      -
+        name: Gather Docker metadata
+        id: docker-meta
+        uses: docker/metadata-action@v3
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=match,pattern=ngx-(\d.\d.\d),group=1
+            type=semver,pattern=ngx-{{version}}
+            type=semver,pattern=ngx-{{major}}.{{minor}}
+            type=ref,event=branch
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      -
+        name: Login to Github Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.docker-meta.outputs.tags }}
+          labels: ${{ steps.docker-meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      -
+        name: Inspect image
+        run: |
+          docker buildx imagetools inspect ${{ fromJSON(steps.docker-meta.outputs.json).tags[0] }}
+      -
+        name: Export frontend artifact from docker
+        run: |
+          docker create --name frontend-extract ${{ fromJSON(steps.docker-meta.outputs.json).tags[0] }}
+          docker cp frontend-extract:/usr/src/paperless/src/documents/static/frontend src/documents/static/frontend/
+      -
+        name: Upload frontend artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: frontend-compiled
+          path: src/documents/static/frontend/
 
   build-release:
-    needs: [frontend, documentation, tests, codestyle]
+    needs: [build-docker-image, documentation]
     runs-on: ubuntu-20.04
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       -
         name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
-          python-version: 3.7
+          python-version: 3.9
       -
         name: Install dependencies
         run: |
           sudo apt-get update -qq
           sudo apt-get install -qq --no-install-recommends gettext liblept5
+          pip3 install --upgrade pip setuptools wheel
           pip3 install -r requirements.txt
       -
         name: Download frontend artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: frontend-compiled
           path: src/documents/static/frontend/
       -
         name: Download documentation artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: documentation
           path: docs/_build/html/
@@ -191,46 +278,46 @@ jobs:
         name: Move files
         run: |
           mkdir dist
-          mkdir dist/paperless-ng
-          mkdir dist/paperless-ng/scripts
-          cp .dockerignore .env Dockerfile Pipfile Pipfile.lock LICENSE README.md requirements.txt dist/paperless-ng/
-          cp paperless.conf.example dist/paperless-ng/paperless.conf
-          cp gunicorn.conf.py dist/paperless-ng/gunicorn.conf.py
-          cp docker/ dist/paperless-ng/docker -r
-          cp scripts/*.service scripts/*.sh dist/paperless-ng/scripts/
-          cp src/ dist/paperless-ng/src -r
-          cp docs/_build/html/ dist/paperless-ng/docs -r
+          mkdir dist/paperless-ngx
+          mkdir dist/paperless-ngx/scripts
+          cp .dockerignore .env Dockerfile Pipfile Pipfile.lock LICENSE README.md requirements.txt dist/paperless-ngx/
+          cp paperless.conf.example dist/paperless-ngx/paperless.conf
+          cp gunicorn.conf.py dist/paperless-ngx/gunicorn.conf.py
+          cp docker/ dist/paperless-ngx/docker -r
+          cp scripts/*.service scripts/*.sh dist/paperless-ngx/scripts/
+          cp src/ dist/paperless-ngx/src -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
+        uses: actions/upload-artifact@v3
         with:
           name: release
-          path: dist/paperless-ng.tar.xz
+          path: dist/paperless-ngx.tar.xz
 
   publish-release:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: build-release
-    if: contains(github.ref, 'refs/tags/ng-')
+    if: contains(github.ref, 'refs/tags/ngx-') || contains(github.ref, 'refs/tags/beta-')
     steps:
       -
         name: Download release artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v3
         with:
           name: release
           path: ./
@@ -238,7 +325,15 @@ jobs:
         name: Get version
         id: get_version
         run: |
-          echo ::set-output name=version::${GITHUB_REF#refs/tags/ng-}
+          if [[ $GITHUB_REF == refs/tags/ngx-* ]]; then
+            echo ::set-output name=version::${GITHUB_REF#refs/tags/ngx-}
+            echo ::set-output name=prerelease::false
+            echo ::set-output name=body::"For a complete list of changes, see the changelog at https://paperless-ngx.readthedocs.io/en/latest/changelog.html"
+          elif [[ $GITHUB_REF == refs/tags/beta-* ]]; then
+            echo ::set-output name=version::${GITHUB_REF#refs/tags/beta-}
+            echo ::set-output name=prerelease::true
+            echo ::set-output name=body::"For a complete list of changes, see the changelog at https://github.com/paperless-ngx/paperless-ngx/blob/beta/docs/changelog.rst"
+          fi
       -
         name: Create release
         id: create_release
@@ -246,12 +341,11 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          tag_name: ng-${{ steps.get_version.outputs.version }}
-          release_name: Paperless-ng ${{ steps.get_version.outputs.version }}
+          tag_name: ngx-${{ 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.
+          prerelease: ${{ steps.get_version.outputs.prerelease }}
+          body: ${{ steps.get_version.outputs.body }}
       -
         name: Upload release archive
         id: upload-release-asset
@@ -260,73 +354,6 @@ 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_name: paperless-ng-${{ steps.get_version.outputs.version }}.tar.xz
+          asset_path: ./paperless-ngx.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-'))
-    runs-on: ubuntu-latest
-    needs: [frontend, tests, codestyle]
-    steps:
-      -
-        name: Prepare
-        id: prepare
-        run: |
-          IMAGE_NAME=jonaswinkler/paperless-ng
-          if [[ $GITHUB_REF == refs/tags/ng-* ]]; then
-            TAGS=${IMAGE_NAME}:${GITHUB_REF#refs/tags/ng-},${IMAGE_NAME}:latest
-            INSPECT_TAG=${IMAGE_NAME}:latest
-          elif [[ $GITHUB_REF == refs/heads/* ]]; then
-            TAGS=${IMAGE_NAME}:${GITHUB_REF#refs/heads/}
-            INSPECT_TAG=${TAGS}
-          else
-            exit 1
-          fi
-          echo ::set-output name=tags::${TAGS}
-          echo ::set-output name=inspect_tag::${INSPECT_TAG}
-      -
-        name: Checkout
-        uses: actions/checkout@v2
-      -
-        name: Download frontend artifact
-        uses: actions/download-artifact@v2
-        with:
-          name: frontend-compiled
-          path: src/documents/static/frontend/
-      -
-        name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-      -
-        name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
-      -
-        name: Cache Docker layers
-        uses: actions/cache@v2
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-
-      -
-        name: Login to DockerHub
-        uses: docker/login-action@v1
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
-      -
-        name: Build and push
-        uses: docker/build-push-action@v2
-        with:
-          context: .
-          file: ./Dockerfile
-          platforms: linux/amd64,linux/arm/v7,linux/arm64
-          push: true
-          tags: ${{ steps.prepare.outputs.tags }}
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
-      -
-        name: Inspect image
-        run: |
-          docker buildx imagetools inspect ${{ steps.prepare.outputs.inspect_tag }}

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,54 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ dev ]
+  schedule:
+    - cron: '28 13 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript', 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/project-actions.yml

@@ -0,0 +1,47 @@
+name: Project Automations
+
+on:
+  issues:
+    types:
+      - opened
+      - reopened
+  pull_request_target: #_target allows access to secrets
+    types:
+      - opened
+      - reopened
+    branches:
+      - main
+      - dev
+
+env:
+  todo: Todo
+  done: Done
+  in_progress: In Progress
+
+jobs:
+  issue_opened_or_reopened:
+    name: issue_opened_or_reopened
+    runs-on: ubuntu-latest
+    if: github.event_name == 'issues' && (github.event.action == 'opened' || github.event.action == 'reopened')
+    steps:
+      - name: Set issue status to ${{ env.todo }}
+        uses: leonsteinhaeuser/project-beta-automations@v1.2.1
+        with:
+          gh_token: ${{ secrets.GH_TOKEN }}
+          organization: paperless-ngx
+          project_id: 2
+          resource_node_id: ${{ github.event.issue.node_id }}
+          status_value: ${{ env.todo }} # Target status
+  pr_opened_or_reopened:
+    name: pr_opened_or_reopened
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request_target' && (github.event.action == 'opened' || github.event.action == 'reopened')
+    steps:
+      - name: Set PR status to ${{ env.in_progress }}
+        uses: leonsteinhaeuser/project-beta-automations@v1.2.1
+        with:
+          gh_token: ${{ secrets.GH_TOKEN }}
+          organization: paperless-ngx
+          project_id: 2
+          resource_node_id: ${{ github.event.pull_request.node_id }}
+          status_value: ${{ env.in_progress }} # Target status

.gitignore

@@ -61,6 +61,9 @@ target/
 # PyCharm
 .idea
 
+# VS Code
+.vscode
+
 # Other stuff that doesn't belong
 .virtualenv
 virtualenv

.pre-commit-config.yaml

@@ -0,0 +1,80 @@
+# This file configures pre-commit hooks.
+# See https://pre-commit.com/ for general information
+# See https://pre-commit.com/hooks.html for a listing of possible hooks
+
+repos:
+  # General hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: check-docstring-first
+      - id: check-json
+        exclude: "tsconfig.*json"
+      - id: check-yaml
+      - id: check-toml
+      - id: check-executables-have-shebangs
+      - id: end-of-file-fixer
+        exclude_types:
+          - svg
+          - pofile
+        exclude: "(^LICENSE$)"
+      - id: mixed-line-ending
+        args:
+          - "--fix=lf"
+      - id: trailing-whitespace
+        exclude_types:
+          - svg
+      - id: check-case-conflict
+      - id: detect-private-key
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v2.6.1"
+    hooks:
+      - id: prettier
+        types_or:
+          - javascript
+          - ts
+          - markdown
+        exclude: "(^Pipfile\\.lock$)"
+  # Python hooks
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.0.1
+    hooks:
+      - id: reorder-python-imports
+        exclude: "(migrations)"
+  - repo: https://github.com/asottile/yesqa
+    rev: "v1.3.0"
+    hooks:
+      - id: yesqa
+        exclude: "(migrations)"
+  - repo: https://github.com/asottile/add-trailing-comma
+    rev: "v2.2.1"
+    hooks:
+      - id: add-trailing-comma
+        exclude: "(migrations)"
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+        files: ^src/
+        args:
+          - "--config=./src/setup.cfg"
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+  # Dockerfile hooks
+  - repo: https://github.com/pryorda/dockerfilelint-precommit-hooks
+    rev: "v0.1.0"
+    hooks:
+      - id: dockerfilelint
+  # Shell script hooks
+  - repo: https://github.com/lovesegfault/beautysh
+    rev: v6.2.1
+    hooks:
+      - id: beautysh
+        args:
+          - "--tab"
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: "v0.8.0.4"
+    hooks:
+      - id: shellcheck

.prettierrc

@@ -0,0 +1,4 @@
+# https://prettier.io/docs/en/options.html#semicolons
+semi: false
+# https://prettier.io/docs/en/options.html#quotes
+singleQuote: true

.readthedocs.yml

@@ -11,6 +11,6 @@ sphinx:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
+  version: "3.8"
   install:
     - requirements: docs/requirements.txt

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+hello@paperless-ngx.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -1,30 +1,132 @@
 # Contributing
 
-There's still lots of things to be done, just have a look at that issue log. If you feel like conctributing to the project, please do! Bug fixes and improvements to the front end (I just can't seem to get some of these CSS things right) are always welcome.
+If you feel like contributing to the project, please do! Bug fixes and improvements are always welcome.
 
-If you want to implement something big: Please start a discussion about that in the issues! Maybe I've already had something similar in mind and we can make it happen together. However, keep in mind that the general roadmap is to make the existing features stable and get them tested. See the roadmap in the readme.
+If you want to implement something big:
 
-* When making additions to the project, consider if the majority of users will benefit from your change. If not, you're probably better of forking the project.
-* Also consider if your change will get in the way of other users. A good change is a change that enhances the experience of some users who want that change and does not affect users who do not care about the change.
+- Please start a discussion about that in the issues! Maybe something similar is already in development and we can make it happen together.
+- When making additions to the project, consider if the majority of users will benefit from your change. If not, you're probably better of forking the project.
+- Also consider if your change will get in the way of other users. A good change is a change that enhances the experience of some users who want that change and does not affect users who do not care about the change.
+- Please see the [paperless-ngx merge process](#merging-prs) below.
 
 ## Python
 
-Paperless supports python 3.6, 3.7, 3.8 and 3.9.
+Paperless supports python 3.8 and 3.9. We format Python code with [Black](https://github.com/psf/black).
 
 ## Branches
 
-master always reflects the latest release. Apart from changes to the documentation or readme, absolutely no functional changes on this branch in between releases.
+`main` always reflects the latest release. Apart from changes to the documentation or readme, absolutely no functional changes on this branch in between releases.
 
-dev contains all changes that will be part of the next release. Use this branch to start making your changes.
+`dev` contains all changes that will be part of the next release. Use this branch to start making your changes.
 
-feature-X branches is for experimental stuff that will eventually be merged into dev, and then released as part of the next release.
+`feature-X` branches are for experimental stuff that will eventually be merged into dev.
 
 ## Testing:
 
-I'm trying to get most of paperless tested, so please do the same for your code! I know its a hassle, but it makes sure that your code works now and will allow us to detect regressions easily.
+Please format and test your code! I know it's a hassle, but it makes sure that your code works now and will allow us to detect regressions easily.
 
-To test your code, execute `pytest` in the src/ directory. Executing that in the project root is no good. This also generates a html coverage report, which you can use to see if you missed anything important during testing.
+To test your code, execute `pytest` in the src/ directory. This also generates a html coverage report, which you can use to see if you missed anything important during testing.
+
+Before you can run `pytest`, ensure to [properly set up your local environment](https://paperless-ngx.readthedocs.io/en/latest/extending.html#initial-setup-and-first-start).
 
 ## More info:
 
-... is available in the documentation. https://paperless-ng.readthedocs.io/en/latest/extending.html
+... is available in the documentation. https://paperless-ngx.readthedocs.io/en/latest/extending.html
+
+# Merging PRs
+
+Once you have submitted a **P**ull **R**equest it will be reviewed, approved, and merged by one or more community members of any team. Automated code tests and formatting checks must be passed.
+
+## Non-Trivial Requests
+
+PRs deemed `non-trivial` will go through a stricter review process before being merged into `dev`. This is to ensure code quality and complete functionality (free of side effects).
+
+Examples of `non-trivial` PRs might include:
+
+- Additional features
+- Large changes to many distinct files
+- Breaking or depreciation of existing features
+
+Our community review process for `non-trivial` PRs is the following:
+
+1. Must pass usual automated code tests and formatting checks.
+2. The PR will be assigned and pinged to the appropriately experienced team (i.e. @paperless-ngx/backend for backend changes).
+3. Development team will check and test code manually (possibly over several days).
+   - You may be asked to make changes or rebase.
+   - The team may ask for additional testing done by @paperless-ngx/test
+4. **At least two** members of the team will approve and finally merge the request into `dev` 🎉.
+
+This process might be slow as community members have different schedules and time to dedicate to the Paperless project. However it ensures community code reviews are as brilliantly thorough as they once were with @jonaswinkler.
+
+# Translating Paperless-ngx
+
+Some notes about translation:
+
+- There are two resources:
+  - `src-ui/messages.xlf` contains the translation strings for the front end. This is the most important.
+  - `django.po` contains strings for the administration section of paperless, which is nice to have translated.
+- Most of the front-end strings are used on buttons, menu items, etc., so ideally the translated string should not be much longer than the English original.
+- Translation units may contain placeholders. These usually mean that there's a name of a tag or document or something in the string. You can click on the placeholders to copy them.
+- Translation units may contain plural expressions such as `{PLURAL_VAR, plural, =1 {one result} =0 {no results} other {<placeholder> results}}`. Copy these verbatim and translate only the content in the inner `{}` brackets. Example: `{PLURAL_VAR, plural, =1 {Ein Ergebnis} =0 {Keine Ergebnisse} other {<placeholder> Ergebnisse}}`
+- Changes to translations on Crowdin will get pushed into the repository automatically.
+
+## Adding new languages to the codebase
+
+If a language has already been added, and you would like to contribute new translations or change existing translations, please read the "Translation" section in the README.md file for further details on that.
+
+If you would like the project to be translated to another language, first head over to https://crwd.in/paperless-ngx to check if that language has already been enabled for translation.
+If not, please request the language to be added by creating an issue on GitHub. The issue should contain:
+
+- English name of the language (the localized name can be added on Crowdin).
+- ISO language code. A list of those can be found here: https://support.crowdin.com/enterprise/language-codes/
+- Date format commonly used for the language, e.g. dd/mm/yyyy, mm/dd/yyyy, etc.
+
+After the language has been added and some translations have been made on Crowdin, the language needs to be enabled in the code.
+Note that there is no need to manually add a .po of .xlf file as those will be automatically generated and imported from Crowdin.
+The following files need to be changed:
+
+- src-ui/angular.json (under the _projects/paperless-ui/i18n/locales_ JSON key)
+- src/paperless/settings.py (in the _LANGUAGES_ array)
+- src-ui/src/app/services/settings.service.ts (inside the _getLanguageOptions_ method)
+- src-ui/src/app/app.module.ts (import locale from _angular/common/locales_ and call _registerLocaleData_)
+
+Please add the language in the correct order, alphabetically by locale.
+Note that _en-us_ needs to stay on top of the list, as it is the default project language
+
+If you are familiar with Git, feel free to send a Pull Request with those changes.
+If not, let us know in the issue you created for the language, so that another developer can make these changes.
+
+# Organization Structure & Membership
+
+Paperless-ngx is a community project. We do our best to delegate permission and responsibility among a team of people to ensure the longevity of the project.
+
+## Structure
+
+As of writing, there are 21 members in paperless-ngx. 4 of these people have complete administrative privileges to the repo:
+
+- [@shamoon](https://github.com/shamoon)
+- [@bauerj](https://github.com/bauerj)
+- [@qcasey](https://github.com/qcasey)
+- [@FrankStrieter](https://github.com/FrankStrieter)
+
+There are 5 teams collaborating on specific tasks within paperless-ngx:
+
+- @paperless-ngx/backend (Python / django)
+- @paperless-ngx/frontend (JavaScript / Typescript)
+- @paperless-ngx/ci-cd (GitHub Actions / Deployment)
+- @paperless-ngx/issues (Issue triage)
+- @paperless-ngx/test (General testing for larger PRs)
+
+## Permissions
+
+All team members are notified when mentioned or assigned to a relevant issue or pull request. Additionally, each team has slightly different access to paperless-ngx:
+
+- The **test** team has no special permissions.
+- The **issues** team has `triage` access. This means they can organize issues and pull requests.
+- The **backend**, **frontend**, and **ci-cd** teams have `write` access. This means they can approve PRs and push code, containers, releases, and more.
+
+## Joining
+
+We are not overly strict with inviting people to the organization. If you have read the [team permissions](#permissions) and think having additional access would enhance your contributions, please reach out to an [admin](#structure) of the team.
+
+The admins occasionally invite contributors directly if we believe having them on a team will accelerate their work.

Dockerfile

@@ -1,63 +1,18 @@
-FROM ubuntu:20.04 AS jbig2enc
+FROM node:16 AS compile-frontend
 
-WORKDIR /usr/src/jbig2enc
+COPY . /src
 
-RUN apt-get update && apt-get install -y --no-install-recommends build-essential automake libtool libleptonica-dev zlib1g-dev git ca-certificates
+WORKDIR /src/src-ui
+RUN npm update npm -g && npm ci --no-optional
+RUN ./node_modules/.bin/ng build --configuration production
 
-RUN git clone https://github.com/agl/jbig2enc .
-RUN ./autogen.sh
-RUN ./configure && make
+FROM ghcr.io/paperless-ngx/builder/ngx-base:1.0 as main-app
 
-FROM python:3.7-slim
-
-# Binary dependencies
-RUN apt-get update \
-  && apt-get -y --no-install-recommends install \
-  	# Basic dependencies
-		curl \
-		file \
-		# fonts for text file thumbnail generation
-		fonts-liberation \
-		# for making translations further down
-		gettext \
-		gnupg \
-		imagemagick \
-		# for Numpy
-		libatlas-base-dev \
-		libxslt1-dev \
-		mime-support \
-		# thumbnail size reduction
-		optipng \
-		sudo \
-		tzdata \
-  	# OCRmyPDF dependencies
-		ghostscript \
-		icc-profiles-free \
-		liblept5 \
-		libxml2 \
-		pngquant \
-		qpdf \
-		tesseract-ocr \
-		tesseract-ocr-eng \
-		tesseract-ocr-deu \
-		tesseract-ocr-fra \
-		tesseract-ocr-ita \
-		tesseract-ocr-spa \
-		unpaper \
-		zlib1g \
-
-# This pulls in updated dependencies from bullseye to fix some issues with file type detection.
-# TODO: Remove this once bullseye releases.
-  && echo "deb http://deb.debian.org/debian bullseye main" > /etc/apt/sources.list.d/bullseye.list \
-  && apt-get update \
-  && apt-get install --no-install-recommends -y file libmagic-dev \
-  && rm -rf /var/lib/apt/lists/* \
-  && rm /etc/apt/sources.list.d/bullseye.list
-
-# copy jbig2enc
-COPY --from=jbig2enc /usr/src/jbig2enc/src/.libs/libjbig2enc* /usr/local/lib/
-COPY --from=jbig2enc /usr/src/jbig2enc/src/jbig2 /usr/local/bin/
-COPY --from=jbig2enc /usr/src/jbig2enc/src/*.h /usr/local/include/
+LABEL org.opencontainers.image.authors="paperless-ngx team <hello@paperless-ngx.com>"
+LABEL org.opencontainers.image.documentation="https://paperless-ngx.readthedocs.io/en/latest/"
+LABEL org.opencontainers.image.source="https://github.com/paperless-ngx/paperless-ngx"
+LABEL org.opencontainers.image.url="https://github.com/paperless-ngx/paperless-ngx"
+LABEL org.opencontainers.image.licenses="GPL-3.0-only"
 
 WORKDIR /usr/src/paperless/src/
 
@@ -65,45 +20,51 @@ COPY requirements.txt ../
 
 # Python dependencies
 RUN apt-get update \
+  # python-Levenshtein still needs to be compiled here
   && apt-get -y --no-install-recommends install \
-		build-essential \
-		libpq-dev \
-		libqpdf-dev \
-	&& python3 -m pip install --upgrade --no-cache-dir supervisor \
-  && python3 -m pip install --no-cache-dir -r ../requirements.txt \
-	&& apt-get -y purge build-essential libqpdf-dev \
-	&& apt-get -y autoremove --purge \
-	&& rm -rf /var/lib/apt/lists/*
+    build-essential \
+    && python3 -m pip install --upgrade --no-cache-dir pip wheel \
+  && python3 -m pip install --default-timeout=1000 --upgrade --no-cache-dir supervisor \
+  && python3 -m pip install --default-timeout=1000 --no-cache-dir -r ../requirements.txt \
+  && apt-get -y purge build-essential \
+  && apt-get -y autoremove --purge \
+  && rm -rf /var/lib/apt/lists/*
 
 # setup docker-specific things
 COPY docker/ ./docker/
 
 RUN cd docker \
-  && cp imagemagick-policy.xml /etc/ImageMagick-6/policy.xml \
-	&& mkdir /var/log/supervisord /var/run/supervisord \
-	&& cp supervisord.conf /etc/supervisord.conf \
-	&& cp docker-entrypoint.sh /sbin/docker-entrypoint.sh \
-	&& chmod 755 /sbin/docker-entrypoint.sh \
-	&& chmod +x install_management_commands.sh \
-	&& ./install_management_commands.sh \
-	&& cd .. \
-	&& rm docker -rf
+    && cp imagemagick-policy.xml /etc/ImageMagick-6/policy.xml \
+  && mkdir /var/log/supervisord /var/run/supervisord \
+  && cp supervisord.conf /etc/supervisord.conf \
+  && cp docker-entrypoint.sh /sbin/docker-entrypoint.sh \
+  && chmod 755 /sbin/docker-entrypoint.sh \
+  && cp docker-prepare.sh /sbin/docker-prepare.sh \
+  && chmod 755 /sbin/docker-prepare.sh \
+  && chmod +x install_management_commands.sh \
+  && ./install_management_commands.sh \
+  && cd .. \
+  && rm -rf docker/
 
 COPY gunicorn.conf.py ../
 
 # copy app
-COPY src/ ./
+COPY --from=compile-frontend /src/src/ ./
 
 # add users, setup scripts
 RUN addgroup --gid 1000 paperless \
-	&& useradd --uid 1000 --gid paperless --home-dir /usr/src/paperless paperless \
-	&& chown -R paperless:paperless ../ \
-	&& sudo -HEu paperless python3 manage.py collectstatic --clear --no-input \
-	&& sudo -HEu paperless python3 manage.py compilemessages
+  && useradd --uid 1000 --gid paperless --home-dir /usr/src/paperless paperless \
+  && chown -R paperless:paperless ../ \
+  && gosu paperless python3 manage.py collectstatic --clear --no-input \
+  && gosu paperless python3 manage.py compilemessages
+
+VOLUME ["/usr/src/paperless/data", \
+        "/usr/src/paperless/media", \
+        "/usr/src/paperless/consume", \
+        "/usr/src/paperless/export"]
 
-VOLUME ["/usr/src/paperless/data", "/usr/src/paperless/media", "/usr/src/paperless/consume", "/usr/src/paperless/export"]
 ENTRYPOINT ["/sbin/docker-entrypoint.sh"]
-EXPOSE 8000
-CMD ["/usr/local/bin/supervisord", "-c", "/etc/supervisord.conf"]
 
-LABEL maintainer="Jonas Winkler <dev@jpwinkler.de>"
+EXPOSE 8000
+
+CMD ["/usr/local/bin/supervisord", "-c", "/etc/supervisord.conf"]

Pipfile

@@ -9,39 +9,36 @@ verify_ssl = true
 name = "piwheels"
 
 [packages]
-dateparser = "~=0.7.6"
-django = "~=3.1.3"
+dateparser = "~=1.1"
+django = "~=4.0"
 django-cors-headers = "*"
 django-extensions = "*"
-django-filter = "~=2.4.0"
-django-q = "~=1.3.4"
-djangorestframework = "~=3.12.2"
+django-filter = "~=21.1"
+django-q = "~=1.3"
+djangorestframework = "~=3.13"
 filelock = "*"
 fuzzywuzzy = {extras = ["speedup"], version = "*"}
 gunicorn = "*"
 imap-tools = "*"
 langdetect = "*"
-# numpy 1.20.0 drops python 3.6 support
-numpy = "~=1.19.5"
 pathvalidate = "*"
-# pinned to 8.1.0, since aarch64 wheels might not be available beyond that https://github.com/python-pillow/Pillow/issues/5202
-pillow = "==8.1.0"
-pikepdf = "~=2.5.0"
+pillow = "~=9.0"
+# Any version update to pikepdf requires a base image update
+pikepdf = "~=5.1"
 python-gnupg = "*"
 python-dotenv = "*"
 python-dateutil = "*"
 python-magic = "*"
-psycopg2-binary = "*"
+# Any version update to psycopg2 requires a base image update
+psycopg2 = "*"
 redis = "*"
 # Pinned because aarch64 wheels and updates cause warnings when loading the classifier model.
-scikit-learn="==0.24.0"
-# Prevent scipy updates because 1.6 is incompatible with python 3.6
-scipy="~=1.5.4"
-whitenoise = "~=5.2.0"
-watchdog = "~=1.0.0"
+scikit-learn="==1.0.2"
+whitenoise = "~=6.0.0"
+watchdog = "~=2.1.0"
 whoosh="~=2.7.4"
-inotifyrecursive = "~=0.3.4"
-ocrmypdf = "~=11.6"
+inotifyrecursive = "~=0.3"
+ocrmypdf = "~=13.4"
 tqdm = "*"
 tika = "*"
 # TODO: This will sadly also install daphne+dependencies,
@@ -50,11 +47,10 @@ channels = "~=3.0"
 channels-redis = "*"
 uvicorn = {extras = ["standard"], version = "*"}
 concurrent-log-handler = "*"
-# uvloop 0.15+ incompatible with python 3.6
-uvloop = "~=0.14.0"
-# TODO: keep an eye on piwheel builds and update this once available (https://www.piwheels.org/project/cryptography/)
-cryptography = "~=3.3.2"
 "pdfminer.six" = "*"
+"backports.zoneinfo" = {version = "*", markers = "python_version < '3.9'"}
+"importlib-resources" = {version = "*", markers = "python_version < '3.9'"}
+zipp = {version = "*", markers = "python_version < '3.9'"}
 
 [dev-packages]
 coveralls = "*"
@@ -66,6 +62,8 @@ pytest-django = "*"
 pytest-env = "*"
 pytest-sugar = "*"
 pytest-xdist = "*"
-sphinx = "~=3.4.2"
+sphinx = "~=4.4.0"
 sphinx_rtd_theme = "*"
 tox = "*"
+black = "*"
+pre-commit = "*"

README.md

@@ -1,112 +1,120 @@
-[![ci](https://github.com/jonaswinkler/paperless-ng/workflows/ci/badge.svg)](https://github.com/jonaswinkler/paperless-ng/actions)
-![Ansible Role](https://github.com/jonaswinkler/paperless-ng/workflows/Ansible%20Role/badge.svg)
-[![Documentation Status](https://readthedocs.org/projects/paperless-ng/badge/?version=latest)](https://paperless-ng.readthedocs.io/en/latest/?badge=latest)
-[![Gitter](https://badges.gitter.im/paperless-ng/community.svg)](https://gitter.im/paperless-ng/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Docker Hub Pulls](https://img.shields.io/docker/pulls/jonaswinkler/paperless-ng.svg)](https://hub.docker.com/r/jonaswinkler/paperless-ng)
-[![Coverage Status](https://coveralls.io/repos/github/jonaswinkler/paperless-ng/badge.svg?branch=master)](https://coveralls.io/github/jonaswinkler/paperless-ng?branch=master)
+[![ci](https://github.com/paperless-ngx/paperless-ngx/workflows/ci/badge.svg)](https://github.com/paperless-ngx/paperless-ngx/actions)
+[![Crowdin](https://badges.crowdin.net/paperless-ngx/localized.svg)](https://crowdin.com/project/paperless-ngx)
+[![Documentation Status](https://readthedocs.org/projects/paperless-ngx/badge/?version=latest)](https://paperless-ngx.readthedocs.io/en/latest/?badge=latest)
+[![Coverage Status](https://coveralls.io/repos/github/paperless-ngx/paperless-ngx/badge.svg?branch=master)](https://coveralls.io/github/paperless-ngx/paperless-ngx?branch=master)
+[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#paperless:adnidor.de)
 
-# Paperless-ng
+<p align="center">
+<img src="https://github.com/paperless-ngx/paperless-ngx/raw/main/resources/logo/web/png/Black%20logo%20-%20no%20background.png#gh-light-mode-only" width="50%" />
+<img src="https://github.com/paperless-ngx/paperless-ngx/raw/main/resources/logo/web/png/White%20logo%20-%20no%20background.png#gh-dark-mode-only" width="50%" />
+</p>
 
-[Paperless (click me)](https://github.com/the-paperless-project/paperless) is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents.
+<!-- omit in toc -->
 
-Paperless-ng is a fork of the original project, adding a new interface and many other changes under the hood. These key points should help you decide whether Paperless-ng is something you would prefer over Paperless:
+# Paperless-ngx
 
-* Interface: The new front end is the main interface for paperless-ng, the old interface still exists but most customizations (such as thumbnails for the document list) have been removed.
-* Encryption: Paperless-ng does not support GnuPG anymore, since storing your data on encrypted file systems (that you optionally mount on demand) achieves about the same result.
-* Resource usage: Paperless-ng does use a bit more resources than Paperless. Running the web server requires about 300MB of RAM or more, depending on the configuration. While adding documents, it requires about 300MB additional RAM, depending on the document. It still runs on Pi (many users do that), but it has been generally geared to better use the resources of more powerful systems.
-* API changes: If you rely on the REST API of paperless, some of its functionality has been changed.
+Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, _less paper_.
 
-For a detailed list of changes, have a look at the [change log](https://paperless-ng.readthedocs.io/en/latest/changelog.html) in the documentation.
+Paperless-ngx forked from [paperless-ng](https://github.com/jonaswinkler/paperless-ng) to continue the great work and distribute responsibility of supporting and advancing the project among a team of people. [Consider joining us!](#community-support) Discussion of this transition can be found in issues
+[#1599](https://github.com/jonaswinkler/paperless-ng/issues/1599) and [#1632](https://github.com/jonaswinkler/paperless-ng/issues/1632).
 
-# How it Works
+A demo is available at [demo.paperless-ngx.com](https://demo.paperless-ngx.com) using login `demo` / `demo`. _Note: demo content is reset frequently and confidential information should not be uploaded._
 
-Paperless does not control your scanner, it only helps you deal with what your scanner produces.
-
-1. Buy a document scanner that can write to a place on your network.  If you need some inspiration, have a look at the [scanner recommendations](https://paperless-ng.readthedocs.io/en/latest/scanners.html) page. Set it up to "scan to FTP" or something similar. It should be able to push scanned images to a server without you having to do anything.  Of course if your scanner doesn't know how to automatically upload the file somewhere, you can always do that manually. Paperless doesn't care how the documents get into its local consumption directory.
-
-	- Alternatively, you can use any of the mobile scanning apps out there. We have an app that allows you to share documents with paperless, if you're on Android. See the section on affiliated projects.
-
-2. Wait for paperless to process your files. OCR is expensive, and depending on the power of your machine, this might take a bit of time.
-3. Use the web frontend to sift through the database and find what you want.
-4. Download the PDF you need/want via the web interface and do whatever you like with it.  You can even print it and send it as if it's the original. In most cases, no one will care or notice.
-
-Here's what you get:
-
-![Dashboard](https://github.com/jonaswinkler/paperless-ng/raw/master/docs/_static/screenshots/dashboard.png)
+- [Features](#features)
+- [Getting started](#getting-started)
+- [Contributing](#contributing)
+  - [Community Support](#community-support)
+  - [Translation](#translation)
+  - [Feature Requests](#feature-requests)
+  - [Bugs](#bugs)
+- [Affiliated Projects](#affiliated-projects)
+- [Important Note](#important-note)
 
 # Features
 
-* Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents.
-* Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents).
-	* Office document support is optional and provided by Apache Tika (see [configuration](https://paperless-ng.readthedocs.io/en/latest/configuration.html#tika-settings))
-* Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely.
-* Single page application front end.
-	* Includes a dashboard that shows basic statistics and has document upload.
-	* Filtering by tags, correspondents, types, and more.
-	* Customizable views can be saved and displayed on the dashboard.
-* Full text search helps you find what you need.
-	* Auto completion suggests relevant words from your documents.
-	* Results are sorted by relevance to your search query.
-	* Highlighting shows you which parts of the document matched the query.
-	* Searching for similar documents ("More like this")
-* Email processing: Paperless adds documents from your email accounts.
-	* Configure multiple accounts and filters for each account.
-	* When adding documents from mail, paperless can move these mail to a new folder, mark them as read, flag them as important or delete them.
-* Machine learning powered document matching.
-	* Paperless learns from your documents and will be able to automatically assign tags, correspondents and types to documents once you've stored a few documents in paperless.
-* Optimized for multi core systems: Paperless-ng consumes multiple documents in parallel.
-* The integrated sanity checker makes sure that your document archive is in good health.
+![Dashboard](https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docs/_static/screenshots/documents-wchrome.png#gh-light-mode-only)
+![Dashboard](https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docs/_static/screenshots/documents-wchrome-dark.png#gh-dark-mode-only)
 
-If you want to see some screenshots of paperless-ng in action, [some are available in the documentation](https://paperless-ng.readthedocs.io/en/latest/screenshots.html).
+- Organize and index your scanned documents with tags, correspondents, types, and more.
+- Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents.
+- Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents).
+  - Office document support is optional and provided by Apache Tika (see [configuration](https://paperless-ngx.readthedocs.io/en/latest/configuration.html#tika-settings))
+- Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely.
+- Single page application front end.
+  - Includes a dashboard that shows basic statistics and has document upload.
+  - Filtering by tags, correspondents, types, and more.
+  - Customizable views can be saved and displayed on the dashboard.
+- Full text search helps you find what you need.
+  - Auto completion suggests relevant words from your documents.
+  - Results are sorted by relevance to your search query.
+  - Highlighting shows you which parts of the document matched the query.
+  - Searching for similar documents ("More like this")
+- Email processing: Paperless adds documents from your email accounts.
+  - Configure multiple accounts and filters for each account.
+  - When adding documents from mail, paperless can move these mail to a new folder, mark them as read, flag them as important or delete them.
+- Machine learning powered document matching.
+  - Paperless-ngx learns from your documents and will be able to automatically assign tags, correspondents and types to documents once you've stored a few documents in paperless.
+- Optimized for multi core systems: Paperless-ngx consumes multiple documents in parallel.
+- The integrated sanity checker makes sure that your document archive is in good health.
+- [More screenshots are available in the documentation](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html).
 
 # Getting started
 
-The recommended way to deploy paperless is docker-compose. The files in the /docker/hub directory are configured to pull the image from Docker Hub.
+The easiest way to deploy paperless is docker-compose. The files in the [`/docker/compose` directory](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose) are configured to pull the image from Github Packages.
 
-Read the [documentation](https://paperless-ng.readthedocs.io/en/latest/setup.html#installation) on how to get started.
+If you'd like to jump right in, you can configure a docker-compose environment with our install script:
 
-Alternatively, you can install the dependencies and setup apache and a database server yourself. The documenation has a step by step guide on how to do it.
+```bash
+bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
+```
 
-# Migrating to paperless-ng
+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.
 
-Read the section about [migration](https://paperless-ng.readthedocs.io/en/latest/setup.html#migration-to-paperless-ng) in the documentation. Its also entirely possible to go back to paperless by reverting the database migrations.
+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
+<!-- omit in toc -->
 
-The documentation for Paperless-ng is available on [ReadTheDocs](https://paperless-ng.readthedocs.io/).
+### Documentation
 
-# Translation
+The documentation for Paperless-ngx is available on [ReadTheDocs](https://paperless-ngx.readthedocs.io/).
 
-Paperless is currently available in English, German, Dutch, French, and Portuguese.
+# Contributing
 
-There's an active translation project at transifex! If you want to help out by translating paperless into your language, please head over to https://github.com/jonaswinkler/paperless-ng/issues/212 for details.
+If you feel like contributing to the project, please do! Bug fixes, enhancements, visual fixes etc. are always welcome. If you want to implement something big: Please start a discussion about that! The [documentation](https://paperless-ngx.readthedocs.io/en/latest/extending.html) has some basic information on how to get started.
 
-# Feature Requests
+## Community Support
 
-Feature requests can be submitted via [GitHub Discussions](https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests), you can search for existing ideas, add your own and vote for the ones you care about! Note that some older feature requests can also be found under [issues](https://github.com/jonaswinkler/paperless-ng/issues).
+People interested in continuing the work on paperless-ngx are encouraged to reach out here on github and in the [Matrix Room](https://matrix.to/#/#paperless:adnidor.de). If you would like to contribute to the project on an ongoing basis there are multiple [teams](https://github.com/orgs/paperless-ngx/people) (frontend, ci/cd, etc) that could use your help so please reach out!
 
-# Questions? Something not working?
+## Translation
 
-For bugs please [open an issue](https://github.com/jonaswinkler/paperless-ng/issues) or [start a discussion](https://github.com/jonaswinkler/paperless-ng/discussions) if you have questions.
+Paperless-ngx is available in many languages that are coordinated on Crowdin. If you want to help out by translating paperless-ngx into your language, please head over to https://crwd.in/paperless-ngx, and thank you! More details can be found in [CONTRIBUTING.md](https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md#translating-paperless-ngx).
 
-## Feel like helping out?
+## Feature Requests
 
-There's still lots of things to be done, just have a look at open issues & discussions. If you feel like contributing to the project, please do! Bug fixes and improvements to the front end (I just can't seem to get some of these CSS things right) are always welcome. The documentation has some basic information on how to get started.
+Feature requests can be submitted via [GitHub Discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests), you can search for existing ideas, add your own and vote for the ones you care about.
 
-If you want to implement something big: Please start a discussion about that in the issues! Maybe I've already had something similar in mind and we can make it happen together. However, keep in mind that the general roadmap is to make the existing features stable and get them tested. See the roadmap above.
+## Bugs
+
+For bugs please [open an issue](https://github.com/paperless-ngx/paperless-ngx/issues) or [start a discussion](https://github.com/paperless-ngx/paperless-ngx/discussions) if you have questions.
 
 # Affiliated Projects
 
-Paperless has been around a while now, and people are starting to build stuff on top of it.  If you're one of those people, we can add your project to this list:
+Paperless has been around a while now, and people are starting to build stuff on top of it. If you're one of those people, we can add your project to this list:
 
-* [Paperless App](https://github.com/bauerj/paperless_app): An Android/iOS app for Paperless. Updated to work with paperless-ng.
-* [Paperless Share](https://github.com/qcasey/paperless_share). Share any files from your Android application with paperless. Very simple, but works with all of the mobile scanning apps out there that allow you to share scanned documents.
+- [Paperless App](https://github.com/bauerj/paperless_app): An Android/iOS app for Paperless-ngx. Also works with the original Paperless and Paperless-ngx.
+- [Paperless Share](https://github.com/qcasey/paperless_share). Share any files from your Android application with paperless. Very simple, but works with all of the mobile scanning apps out there that allow you to share scanned documents.
+- [Scan to Paperless](https://github.com/sbrunner/scan-to-paperless): Scan and prepare (crop, deskew, OCR, ...) your documents for Paperless.
 
-These projects also exist, but their status and compatibility with paperless-ng is unknown.
+These projects also exist, but their status and compatibility with paperless-ngx is unknown.
 
-* [Paperless Desktop](https://github.com/thomasbrueggemann/paperless-desktop): A desktop UI for your Paperless installation.  Runs on Mac, Linux, and Windows.
-* [paperless-cli](https://github.com/stgarf/paperless-cli): A golang command line binary to interact with a Paperless instance.
+- [paperless-cli](https://github.com/stgarf/paperless-cli): A golang command line binary to interact with a Paperless instance.
+
+This project also exists, but needs updates to be compatible with paperless-ngx.
+
+- [Paperless Desktop](https://github.com/thomasbrueggemann/paperless-desktop): A desktop UI for your Paperless installation. Runs on Mac, Linux, and Windows.
+  Known issues on Mac: (Could not load reminders and documents)
 
 # Important Note
 
-Document scanners are typically used to scan sensitive documents.  Things like your social insurance number, tax records, invoices, etc.  Everything is stored in the clear without encryption. This means that Paperless should never be run on an untrusted host.  Instead, I recommend that if you do want to use it, run it locally on a server in your own home.
+Document scanners are typically used to scan sensitive documents. Things like your social insurance number, tax records, invoices, etc. Everything is stored in the clear without encryption. This means that Paperless should never be run on an untrusted host. Instead, I recommend that if you do want to use it, run it locally on a server in your own home.

ansible/README.md

@@ -1,114 +0,0 @@
-Ansible Role: paperless-ng
-==========================
-
-Installs and configures paperless-ng EDMS on Debian/Ubuntu systems.
-
-Requirements
-------------
-
-No special system requirements. Ansible 2.7 or newer is required.
-
-Note that this role requires root access, so either run it in a playbook with a global `become: yes`, or invoke the role in your playbook like:
-
-    - hosts: all
-      roles:
-        - role: ansible
-          become: yes
-
-Role Variables
---------------
-
-Most configuration variables from paperless-ng itself are available and accept their respective arguments.
-Every `PAPERLESS_*` configuration varaible is lowercased and instead prefixed with `paperlessng_*` in `defaults/main.yml`.
-
-For a full listing including explainations and allowed values, see the current [documentation](https://paperless-ng.readthedocs.io/en/ng-0.9.14/configuration.html).
-
-Additional variables available in this role are listed below, along with default values:
-
-    paperlessng_version: 0.9.14
-
-The [release](https://github.com/jonaswinkler/paperless-ng/releases) archive version of paperless-ng to install.
-
-    paperlessng_redis_host: localhost
-    paperlessng_redis_port: 6379
-
-Seperate configuration values that combine into `PAPERLESS_REDIS`.
-
-    paperlessng_db_type: sqlite
-
-Database to use. Default is file-based SQLite.
-
-    paperlessng_db_host: localhost
-    paperlessng_db_port: 5432
-    paperlessng_db_name: paperlessng
-    paperlessng_db_user: paperlessng
-    paperlessng_db_pass: paperlessng
-    paperlessng_db_sslmode: prefer
-
-Database configuration (only applicable if `paperlessng_db_type == 'postgresql'`).
-
-    paperlessng_directory: /opt/paperless-ng
-
-Root directory paperless-ng is installed into.
-
-    paperlessng_virtualenv: "{{ paperlessng_directory }}/.venv"
-
-Directory used for the virtual environment for paperless-ng.
-
-    paperlessng_ocr_languages:
-      - eng
-
-List of OCR languages to install and configure (`apt search tesseract-ocr-*`).
-
-    paperlessng_use_jbig2enc: True
-
-Whether to install and use [jbig2enc](https://github.com/agl/jbig2enc) for OCRmyPDF.
-
-    paperlessng_big2enc_lossy: False
-
-Whether to use jbig2enc's lossy compression mode.
-
-    paperlessng_superuser_name: paperlessng
-    paperlessng_superuser_email: paperlessng@example.com
-    paperlessng_superuser_password: paperlessng
-
-Credentials of the initial superuser in paperless-ng.
-
-    paperlessng_system_user: paperlessng
-    paperlessng_system_group: paperlessng
-
-System user and group to run the paperless-ng services as (will be created if required).
-
-    paperlessng_listen_address: 127.0.0.1
-    paperlessng_listen_port: 8000
-
-Address and port for the paperless-ng service to listen on.
-
-Dependencies
-------------
-
-No ansible dependencies.
-
-Example Playbook
-----------------
-`playbook.yml`:
-
-    - hosts: all
-      become: yes
-      vars_files:
-        - vars/main.yml
-      roles:
-        - ansible
-
-`vars/main.yml`:
-
-    paperlessng_media_root: /mnt/media/smbshare
-
-    paperlessng_db_type: postgresql
-    paperlessng_db_pass: PLEASEPROVIDEASTRONGPASSWORDHERE
-
-    paperlessng_secret_key: AGAINPLEASECHANGETHISNOW
-
-    paperlessng_ocr_languages:
-      - eng
-      - deu

ansible/defaults/main.yml

@@ -1,83 +0,0 @@
----
-paperlessng_version: latest  # 'latest', release number, or github branch/tag/commit/ref
-
-# Required services
-paperlessng_redis_host: localhost
-paperlessng_redis_port: 6379
-paperlessng_db_type: sqlite # or postgresql
-# Below entries only apply for paperlessng_db_type=='postgresql'
-paperlessng_db_host: localhost
-paperlessng_db_port: 5432
-paperlessng_db_name: paperlessng
-paperlessng_db_user: paperlessng
-paperlessng_db_pass: paperlessng
-paperlessng_db_sslmode: prefer
-
-# Paths and folders
-paperlessng_directory: /opt/paperless-ng
-paperlessng_consumption_dir: "{{ paperlessng_directory }}/consumption"
-paperlessng_data_dir: "{{ paperlessng_directory }}/data"
-paperlessng_media_root: "{{ paperlessng_directory }}/media"
-paperlessng_staticdir: "{{ paperlessng_directory }}/static"
-paperlessng_filename_format:
-paperlessng_logging_dir: "{{ paperlessng_data_dir }}/log"
-paperlessng_virtualenv: "{{ paperlessng_directory }}/.venv"
-
-# Hosting & Security
-paperlessng_secret_key: PLEASECHANGETHISFORTHELOVEOFGOD
-paperlessng_allowed_hosts: "*"
-paperlessng_cors_allowed_hosts: http://localhost:8000
-paperlessng_force_script_name:
-paperlessng_static_url: /static/
-paperlessng_auto_login_username:
-paperlessng_cookie_prefix: ""
-paperlessng_enable_http_remote_user: False
-
-# OCR settings
-paperlessng_ocr_languages:
-  - eng
-paperlessng_ocr_mode: skip
-paperlessng_ocr_clean: clean
-paperlessng_ocr_deskew: True
-paperlessng_ocr_rotate_pages: True
-paperlessng_ocr_rotate_pages_threshold: 12
-paperlessng_ocr_output_type: pdfa
-paperlessng_ocr_pages: 0
-paperlessng_ocr_image_dpi:
-# see https://ocrmypdf.readthedocs.io/en/latest/api.html#ocrmypdf.ocr
-paperlessng_ocr_user_args:
-  - "optimize": 1
-paperlessng_use_jbig2enc: True
-paperlessng_big2enc_lossy: False
-
-# Tika settings
-paperlessng_tika_enabled: False
-paperlessng_tika_endpoint: http://localhost:9998
-paperlessng_tika_gotenberg_endpoint: http://localhost:3000
-
-# Software tweaks
-paperlessng_time_zone: Europe/Berlin
-paperlessng_consumer_polling: 0
-paperlessng_consumer_delete_duplicates: False
-paperlessng_consumer_recursive: False
-paperlessng_consumer_subdirs_as_tags: False
-paperlessng_convert_memory_limit: 0
-paperlessng_convert_tmpdir:
-paperlessng_optimize_thumbnails: True
-paperlessng_post_consume_script:
-paperlessng_filename_date_order:
-paperlessng_thumbnail_font_name: /usr/share/fonts/liberation/LiberationSerif-Regular.ttf
-paperlessng_ignore_dates: ""
-
-# Superuser settings
-paperlessng_superuser_name: paperlessng
-paperlessng_superuser_email: paperlessng@example.com
-paperlessng_superuser_password: paperlessng
-
-# System user settings
-paperlessng_system_user: paperlessng
-paperlessng_system_group: paperlessng
-
-# Webserver settings
-paperlessng_listen_address: 127.0.0.1
-paperlessng_listen_port: 8000

ansible/meta/main.yml

@@ -1,17 +0,0 @@
-dependencies: []
-
-galaxy_info:
-  author: C0nsultant
-  description: Bare-metal deployment of paperless-ng DMS
-  license: license (GPLv3)
-  min_ansible_version: 2.7
-
-  platforms:
-    - name: Debian
-      versions:
-        - buster
-    - name: Ubuntu
-      versions:
-        - focal
-
-  galaxy_tags: [EDMS, django, python, web]

ansible/molecule/default/converge.yml

@@ -1,16 +0,0 @@
----
-- name: update previous release to newest release
-  hosts: all
-  tasks:
-    - name: install git dependency
-      apt:
-        pkg: git
-    - name: obtain latest git hash in current tree
-      command: git rev-parse HEAD
-      register: git_hash
-    - name: set current github commit as version when available
-      set_fact:
-        paperlessng_version: "{{ git_hash.stdout }}"
-    - name: update to newest paperless-ng release
-      include_role:
-        name: ansible

ansible/molecule/default/molecule.yml

@@ -1,35 +0,0 @@
----
-dependency:
-  name: galaxy
-driver:
-  name: docker
-platforms:
-  - name: ubuntu_focal
-    image: jrei/systemd-ubuntu:20.04
-    privileged: true
-    volumes:
-      - /sys/fs/cgroup:/sys/fs/cgroup:ro
-    tmpfs:
-      - /tmp
-      - /run
-      - /run/lock
-    override_command: False
-  # ubuntu 18.04 bionic works except that
-  #   the default redis configuration expects IPv6 which is not enabled in docker by default
-  #   the default Python environment is configured for ASCII instead of UTF-8
-  # ubuntu 16.04 xenial only has Python 3.5 which is EOL and breaks multiple dependencies
-  - name: debian_buster
-    image: jrei/systemd-debian:10
-    privileged: true
-    volumes:
-      - /sys/fs/cgroup:/sys/fs/cgroup:ro
-    tmpfs:
-      - /tmp
-      - /run
-      - /run/lock
-    override_command: False
-  # debian 9 stretch only has Python 3.5 which is EOL and breaks multiple dependencies
-provisioner:
-  name: ansible
-verifier:
-  name: ansible

ansible/molecule/default/prepare.yml

@@ -1,10 +0,0 @@
-- name: install previous release
-  hosts: all
-  tasks:
-    - name: set previous version as installation target
-      set_fact:
-        paperlessng_version: latest
-
-    - name: install previous paperless-ng release
-      include_role:
-        name: ansible

ansible/molecule/default/verify.yml

@@ -1,94 +0,0 @@
----
-- name: Verify
-  hosts: all
-  gather_facts: false
-
-  vars_files:
-    - ../../defaults/main.yml
-
-  tasks:
-    - name: check if webserver is up
-      uri:
-        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}"
-        status_code: [200, 302]
-        return_content: yes
-      register: landingpage
-      failed_when: "'Sign in</button>' not in landingpage.content"
-
-    - name: generate random name and content
-      set_fact:
-        content: "{{ lookup('password', '/dev/null length=65536 chars=ascii_letters') }}"
-        filename: "{{ lookup('password', '/dev/null length=8 chars=ascii_letters') }}"
-
-    - name: check if document posting works
-      uri:
-        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/documents/post_document/"
-        method: POST
-        body_format: form-multipart
-        body:
-          document:
-            content: "{{ content }}"
-            filename: "{{ filename }}.txt"
-        headers:
-          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
-          Content-Type: text/plain
-        return_content: yes
-      register: post_document
-      failed_when: "'OK' not in post_document.content"
-
-    - name: verify uploaded document has been accepted
-      uri:
-        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/logs/paperless/"
-        headers:
-          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
-        return_content: yes
-      register: logs
-      failed_when: "('Consuming ' + filename + '.txt') not in logs.content"
-
-    - name: sleep till consumption finished
-      pause:
-        seconds: 10
-
-    - name: verify uploaded document has been consumed
-      uri:
-        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/logs/paperless/"
-        headers:
-          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
-        return_content: yes
-      register: logs
-      failed_when: "filename + ' consumption finished' not in logs.content"
-
-    - name: get documents
-      uri:
-        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/documents/"
-        headers:
-          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
-        return_content: yes
-      register: documents
-
-    - name: set document index
-      set_fact:
-        index: "{{ documents.json['results'][0]['id'] }}"
-
-    - name: verify uploaded document is avaiable
-      uri:
-        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/documents/{{ index }}/"
-        headers:
-          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
-        return_content: yes
-      register: document
-      failed_when: "'Not found.' in document.content or content not in document.json['content']"
-
-    - name: check if deleting uploaded document works
-      uri:
-        url: "http://{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}/api/documents/bulk_edit/"
-        method: POST
-        body_format: json
-        body:
-          documents: ["{{ index }}"]
-          method: delete
-          parameters: {}
-        headers:
-          Authorization: 'Basic {{ (paperlessng_superuser_name + ":" + paperlessng_superuser_password) | b64encode }}'
-      register: delete_document
-      failed_when: "'OK' not in delete_document.json['result']"

ansible/tasks/install-release.yml

@@ -1,6 +0,0 @@
----
-- name: extract paperless-ng
-  unarchive:
-    src: "https://github.com/jonaswinkler/paperless-ng/releases/download/ng-{{ paperlessng_version }}/paperless-ng-{{ paperlessng_version }}.tar.xz"
-    remote_src: yes
-    dest: "{{ tempdir.path }}"

ansible/tasks/install-source.yml

@@ -1,112 +0,0 @@
----
-- name: install dev dependencies
-  apt:
-    pkg:
-      - git
-      - npm
-      - gettext
-
-- name: create output directories
-  file:
-    path: "{{ item }}"
-    state: directory
-    owner: "{{ paperlessng_system_user }}"
-    group: "{{ paperlessng_system_group }}"
-    mode: "750"
-  with_items:
-    - "{{ tempdir.path }}/paperless-ng"
-    - "{{ tempdir.path }}/paperless-ng/scripts"
-
-- block:
-    - name: create temporary git directory
-      tempfile:
-        state: directory
-        path: "{{ paperlessng_directory }}"
-      register: gitdir
-
-    - name: pull paperless-ng
-      git:
-        repo: https://github.com/jonaswinkler/paperless-ng.git
-        dest: "{{ gitdir.path }}"
-        version: "{{ paperlessng_version }}"
-        refspec: "+refs/pull/*:refs/pull/*"
-
-    - name: compile frontend
-      command:
-        cmd: "{{ item }}"
-      args:
-        chdir: "{{ gitdir.path }}/src-ui"
-      failed_when: false
-      with_items:
-        - npm install -g @angular/cli
-        - npm install
-        - ./node_modules/.bin/ng build --prod
-
-    - name: copy application into place
-      copy:
-        src: "{{ gitdir.path }}/{{ item.src }}"
-        remote_src: yes
-        dest: "{{ tempdir.path }}/paperless-ng/{{ item.dest | default('') }}"
-      with_items:
-        - src: CONTRIBUTING.md
-        - src: LICENSE
-        - src: Pipfile
-        - src: Pipfile.lock
-        - src: README.md
-        - src: requirements.txt
-        - src: gunicorn.conf.py
-        - src: paperless.conf.example
-          dest: "paperless.conf"
-
-    - name: glob all scripts
-      find:
-        paths: ["{{ gitdir.path }}/scripts/"]
-        patterns:
-          - "*.service"
-          - "*.sh"
-      register: glob
-
-    - name: copy scripts
-      copy:
-        src: "{{ item.path }}"
-        remote_src: yes
-        dest: "{{ tempdir.path }}/paperless-ng/scripts/"
-      with_items:
-        - "{{ glob.files }}"
-
-    - name: copy sources
-      command:
-        cmd: "cp -r src/ {{ tempdir.path }}/paperless-ng/src"
-      args:
-        chdir: "{{ gitdir.path }}"
-
-    - name: create paperlessng venv
-      command:
-        cmd: "python3 -m virtualenv {{ gitdir.path }}/.venv/ -p /usr/bin/python3"
-
-    - name: install paperlessng requirements
-      command:
-        cmd: "{{ gitdir.path }}/.venv/bin/python3 -m pip install -r {{ gitdir.path }}/requirements.txt"
-
-    - name: compile messages
-      command: "{{ gitdir.path }}/.venv/bin/python3 manage.py compilemessages"
-      args:
-        chdir: "{{ tempdir.path }}/paperless-ng/src/"
-
-    - name: collect static files
-      command: "{{ gitdir.path }}/.venv/bin/python3 manage.py collectstatic --no-input"
-      args:
-        chdir: "{{ tempdir.path }}/paperless-ng/src/"
-
-    - name: remove pycache directories
-      shell: find . -name __pycache__ | xargs rm -r
-      args:
-        chdir: "{{ tempdir.path }}"
-
-    - name: remove temporary git directory
-      file:
-        path: "{{ gitdir.path }}"
-        state: absent
-
-  become: yes
-  become_user: "{{ paperlessng_system_user }}"

ansible/tasks/main.yml

@@ -1,553 +0,0 @@
----
-- name: verify operating system
-  fail:
-    msg: Sorry, only Debian and Ubuntu supported at the moment.
-  when: not(ansible_distribution == 'Debian' or ansible_distribution == 'Ubuntu')
-
-- name: install base dependencies
-  apt:
-    update_cache: yes
-    pkg:
-      # paperless-ng
-      - python3-pip
-      - python3-dev
-      - fonts-liberation
-      - imagemagick
-      - optipng
-      - gnupg
-      - libpq-dev
-      - libmagic-dev
-      - mime-support
-      # OCRmyPDF
-      - unpaper
-      - ghostscript
-      - icc-profiles-free
-      - qpdf
-      - liblept5
-      - libxml2
-      - pngquant
-      - zlib1g
-      - tesseract-ocr
-      # dev
-      - sudo
-      - build-essential
-      - python3-setuptools
-      - python3-wheel
-
-# upstream virtualenv in Ubuntu 20.04 is broken
-# https://github.com/pypa/virtualenv/issues/1873
-- name: install python virtualenv
-  pip:
-    name: virtualenv
-    extra_args: --upgrade
-
-- name: install ocr languages
-  apt:
-    pkg: "{{ paperlessng_ocr_languages | map('regex_replace', '^(.*)$', 'tesseract-ocr-\\1') | map('replace', '_', '-') | list }}"
-
-- name: set up notesalexp repository key (for jbig2enc)
-  apt_key:
-    url: https://notesalexp.org/debian/alexp_key.asc
-    state: present
-  when: paperlessng_use_jbig2enc
-
-- name: set up notesalexp repository (for jbig2enc)
-  apt_repository:
-    repo: "deb https://notesalexp.org/debian/{{ ansible_distribution_release }}/ {{ ansible_distribution_release }} main"
-    state: present
-  when: paperlessng_use_jbig2enc
-
-- name: set up notesalexp repository pinning
-  copy:
-    content: |
-      Package: *
-      Pin: release o=notesalexp.org
-      Pin-Priority: 1
-
-      Package: jbig2enc
-      Pin: release o=notesalexp.org
-      Pin-Priority: 500
-    dest: /etc/apt/preferences.d/notesalexp
-  when: paperlessng_use_jbig2enc
-
-- name: install jbig2enc
-  apt:
-    pkg: jbig2enc
-    update_cache: yes
-  when: paperlessng_use_jbig2enc
-
-- name: install redis
-  apt:
-    pkg: redis-server
-  when: paperlessng_redis_host == 'localhost' or paperlessng_redis_host == '127.0.0.1'
-
-- name: enable redis
-  systemd:
-    name: redis-server
-    enabled: yes
-    masked: no
-    state: started
-  when: paperlessng_redis_host == 'localhost' or paperlessng_redis_host == '127.0.0.1'
-
-- name: create paperless system group
-  group:
-    name: "{{ paperlessng_system_group }}"
-
-- name: create paperless system user
-  user:
-    name: "{{ paperlessng_system_user }}"
-    groups:
-      - "{{ paperlessng_system_group }}"
-    shell: /usr/sbin/nologin
-    # GNUPG_HOME required due to paperless db.py
-    create_home: yes
-
-- block:
-    - name: get latest release version
-      uri:
-        url: https://api.github.com/repos/jonaswinkler/paperless-ng/releases/latest
-        method: GET
-      register: latest_release
-    - name: parse latest release version
-      set_fact:
-        paperlessng_version: "{{ latest_release.json['tag_name'] }}"
-  when: paperlessng_version == "latest"
-
-- name: check if version is ref
-  fail:
-    msg: "Specifying `paperlessng_version` as git ref may not work as expected!"
-  ignore_errors: True  # Output failure (as warning), but don't consider play failed
-  when: paperlessng_version.startswith('refs/')
-
-- block:
-    - name: sanitize version string
-      set_fact:
-        paperlessng_version: "{{ paperlessng_version | regex_replace('^ng-(\\d+\\.\\d+\\.\\d+)$', '\\1') }}"
-    - name: get tag data
-      uri:
-        url: https://api.github.com/repos/jonaswinkler/paperless-ng/tags
-        method: GET
-      register: tags
-    - name: get commit for target tag
-      set_fact:
-        paperlessng_commit: "{{ tags.json | json_query('[?name==`ng-' + paperlessng_version +'`] | [0].commit.sha') }}"
-  when: paperlessng_version | regex_search("^(ng-)?(\d+\.\d+\.\d+)$")
-
-- block:
-    - name: check if version is branch
-      uri:
-        url: "https://api.github.com/repos/jonaswinkler/paperless-ng/branches/{{ paperlessng_version }}"
-        method: GET
-        status_code: [200, 404]
-      register: branch
-    - name: get commit for target branch
-      set_fact:
-        paperlessng_commit: "{{ branch.json | json_query('commit.sha') }}"
-      when: branch.status == 200
-    - block:
-        - name: check if version is commit-or-ref
-          uri:
-            url: "https://api.github.com/repos/jonaswinkler/paperless-ng/commits/{{ paperlessng_version }}"
-            method: GET
-            status_code: [200, 404, 422]
-          register: commit
-        - name: get commit for target commit-or-ref
-          set_fact:
-            paperlessng_commit: "{{ commit.json | json_query('sha') }}"
-          when: commit.status == 200
-        - name: fail
-          fail:
-            msg: "Can not determine commit from `paperlessng_version=={{ paperlessng_version }}`!"
-          when: commit.status != 200
-      when: branch.status == 404
-  when: not(paperlessng_version | regex_search("^(ng-)?(\d+\.\d+\.\d+)$"))
-
-- name: check for paperless-ng installation
-  command:
-    cmd: "cat {{ paperlessng_directory }}/.installed_version"
-  changed_when: '"No such file or directory" in paperlessng_current_commit.stderr or paperlessng_current_commit.stdout != paperlessng_commit | string'
-  failed_when: false
-  ignore_errors: yes
-  register: paperlessng_current_commit
-
-- name: register current state
-  set_fact:
-    fresh_installation: '{{ "No such file or directory" in paperlessng_current_commit.stderr }}'
-    update_installation: '{{ "No such file or directory" not in paperlessng_current_commit.stderr and paperlessng_current_commit.stdout != paperlessng_commit | string }}'
-    reconfigure_only: "{{ paperlessng_current_commit.stdout == paperlessng_commit | string }}"
-
-- block:
-    - name: backup current paperless-ng installation
-      copy:
-        src: "{{ paperlessng_directory }}"
-        remote_src: yes
-        dest: "{{ paperlessng_directory }}-{{ ansible_date_time.iso8601 }}/"
-    - name: remove current paperless sources
-      file:
-        path: "{{ paperlessng_directory }}/{{ item }}"
-        state: absent
-      with_items:
-        - docker
-        - docs
-        - scripts
-        - src
-        - static
-  when: update_installation
-
-- block:
-    - name: create paperless-ng directory and set permissions
-      file:
-        path: "{{ paperlessng_directory }}"
-        state: directory
-        owner: "{{ paperlessng_system_user }}"
-        group: "{{ paperlessng_system_group }}"
-        mode: "750"
-    - name: create temporary directory
-      become: yes
-      become_user: "{{ paperlessng_system_user }}"
-      tempfile:
-        state: directory
-        path: "{{ paperlessng_directory }}"
-      register: tempdir
-    - name: check if version is available as release archive
-      uri:
-        url: "https://github.com/jonaswinkler/paperless-ng/releases/download/ng-{{ paperlessng_version }}/paperless-ng-{{ paperlessng_version }}.tar.xz"
-        method: GET
-        status_code: [200, 404]
-      register: release_archive
-    - name: install paperless-ng from source
-      include_tasks: install-source.yml
-      when: release_archive.status == 404
-    - name: install paperless-ng from release archive
-      include_tasks: install-release.yml
-      when: release_archive.status == 200
-    - name: change owner and permissions of paperless-ng
-      command:
-        cmd: "{{ item }}"
-        warn: false
-      with_items:
-        - "chown -R {{ paperlessng_system_user }}:{{ paperlessng_system_group }} {{ tempdir.path }}"
-        - "find {{ tempdir.path }} -type d -exec chmod 0750 {} ;"
-        - "find {{ tempdir.path }} -type f -exec chmod 0640 {} ;"
-    - name: move paperless-ng
-      command:
-        cmd: "cp -a {{ tempdir.path }}/paperless-ng/. {{ paperlessng_directory }}"
-    - name: store commit hash of installed version
-      copy:
-        content: "{{ paperlessng_commit }}"
-        dest: "{{ paperlessng_directory }}/.installed_version"
-        owner: "{{ paperlessng_system_user }}"
-        group: "{{ paperlessng_system_group }}"
-        mode: "0440"
-    - name: remove temporary directory
-      file:
-        path: "{{ tempdir.path }}"
-        state: absent
-  when: not reconfigure_only
-
-- name: create paperless-ng directories and set permissions
-  file:
-    path: "{{ item }}"
-    state: directory
-    owner: "{{ paperlessng_system_user }}"
-    group: "{{ paperlessng_system_group }}"
-    mode: "750"
-  with_items:
-    - "{{ paperlessng_consumption_dir }}"
-    - "{{ paperlessng_data_dir }}"
-    - "{{ paperlessng_media_root }}"
-    - "{{ paperlessng_staticdir }}"
-
-- name: rename initial config
-  command:
-    cmd: "mv -f {{ paperlessng_directory }}/paperless.conf {{ paperlessng_directory }}/paperless.conf.template"
-    removes: "{{ paperlessng_directory }}/paperless.conf"
-
-- name: configure paperless-ng
-  lineinfile:
-    path: "{{ paperlessng_directory }}/paperless.conf.template"
-    regexp: "^#?{{ item.regexp }}="
-    line: "{{ item.line }}"
-  with_items:
-    # Required services
-    - regexp: PAPERLESS_REDIS
-      line: "PAPERLESS_REDIS=redis://{{ paperlessng_redis_host }}:{{ paperlessng_redis_port }}"
-    # Paths and folders
-    - regexp: PAPERLESS_CONSUMPTION_DIR
-      line: "PAPERLESS_CONSUMPTION_DIR={{ paperlessng_consumption_dir }}"
-    - regexp: PAPERLESS_DATA_DIR
-      line: "PAPERLESS_DATA_DIR={{ paperlessng_data_dir }}"
-    - regexp: PAPERLESS_MEDIA_ROOT
-      line: "PAPERLESS_MEDIA_ROOT={{ paperlessng_media_root }}"
-    - regexp: PAPERLESS_STATICDIR
-      line: "PAPERLESS_STATICDIR={{ paperlessng_staticdir }}"
-    - regexp: PAPERLESS_FILENAME_FORMAT
-      line: "PAPERLESS_FILENAME_FORMAT={{ paperlessng_filename_format }}"
-    - regexp: PAPERLESS_LOGGING_DIR
-      line: "PAPERLESS_LOGGING_DIR={{ paperlessng_logging_dir }}"
-    # Hosting & Security
-    - regexp: PAPERLESS_SECRET_KEY
-      line: "PAPERLESS_SECRET_KEY={{ paperlessng_secret_key }}"
-    - regexp: PAPERLESS_ALLOWED_HOSTS
-      line: "PAPERLESS_ALLOWED_HOSTS={{ paperlessng_allowed_hosts }}"
-    - regexp: PAPERLESS_CORS_ALLOWED_HOSTS
-      line: "PAPERLESS_CORS_ALLOWED_HOSTS={{ paperlessng_cors_allowed_hosts }}"
-    - regexp: PAPERLESS_FORCE_SCRIPT_NAME
-      line: "PAPERLESS_FORCE_SCRIPT_NAME={{ paperlessng_force_script_name }}"
-    - regexp: PAPERLESS_STATIC_URL
-      line: "PAPERLESS_STATIC_URL={{ paperlessng_static_url }}"
-    - regexp: PAPERLESS_AUTO_LOGIN_USERNAME
-      line: "PAPERLESS_AUTO_LOGIN_USERNAME={{ paperlessng_auto_login_username }}"
-    - regexp: PAPERLESS_COOKIE_PREFIX
-      line: "PAPERLESS_COOKIE_PREFIX={{ paperlessng_cookie_prefix }}"
-    - regexp: PAPERLESS_ENABLE_HTTP_REMOTE_USER
-      line: "PAPERLESS_ENABLE_HTTP_REMOTE_USER={{ paperlessng_enable_http_remote_user }}"
-    # OCR settings
-    - regexp: PAPERLESS_OCR_LANGUAGE
-      line: "PAPERLESS_OCR_LANGUAGE={{ paperlessng_ocr_languages | join('+') | replace('-','_') }}"
-    - regexp: PAPERLESS_OCR_MODE
-      line: "PAPERLESS_OCR_MODE={{ paperlessng_ocr_mode }}"
-    - regexp: PAPERLESS_OCR_CLEAN
-      line: "PAPERLESS_OCR_CLEAN={{ paperlessng_ocr_clean }}"
-    - regexp: PAPERLESS_OCR_DESKEW
-      line: "PAPERLESS_OCR_DESKEW={{ paperlessng_ocr_deskew }}"
-    - regexp: PAPERLESS_OCR_ROTATE_PAGES
-      line: "PAPERLESS_OCR_ROTATE_PAGES={{ paperlessng_ocr_rotate_pages }}"
-    - regexp: PAPERLESS_OCR_ROTATE_PAGES_THRESHOLD
-      line: "PAPERLESS_OCR_ROTATE_PAGES_THRESHOLD={{ paperlessng_ocr_rotate_pages_threshold }}"
-    - regexp: PAPERLESS_OCR_OUTPUT_TYPE
-      line: "PAPERLESS_OCR_OUTPUT_TYPE={{ paperlessng_ocr_output_type }}"
-    - regexp: PAPERLESS_OCR_PAGES
-      line: "PAPERLESS_OCR_PAGES={{ paperlessng_ocr_pages }}"
-    - regexp: PAPERLESS_OCR_IMAGE_DPI
-      line: "PAPERLESS_OCR_IMAGE_DPI={{ paperlessng_ocr_image_dpi }}"
-    - regexp: PAPERLESS_OCR_USER_ARGS
-      line: "PAPERLESS_OCR_USER_ARGS={{ paperlessng_ocr_user_args | combine({'jbig2_lossy': true} if paperlessng_big2enc_lossy else {}) | to_json }}"
-    # Tika settings
-    - regexp: PAPERLESS_TIKA_ENABLED
-      line: "PAPERLESS_TIKA_ENABLED={{ paperlessng_tika_enabled }}"
-    - regexp: PAPERLESS_TIKA_ENDPOINT
-      line: "PAPERLESS_TIKA_ENDPOINT={{ paperlessng_tika_endpoint }}"
-    - regexp: PAPERLESS_TIKA_GOTENBERG_ENDPOINT
-      line: "PAPERLESS_TIKA_GOTENBERG_ENDPOINT={{ paperlessng_tika_endpoint }}"
-    # Software tweaks
-    - regexp: PAPERLESS_TIME_ZONE
-      line: "PAPERLESS_TIME_ZONE={{ paperlessng_time_zone }}"
-    - regexp: PAPERLESS_CONSUMER_POLLING
-      line: "PAPERLESS_CONSUMER_POLLING={{ paperlessng_consumer_polling }}"
-    - regexp: PAPERLESS_CONSUMER_DELETE_DUPLICATES
-      line: "PAPERLESS_CONSUMER_DELETE_DUPLICATES={{ paperlessng_consumer_delete_duplicates }}"
-    - regexp: PAPERLESS_CONSUMER_RECURSIVE
-      line: "PAPERLESS_CONSUMER_RECURSIVE={{ paperlessng_consumer_recursive }}"
-    - regexp: PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS
-      line: "PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS={{ paperlessng_consumer_subdirs_as_tags }}"
-    - regexp: PAPERLESS_CONVERT_MEMORY_LIMIT
-      line: "PAPERLESS_CONVERT_MEMORY_LIMIT={{ paperlessng_convert_memory_limit }}"
-    - regexp: PAPERLESS_CONVERT_TMPDIR
-      line: "PAPERLESS_CONVERT_TMPDIR={{ paperlessng_convert_tmpdir }}"
-    - regexp: PAPERLESS_OPTIMIZE_THUMBNAILS
-      line: "PAPERLESS_OPTIMIZE_THUMBNAILS={{ paperlessng_optimize_thumbnails }}"
-    - regexp: PAPERLESS_POST_CONSUME_SCRIPT
-      line: "PAPERLESS_POST_CONSUME_SCRIPT={{ paperlessng_post_consume_script }}"
-    - regexp: PAPERLESS_FILENAME_DATE_ORDER
-      line: "PAPERLESS_FILENAME_DATE_ORDER={{ paperlessng_filename_date_order }}"
-    - regexp: PAPERLESS_THUMBNAIL_FONT_NAME
-      line: "PAPERLESS_THUMBNAIL_FONT_NAME={{ paperlessng_thumbnail_font_name }}"
-    - regexp: PAPERLESS_IGNORE_DATES
-      line: "PAPERLESS_IGNORE_DATES={{ paperlessng_ignore_dates }}"
-  no_log: yes
-
-- name: configure paperless-ng database [sqlite]
-  lineinfile:
-    path: "{{ paperlessng_directory }}/paperless.conf.template"
-    regexp: "^#?PAPERLESS_DBHOST=(.*)$"
-    line: '#PAPERLESS_DBHOST=\1'
-    backrefs: yes
-  when: paperlessng_db_type == 'sqlite'
-
-- name: configure paperless-ng database [postgresql]
-  lineinfile:
-    path: "{{ paperlessng_directory }}/paperless.conf.template"
-    regexp: "^#?{{ item.regexp }}="
-    line: "{{ item.line }}"
-  with_items:
-    - regexp: PAPERLESS_DBHOST
-      line: "PAPERLESS_DBHOST={{ paperlessng_db_host }}"
-    - regexp: PAPERLESS_DBPORT
-      line: "PAPERLESS_DBPORT={{ paperlessng_db_port }}"
-    - regexp: PAPERLESS_DBNAME
-      line: "PAPERLESS_DBNAME={{ paperlessng_db_name }}"
-    - regexp: PAPERLESS_DBUSER
-      line: "PAPERLESS_DBUSER={{ paperlessng_db_user }}"
-    - regexp: PAPERLESS_DBPASS
-      line: "PAPERLESS_DBPASS={{ paperlessng_db_pass }}"
-    - regexp: PAPERLESS_DBSSLMODE
-      line: "PAPERLESS_DBSSLMODE={{ paperlessng_db_sslmode }}"
-  when: paperlessng_db_type == 'postgresql'
-  no_log: yes
-
-- name: deploy paperless-ng configuration
-  copy:
-    src: "{{ paperlessng_directory }}/paperless.conf.template"
-    remote_src: yes
-    dest: /etc/paperless.conf
-    owner: root
-    group: root
-    mode: "0644"
-  register: configuration
-
-- name: create paperlessng venv
-  become: yes
-  become_user: "{{ paperlessng_system_user }}"
-  command:
-    cmd: "python3 -m virtualenv {{ paperlessng_virtualenv }} -p /usr/bin/python3"
-    creates: "{{ paperlessng_virtualenv }}"
-  register: venv
-
-- block:
-    - name: install paperlessng requirements
-      become: yes
-      become_user: "{{ paperlessng_system_user }}"
-      pip:
-        requirements: "{{ paperlessng_directory }}/requirements.txt"
-        executable: "{{ paperlessng_virtualenv }}/bin/pip3"
-        extra_args: --upgrade
-    - name: migrate database schema
-      become: yes
-      become_user: "{{ paperlessng_system_user }}"
-      command: "{{ paperlessng_virtualenv }}/bin/python3 {{ paperlessng_directory }}/src/manage.py migrate"
-      register: database_schema
-      changed_when: '"No migrations to apply." not in database_schema.stdout'
-  when: not reconfigure_only
-
-- name: configure paperless superuser
-  become: yes
-  become_user: "{{ paperlessng_system_user }}"
-  # "manage.py createsuperuser" only works on interactive TTYs
-  vars:
-    creation_script: |
-      from django.contrib.auth.models import User
-      from django.contrib.auth.hashers import get_hasher
-
-      if User.objects.filter(username='{{ paperlessng_superuser_name }}').exists():
-          user = User.objects.get(username='{{ paperlessng_superuser_name }}')
-          old = user.__dict__.copy()
-
-          user.is_superuser = True
-          user.email = '{{ paperlessng_superuser_email }}'
-          user.set_password('{{ paperlessng_superuser_password }}')
-          user.save()
-          new = user.__dict__
-
-          algorithm, iterations, old_salt, old_hash = old['password'].split('$')
-          new_password_old_salt = get_hasher(algorithm).encode(password='{{ paperlessng_superuser_password }}', salt=old_salt, iterations=int(iterations))
-          _, _, _, new_hash = new_password_old_salt.split('$')
-          if not (old_hash == new_hash and old['is_superuser'] == new['is_superuser'] and old['email'] == new['email']):
-              print('changed')
-      else:
-          User.objects.create_superuser('{{ paperlessng_superuser_name }}', '{{ paperlessng_superuser_email }}', '{{ paperlessng_superuser_password }}')
-          print('changed')
-  command: '{{ paperlessng_virtualenv }}/bin/python3 {{ paperlessng_directory }}/src/manage.py shell -c "{{ creation_script }}"'
-  register: superuser
-  changed_when: superuser.stdout == 'changed'
-  no_log: yes
-
-- name: set ownership and permissions on paperlessng venv
-  file:
-    path: "{{ paperlessng_virtualenv }}"
-    state: directory
-    recurse: yes
-    owner: "{{ paperlessng_system_user }}"
-    group: "{{ paperlessng_system_group }}"
-    mode: g-w,o-rwx
-  when: venv.changed or not reconfigure_only
-
-- name: configure ghostscript for PDF
-  lineinfile:
-    path: /etc/ImageMagick-6/policy.xml
-    regexp: '(\s+)<policy domain="coder" rights=".*" pattern="PDF" />'
-    line: '\1<policy domain="coder" rights="read|write" pattern="PDF" />'
-    backrefs: yes
-
-- name: configure gunicorn web server
-  lineinfile:
-    path: "{{ paperlessng_directory }}/gunicorn.conf.py"
-    regexp: '^bind = '
-    line: "bind = '{{ paperlessng_listen_address }}:{{ paperlessng_listen_port }}'"
-
-- name: configure systemd services
-  ini_file:
-    path: "{{ paperlessng_directory }}/scripts/{{ item[0] }}"
-    section: "Service"
-    option: "{{ item[1].option  }}"
-    value: "{{ item[1].value }}"
-  with_nested:
-    - [
-        paperless-consumer.service,
-        paperless-scheduler.service,
-        paperless-webserver.service,
-      ]
-    - [
-        # https://www.freedesktop.org/software/systemd/man/systemd.exec.html
-        { option: "User", value: "{{ paperlessng_system_user }}" },
-        { option: "Group", value: "{{ paperlessng_system_group }}" },
-        { option: "WorkingDirectory", value: "{{ paperlessng_directory }}/src" },
-        { option: "ProtectSystem", value: "full" },
-        { option: "NoNewPrivileges", value: "true" },
-        { option: "PrivateUsers", value: "true" },
-        { option: "PrivateDevices", value: "true" },
-      ]
-
-- name: configure paperless-consumer service
-  ini_file:
-    path: "{{ paperlessng_directory }}/scripts/paperless-consumer.service"
-    section: "Service"
-    option: "ExecStart"
-    value: "{{ paperlessng_virtualenv }}/bin/python3 manage.py document_consumer"
-
-- name: configure paperless-scheduler service
-  ini_file:
-    path: "{{ paperlessng_directory }}/scripts/paperless-scheduler.service"
-    section: "Service"
-    option: "ExecStart"
-    value: "{{ paperlessng_virtualenv }}/bin/python3 manage.py qcluster"
-
-- name: configure paperless-webserver service
-  ini_file:
-    path: "{{ paperlessng_directory }}/scripts/paperless-webserver.service"
-    section: "Service"
-    option: "ExecStart"
-    value: "{{ paperlessng_virtualenv }}/bin/gunicorn -c {{ paperlessng_directory }}/gunicorn.conf.py paperless.asgi:application"
-
-- name: copy systemd services
-  copy:
-    src: "{{ paperlessng_directory }}/scripts/{{ item }}"
-    remote_src: yes
-    dest: "/etc/systemd/system/{{ item }}"
-  with_items:
-    - paperless-consumer.service
-    - paperless-scheduler.service
-    - paperless-webserver.service
-  register: paperless_services
-
-- name: reload systemd daemon
-  systemd:
-    name: "{{ item }}"
-    state: restarted
-    daemon_reload: yes
-  with_items:
-    - paperless-consumer
-    - paperless-scheduler
-    - paperless-webserver
-  when: paperless_services.changed or configuration.changed
-
-- name: enable paperlessng services
-  systemd:
-    name: "{{ item }}"
-    enabled: yes
-    masked: no
-    state: started
-  with_items:
-    - paperless-consumer
-    - paperless-scheduler
-    - paperless-webserver

compile-frontend.sh

@@ -1,7 +0,0 @@
-#!/bin/bash
-
-set -e
-
-cd src-ui
-npm install
-./node_modules/.bin/ng build --prod

crowdin.yml

@@ -1,3 +1,4 @@
+commit_message: '[ci skip]'
 files:
   - source: /src/locale/en_US/LC_MESSAGES/django.po
     translation: /src/locale/%locale_with_underscore%/LC_MESSAGES/django.po

docker/compose/.env

@@ -1 +1 @@
-COMPOSE_PROJECT_NAME=paperless
+COMPOSE_PROJECT_NAME=paperless

docker/compose/docker-compose.portainer.yml

@@ -0,0 +1,97 @@
+# docker-compose file for running paperless from the Docker Hub.
+# This file contains everything paperless needs to run.
+# Paperless supports amd64, arm and arm64 hardware.
+#
+# All compose files of paperless configure paperless in the following way:
+#
+# - Paperless is (re)started on system boot, if it was running before shutdown.
+# - Docker volumes for storing data are managed by Docker.
+# - Folders for importing and exporting files are created in the same directory
+#   as this file and mounted to the correct folders inside the container.
+# - Paperless listens on port 8010.
+#
+# In addition to that, this docker-compose file adds the following optional
+# configurations:
+#
+# - Instead of SQLite (default), PostgreSQL is used as the database server.
+#
+# To install and update paperless with this file, do the following:
+#
+# - Open portainer Stacks list and click 'Add stack'
+# - Paste the contents of this file and assign a name, e.g. 'Paperless'
+# - Click 'Deploy the stack' and wait for it to be deployed
+# - Open the list of containers, select paperless_webserver_1
+# - Click 'Console' and then 'Connect' to open the command line inside the container
+# - Run 'python3 manage.py createsuperuser' to create a user
+# - Exit the console
+#
+# For more extensive installation and update instructions, refer to the
+# documentation.
+
+version: "3.4"
+services:
+  broker:
+    image: redis:6.0
+    restart: unless-stopped
+    volumes:
+      - redisdata:/data
+
+  db:
+    image: postgres:13
+    restart: unless-stopped
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+    environment:
+      POSTGRES_DB: paperless
+      POSTGRES_USER: paperless
+      POSTGRES_PASSWORD: paperless
+
+  webserver:
+    image: ghcr.io/paperless-ngx/paperless-ngx:latest
+    restart: unless-stopped
+    depends_on:
+      - db
+      - broker
+    ports:
+      - 8010:8000
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8000"]
+      interval: 30s
+      timeout: 10s
+      retries: 5
+    volumes:
+      - data:/usr/src/paperless/data
+      - media:/usr/src/paperless/media
+      - ./export:/usr/src/paperless/export
+      - ./consume:/usr/src/paperless/consume
+    environment:
+      PAPERLESS_REDIS: redis://broker:6379
+      PAPERLESS_DBHOST: db
+# The UID and GID of the user used to run paperless in the container. Set this
+# to your UID and GID on the host so that you have write access to the
+# consumption directory.
+      USERMAP_UID: 1000
+      USERMAP_GID: 100
+# Additional languages to install for text recognition, separated by a
+# whitespace. Note that this is
+# different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the
+# language used for OCR.
+# The container installs English, German, Italian, Spanish and French by
+# default.
+# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
+# for available languages.
+      #PAPERLESS_OCR_LANGUAGES: tur ces
+# Adjust this key if you plan to make paperless available publicly. It should
+# be a very long sequence of random characters. You don't need to remember it.
+      #PAPERLESS_SECRET_KEY: change-me
+# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
+      #PAPERLESS_TIME_ZONE: America/Los_Angeles
+# The default language to use for OCR. Set this to the language most of your
+# documents are written in.
+      #PAPERLESS_OCR_LANGUAGE: eng
+
+volumes:
+  data:
+  media:
+  pgdata:
+  redisdata:

docker/compose/docker-compose.postgres-tika.yml

@@ -1,6 +1,7 @@
-# docker-compose file for running paperless from the Docker Hub.
+# docker-compose file for running paperless from the docker container registry.
 # This file contains everything paperless needs to run.
-# Paperless supports amd64, arm and arm64 hardware.
+# Paperless supports amd64, arm and arm64 hardware. The apache/tika image
+# does not support arm or arm64, however.
 #
 # All compose files of paperless configure paperless in the following way:
 #
@@ -35,6 +36,8 @@ services:
   broker:
     image: redis:6.0
     restart: unless-stopped
+    volumes:
+      - redisdata:/data
 
   db:
     image: postgres:13
@@ -47,7 +50,7 @@ services:
       POSTGRES_PASSWORD: paperless
 
   webserver:
-    image: jonaswinkler/paperless-ng:latest
+    image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
     depends_on:
       - db
@@ -75,10 +78,11 @@ services:
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
 
   gotenberg:
-    image: thecodingmachine/gotenberg
+    image: gotenberg/gotenberg:7
     restart: unless-stopped
-    environment:
-      DISABLE_GOOGLE_CHROME: 1
+    command:
+      - "gotenberg"
+      - "--chromium-disable-routes=true"
 
   tika:
     image: apache/tika
@@ -88,3 +92,4 @@ volumes:
   data:
   media:
   pgdata:
+  redisdata:

docker/compose/docker-compose.postgres.yml

@@ -31,6 +31,8 @@ services:
   broker:
     image: redis:6.0
     restart: unless-stopped
+    volumes:
+      - redisdata:/data
 
   db:
     image: postgres:13
@@ -43,7 +45,7 @@ services:
       POSTGRES_PASSWORD: paperless
 
   webserver:
-    image: jonaswinkler/paperless-ng:latest
+    image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
     depends_on:
       - db
@@ -70,3 +72,4 @@ volumes:
   data:
   media:
   pgdata:
+  redisdata:

docker/compose/docker-compose.sqlite-tika.arm.yml

@@ -0,0 +1,84 @@
+# docker-compose file for running paperless from the docker container registry.
+# This file contains everything paperless needs to run.
+# Paperless supports amd64, arm and arm64 hardware.
+#
+# All compose files of paperless configure paperless in the following way:
+#
+# - Paperless is (re)started on system boot, if it was running before shutdown.
+# - Docker volumes for storing data are managed by Docker.
+# - Folders for importing and exporting files are created in the same directory
+#   as this file and mounted to the correct folders inside the container.
+# - Paperless listens on port 8000.
+#
+# SQLite is used as the database. The SQLite file is stored in the data volume.
+#
+# iwishiwasaneagle/apache-tika-arm docker image is used to enable arm64 arch
+# which apache/tika does not currently support.
+#
+# In addition to that, this docker-compose file adds the following optional
+# configurations:
+#
+# - Apache Tika and Gotenberg servers are started with paperless and paperless
+#   is configured to use these services. These provide support for consuming
+#   Office documents (Word, Excel, Power Point and their LibreOffice counter-
+#   parts.
+#
+# To install and update paperless with this file, do the following:
+#
+# - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
+#   and '.env' into a folder.
+# - Run 'docker-compose pull'.
+# - Run 'docker-compose run --rm webserver createsuperuser' to create a user.
+# - Run 'docker-compose up -d'.
+#
+# For more extensive installation and update instructions, refer to the
+# documentation.
+
+version: "3.4"
+services:
+  broker:
+    image: redis:6.0
+    restart: unless-stopped
+    volumes:
+      - redisdata:/data
+
+  webserver:
+    image: ghcr.io/paperless-ngx/paperless-ngx:latest
+    restart: unless-stopped
+    depends_on:
+      - broker
+      - gotenberg
+      - tika
+    ports:
+      - 8000:8000
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8000"]
+      interval: 30s
+      timeout: 10s
+      retries: 5
+    volumes:
+      - data:/usr/src/paperless/data
+      - media:/usr/src/paperless/media
+      - ./export:/usr/src/paperless/export
+      - ./consume:/usr/src/paperless/consume
+    env_file: docker-compose.env
+    environment:
+      PAPERLESS_REDIS: redis://broker:6379
+      PAPERLESS_TIKA_ENABLED: 1
+      PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
+      PAPERLESS_TIKA_ENDPOINT: http://tika:9998
+
+  gotenberg:
+    image: thecodingmachine/gotenberg
+    restart: unless-stopped
+    environment:
+      DISABLE_GOOGLE_CHROME: 1
+
+  tika:
+    image: iwishiwasaneagle/apache-tika-arm@sha256:a78c25ffe57ecb1a194b2859d42a61af46e9e845191512b8f1a4bf90578ffdfd
+    restart: unless-stopped
+
+volumes:
+  data:
+  media:
+  redisdata:

docker/compose/docker-compose.sqlite-tika.yml

@@ -1,6 +1,7 @@
-# docker-compose file for running paperless from the Docker Hub.
+# docker-compose file for running paperless from the docker container registry.
 # This file contains everything paperless needs to run.
-# Paperless supports amd64, arm and arm64 hardware.
+# Paperless supports amd64, arm and arm64 hardware. The apache/tika image
+# does not support arm or arm64, however.
 #
 # All compose files of paperless configure paperless in the following way:
 #
@@ -36,9 +37,11 @@ services:
   broker:
     image: redis:6.0
     restart: unless-stopped
+    volumes:
+      - redisdata:/data
 
   webserver:
-    image: jonaswinkler/paperless-ng:latest
+    image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
     depends_on:
       - broker
@@ -64,10 +67,11 @@ services:
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
 
   gotenberg:
-    image: thecodingmachine/gotenberg
+    image: gotenberg/gotenberg:7
     restart: unless-stopped
-    environment:
-      DISABLE_GOOGLE_CHROME: 1
+    command:
+      - "gotenberg"
+      - "--chromium-disable-routes=true"
 
   tika:
     image: apache/tika
@@ -76,3 +80,4 @@ services:
 volumes:
   data:
   media:
+  redisdata:

docker/compose/docker-compose.sqlite.yml

@@ -28,9 +28,11 @@ services:
   broker:
     image: redis:6.0
     restart: unless-stopped
+    volumes:
+      - redisdata:/data
 
   webserver:
-    image: jonaswinkler/paperless-ng:latest
+    image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
     depends_on:
       - broker
@@ -54,3 +56,4 @@ services:
 volumes:
   data:
   media:
+  redisdata:

docker/docker-entrypoint.sh

@@ -1,92 +1,40 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 set -e
 
 # Source: https://github.com/sameersbn/docker-gitlab/
 map_uidgid() {
-    USERMAP_ORIG_UID=$(id -u paperless)
-    USERMAP_ORIG_GID=$(id -g paperless)
-    USERMAP_NEW_UID=${USERMAP_UID:-$USERMAP_ORIG_UID}
-    USERMAP_NEW_GID=${USERMAP_GID:-${USERMAP_ORIG_GID:-$USERMAP_NEW_UID}}
-    if [[ ${USERMAP_NEW_UID} != "${USERMAP_ORIG_UID}" || ${USERMAP_NEW_GID} != "${USERMAP_ORIG_GID}" ]]; then
-        echo "Mapping UID and GID for paperless:paperless to $USERMAP_NEW_UID:$USERMAP_NEW_GID"
-        usermod -u "${USERMAP_NEW_UID}" paperless
-        groupmod -o -g "${USERMAP_NEW_GID}" paperless
-    fi
-}
-
-
-wait_for_postgres() {
-	attempt_num=1
-	max_attempts=5
-
-	echo "Waiting for PostgreSQL to start..."
-
-	host="${PAPERLESS_DBHOST}"
-	port="${PAPERLESS_DBPORT}"
-
-	if [[ -z $port ]] ;
-	then
-		port="5432"
+	USERMAP_ORIG_UID=$(id -u paperless)
+	USERMAP_ORIG_GID=$(id -g paperless)
+	USERMAP_NEW_UID=${USERMAP_UID:-$USERMAP_ORIG_UID}
+	USERMAP_NEW_GID=${USERMAP_GID:-${USERMAP_ORIG_GID:-$USERMAP_NEW_UID}}
+	if [[ ${USERMAP_NEW_UID} != "${USERMAP_ORIG_UID}" || ${USERMAP_NEW_GID} != "${USERMAP_ORIG_GID}" ]]; then
+		echo "Mapping UID and GID for paperless:paperless to $USERMAP_NEW_UID:$USERMAP_NEW_GID"
+		usermod -o -u "${USERMAP_NEW_UID}" paperless
+		groupmod -o -g "${USERMAP_NEW_GID}" paperless
 	fi
-
-	while !</dev/tcp/$host/$port ;
-	do
-
-		if [ $attempt_num -eq $max_attempts ]
-		then
-			echo "Unable to connect to database."
-			exit 1
-		else
-			echo "Attempt $attempt_num failed! Trying again in 5 seconds..."
-
-		fi
-
-		attempt_num=$(expr "$attempt_num" + 1)
-		sleep 5
-	done
-
-
-}
-
-
-migrations() {
-
-	if [[ -n "${PAPERLESS_DBHOST}" ]]
-	then
-		wait_for_postgres
-	fi
-
-	(
-		# flock is in place to prevent multiple containers from doing migrations
-		# simultaneously. This also ensures that the db is ready when the command
-		# of the current container starts.
-		flock 200
-		echo "Apply database migrations..."
-		sudo -HEu paperless python3 manage.py migrate
-	)  200>/usr/src/paperless/data/migration_lock
-
 }
 
 initialize() {
 	map_uidgid
 
 	for dir in export data data/index media media/documents media/documents/originals media/documents/thumbnails; do
-		if [[ ! -d "../$dir" ]]
-		then
-			echo "creating directory ../$dir"
+		if [[ ! -d "../$dir" ]]; then
+			echo "Creating directory ../$dir"
 			mkdir ../$dir
 		fi
 	done
 
-	echo "creating directory /tmp/paperless"
+	echo "Creating directory /tmp/paperless"
 	mkdir -p /tmp/paperless
 
-	chown -R paperless:paperless ../
+	set +e
+	echo "Adjusting permissions of paperless files. This may take a while."
 	chown -R paperless:paperless /tmp/paperless
+	find .. -not \( -user paperless -and -group paperless \) -exec chown paperless:paperless {} +
+	set -e
 
-	migrations
-
+	gosu paperless /sbin/docker-prepare.sh
 }
 
 install_languages() {
@@ -102,44 +50,43 @@ install_languages() {
 	apt-get update
 
 	for lang in "${langs[@]}"; do
-        pkg="tesseract-ocr-$lang"
-        # English is installed by default
-        #if [[ "$lang" ==  "eng" ]]; then
-        #    continue
-        #fi
+		pkg="tesseract-ocr-$lang"
+		# English is installed by default
+		#if [[ "$lang" ==  "eng" ]]; then
+		#    continue
+		#fi
 
-        if dpkg -s $pkg &> /dev/null; then
-        	echo "package $pkg already installed!"
-        	continue
-        fi
+		if dpkg -s "$pkg" &>/dev/null; then
+			echo "Package $pkg already installed!"
+			continue
+		fi
 
-        if ! apt-cache show $pkg &> /dev/null; then
-        	echo "package $pkg not found! :("
-        	continue
-        fi
+		if ! apt-cache show "$pkg" &>/dev/null; then
+			echo "Package $pkg not found! :("
+			continue
+		fi
 
-				echo "Installing package $pkg..."
-				if ! apt-get -y install "$pkg" &> /dev/null; then
-					echo "Could not install $pkg"
-					exit 1
-				fi
-    done
+		echo "Installing package $pkg..."
+		if ! apt-get -y install "$pkg" &>/dev/null; then
+			echo "Could not install $pkg"
+			exit 1
+		fi
+	done
 }
 
-echo "Paperless-ng docker container starting..."
+echo "Paperless-ngx docker container starting..."
 
 # Install additional languages if specified
-if [[ ! -z "$PAPERLESS_OCR_LANGUAGES"  ]]; then
-		install_languages "$PAPERLESS_OCR_LANGUAGES"
+if [[ -n "$PAPERLESS_OCR_LANGUAGES" ]]; then
+	install_languages "$PAPERLESS_OCR_LANGUAGES"
 fi
 
 initialize
 
 if [[ "$1" != "/"* ]]; then
 	echo Executing management command "$@"
-	exec sudo -HEu paperless python3 manage.py "$@"
+	exec gosu paperless python3 manage.py "$@"
 else
 	echo Executing "$@"
 	exec "$@"
 fi
-

docker/docker-prepare.sh

@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+
+wait_for_postgres() {
+	attempt_num=1
+	max_attempts=5
+
+	echo "Waiting for PostgreSQL to start..."
+
+	host="${PAPERLESS_DBHOST:=localhost}"
+	port="${PAPERLESS_DBPORT:=5342}"
+
+
+	while [ ! "$(pg_isready -h $host -p $port)" ]; do
+
+		if [ $attempt_num -eq $max_attempts ]; then
+			echo "Unable to connect to database."
+			exit 1
+		else
+			echo "Attempt $attempt_num failed! Trying again in 5 seconds..."
+
+		fi
+
+		attempt_num=$(("$attempt_num" + 1))
+		sleep 5
+	done
+}
+
+migrations() {
+	(
+		# flock is in place to prevent multiple containers from doing migrations
+		# simultaneously. This also ensures that the db is ready when the command
+		# of the current container starts.
+		flock 200
+		echo "Apply database migrations..."
+		python3 manage.py migrate
+	) 200>/usr/src/paperless/data/migration_lock
+}
+
+search_index() {
+	index_version=1
+	index_version_file=/usr/src/paperless/data/.index_version
+
+	if [[ (! -f "$index_version_file") || $(<$index_version_file) != "$index_version" ]]; then
+		echo "Search index out of date. Updating..."
+		python3 manage.py document_index reindex
+		echo $index_version | tee $index_version_file >/dev/null
+	fi
+}
+
+superuser() {
+	if [[ -n "${PAPERLESS_ADMIN_USER}" ]]; then
+		python3 manage.py manage_superuser
+	fi
+}
+
+do_work() {
+	if [[ -n "${PAPERLESS_DBHOST}" ]]; then
+		wait_for_postgres
+	fi
+
+	migrations
+
+	search_index
+
+	superuser
+
+}
+
+do_work

docker/install_management_commands.sh

@@ -1,4 +1,6 @@
-for command in document_archiver document_exporter document_importer mail_fetcher document_create_classifier document_index document_renamer document_retagger document_thumbnails document_sanity_checker;
+#!/usr/bin/env bash
+
+for command in document_archiver document_exporter document_importer mail_fetcher document_create_classifier document_index document_renamer document_retagger document_thumbnails document_sanity_checker manage_superuser;
 do
 	echo "installing $command..."
 	sed "s/management_command/$command/g" management_script.sh > /usr/local/bin/$command

docker/management_script.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 set -e
 
@@ -6,10 +6,10 @@ cd /usr/src/paperless/src/
 
 if [[ $(id -u) == 0 ]] ;
 then
-  sudo -HEu paperless python3 manage.py management_command "$@"
+	gosu paperless python3 manage.py management_command "$@"
 elif [[ $(id -un) == "paperless" ]] ;
 then
-  python3 manage.py management_command "$@"
+	python3 manage.py management_command "$@"
 else
-  echo "Unknown user."
+	echo "Unknown user."
 fi

docs/Dockerfile

@@ -1,5 +1,4 @@
 FROM python:3.5.1
-MAINTAINER Pit Kleyersburg <pitkley@googlemail.com>
 
 # Install Sphinx and Pygments
 RUN pip install Sphinx Pygments

docs/administration.rst

@@ -64,9 +64,9 @@ Updating Paperless
 Docker Route
 ============
 
-If a new release of paperless-ng is available, upgrading depends on how you
-installed paperless-ng in the first place. The releases are available at the
-`release page <https://github.com/jonaswinkler/paperless-ng/releases>`_.
+If a new release of paperless-ngx is available, upgrading depends on how you
+installed paperless-ngx in the first place. The releases are available at the
+`release page <https://github.com/paperless-ngx/paperless-ngx/releases>`_.
 
 First of all, ensure that paperless is stopped.
 
@@ -92,31 +92,30 @@ B.  If you built the image yourself, do the following:
     .. code:: shell-session
 
         $ git pull
-        $ ./compile-frontend.sh
         $ docker-compose build
         $ docker-compose up
 
 Running ``docker-compose up`` will also apply any new database migrations.
 If you see everything working, press CTRL+C once to gracefully stop paperless.
-Then you can start paperless-ng with ``-d`` to have it run in the background.
+Then you can start paperless-ngx with ``-d`` to have it run in the background.
 
     .. note::
 
         In version 0.9.14, the update process was changed. In 0.9.13 and earlier, the
         docker-compose files specified exact versions and pull won't automatically
         update to newer versions. In order to enable updates as described above, either
-        get the new ``docker-compose.yml`` file from `here <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`_
+        get the new ``docker-compose.yml`` file from `here <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`_
         or edit the ``docker-compose.yml`` file, find the line that says
 
             .. code::
 
-                image: jonaswinkler/paperless-ng:0.9.x
+                image: ghcr.io/paperless-ngx/paperless-ngx:0.9.x
 
         and replace the version with ``latest``:
 
             .. code::
 
-                image: jonaswinkler/paperless-ng:latest
+                image: ghcr.io/paperless-ngx/paperless-ngx:latest
 
 Bare Metal Route
 ================
@@ -144,39 +143,6 @@ After grabbing the new release and unpacking the contents, do the following:
     This might not actually do anything. Not every new paperless version comes with new
     database migrations.
 
-Ansible Route
-=============
-
-Most of the update process is automated when using the ansible role.
-
-1.  Backup your defined role variables file outside the paperless source-tree:
-
-    .. code:: shell-session
-
-        $ cp ansible/vars.yml ~/vars.yml.old
-
-2.  Pull the release tag you want to update to:
-
-    .. code:: shell-session
-
-        $ git fetch --all
-        $ git checkout ng-0.9.14
-
-3.  Update the role variable definitions ``ansible/vars.yml`` (where appropriate).
-
-4.  Run the ansible playbook you created created during :ref:`installation <setup-ansible>` again:
-
-    .. note::
-
-        When ansible detects that an update run is in progress, it backs up the entire ``paperlessng_directory`` to ``paperlessng_directory-TIMESTAMP``.
-        Updates can be rolled back by simply moving the timestamped folder back to the original location.
-        If the update succeeds and you want to continue using the new release, please don't forget to delete the backup folder.
-
-    .. code:: shell-session
-
-        $ ansible-playbook playbook.yml
-
-
 Downgrading Paperless
 #####################
 
@@ -184,17 +150,19 @@ Downgrades are possible. However, some updates also contain database migrations
 In order to move back from a version that applied database migrations, you'll have to revert the database migration *before* downgrading,
 and then downgrade paperless.
 
-This table lists the most recent database migrations for each versions:
+This table lists the compatible versions for each database migration number.
 
-+---------+-------------------------+
-| Version | Latest migration number |
-+---------+-------------------------+
-| 1.0.0   | 1011                    |
-+---------+-------------------------+
-| 1.1.0   | 1011                    |
-+---------+-------------------------+
-| 1.1.1   | 1012                    |
-+---------+-------------------------+
++------------------+-----------------+
+| Migration number | Version range   |
++------------------+-----------------+
+| 1011             | 1.0.0           |
++------------------+-----------------+
+| 1012             | 1.1.0 - 1.2.1   |
++------------------+-----------------+
+| 1014             | 1.3.0 - 1.3.1   |
++------------------+-----------------+
+| 1016             | 1.3.2 - current |
++------------------+-----------------+
 
 Execute the following management command to migrate your database:
 
@@ -245,6 +213,8 @@ Document exporter
 The document exporter exports all your data from paperless into a folder for
 backup or migration to another DMS.
 
+If you use the document exporter within a cronjob to backup your data you might use the ``-T`` flag behind exec to suppress "The input device is not a TTY" errors. For example: ``docker-compose exec -T webserver document_exporter ../export``
+
 .. code::
 
     document_exporter target [-c] [-f] [-d]
@@ -409,6 +379,8 @@ the naming scheme.
 
 The command takes no arguments and processes all your documents at once.
 
+Learn how to use :ref:`Management Utilities<utilities-management-commands>`.
+
 
 .. _utilities-sanity-checker:
 
@@ -496,7 +468,7 @@ Documents can be stored in Paperless using GnuPG encryption.
 
 .. danger::
 
-    Encryption is deprecated since paperless-ng 0.9 and doesn't really provide any
+    Encryption is deprecated since paperless-ngx 0.9 and doesn't really provide any
     additional security, since you have to store the passphrase in a configuration
     file on the same system as the encrypted documents for paperless to work.
     Furthermore, the entire text content of the documents is stored plain in the

docs/advanced_usage.rst

@@ -10,22 +10,21 @@ easier.
 Matching tags, correspondents and document types
 ################################################
 
-After the consumer has tried to figure out what it could from the file name,
-it starts looking at the content of the document itself.  It will compare the
-matching algorithms defined by every tag and correspondent already set in your
-database to see if they apply to the text in that document.  In other words,
-if you defined a tag called ``Home Utility`` that had a ``match`` property of
-``bc hydro`` and a ``matching_algorithm`` of ``literal``, Paperless will
-automatically tag your newly-consumed document with your ``Home Utility`` tag
-so long as the text ``bc hydro`` appears in the body of the document somewhere.
+Paperless will compare the matching algorithms defined by every tag and
+correspondent already set in your database to see if they apply to the text in
+a document.  In other words, if you defined a tag called ``Home Utility``
+that had a ``match`` property of ``bc hydro`` and a ``matching_algorithm`` of
+``literal``, Paperless will automatically tag your newly-consumed document with
+your ``Home Utility`` tag so long as the text ``bc hydro`` appears in the body
+of the document somewhere.
 
-The matching logic is quite powerful, and supports searching the text of your
+The matching logic is quite powerful. It supports searching the text of your
 document with different algorithms, and as such, some experimentation may be
 necessary to get things right.
 
-In order to have a tag, correspondent or type assigned automatically to newly
+In order to have a tag, correspondent, or type assigned automatically to newly
 consumed documents, assign a match and matching algorithm using the web
-interface. These settings define when to assign correspondents, tags and types
+interface. These settings define when to assign correspondents, tags, and types
 to documents.
 
 The following algorithms are available:
@@ -35,16 +34,16 @@ The following algorithms are available:
   either of these terms.
 * **All:** Requires that every word provided appears in the PDF, albeit not in the
   order provided.
-* **Literal:** Matches only if the match appears exactly as provided in the PDF.
+* **Literal:** Matches only if the match appears exactly as provided (i.e. preserve ordering) in the PDF.
 * **Regular expression:** Parses the match as a regular expression and tries to
   find a match within the document.
 * **Fuzzy match:** I dont know. Look at the source.
 * **Auto:** Tries to automatically match new documents. This does not require you
   to set a match. See the notes below.
 
-When using the "any" or "all" matching algorithms, you can search for terms
+When using the *any* or *all* matching algorithms, you can search for terms
 that consist of multiple words by enclosing them in double quotes. For example,
-defining a match text of ``"Bank of America" BofA`` using the "any" algorithm,
+defining a match text of ``"Bank of America" BofA`` using the *any* algorithm,
 will match documents that contain either "Bank of America" or "BofA", but will
 not match documents containing "Bank of South America".
 
@@ -58,9 +57,9 @@ automatically tagged with the appropriate data.
 Automatic matching
 ==================
 
-Paperless-ng comes with a new matching algorithm called *Auto*. This matching
-algorithm tries to assign tags, correspondents and document types to your
-documents based on how you have assigned these on existing documents. It
+Paperless-ngx comes with a new matching algorithm called *Auto*. This matching
+algorithm tries to assign tags, correspondents, and document types to your
+documents based on how you have already assigned these on existing documents. It
 uses a neural network under the hood.
 
 If, for example, all your bank statements of your account 123 at the Bank of
@@ -77,11 +76,11 @@ feature:
   changes. Paperless periodically (default: once each hour) checks for changes
   and does this automatically for you.
 * The Auto matching algorithm only takes documents into account which are NOT
-  placed in your inbox (i.e., have inbox tags assigned to them). This ensures
+  placed in your inbox (i.e. have any inbox tags assigned to them). This ensures
   that the neural network only learns from documents which you have correctly
   tagged before.
 * The matching algorithm can only work if there is a correlation between the
-  tag, correspondent or document type and the document itself. Your bank
+  tag, correspondent, or document type and the document itself. Your bank
   statements usually contain your bank account number and the name of the bank,
   so this works reasonably well, However, tags such as "TODO" cannot be
   automatically assigned.
@@ -105,7 +104,7 @@ you execute scripts of your own choosing just before or after a document is
 consumed using a couple simple hooks.
 
 Just write a script, put it somewhere that Paperless can read & execute, and
-then put the path to that script in ``paperless.conf`` with the variable name
+then put the path to that script in ``paperless.conf`` or ``docker-compose.env`` with the variable name
 of either ``PAPERLESS_PRE_CONSUME_SCRIPT`` or
 ``PAPERLESS_POST_CONSUME_SCRIPT``.
 
@@ -168,12 +167,41 @@ into paperless. It receives the following arguments:
 * Correspondent
 * Tags
 
-The script can be in any language you like, but for a simple shell script
-example, you can take a look at ``post-consumption-example.sh`` in the
-``scripts`` directory in this project.
+The script can be in any language, but for a simple shell script
+example, you can take a look at `post-consumption-example.sh`_ in this project.
 
 The post consumption script cannot cancel the consumption process.
 
+Docker
+------
+Assumed you have ``/home/foo/paperless-ngx/scripts/post-consumption-example.sh``.
+
+You can pass that script into the consumer container via a host mount in your ``docker-compose.yml``.
+
+.. code:: bash
+
+  ...
+  consumer:
+    ...
+    volumes:
+      ...
+      - /home/paperless-ngx/scripts:/path/in/container/scripts/
+  ...
+
+Example (docker-compose.yml): ``- /home/foo/paperless-ngx/scripts:/usr/src/paperless/scripts``
+
+which in turn requires the variable ``PAPERLESS_POST_CONSUME_SCRIPT`` in ``docker-compose.env``  to point to ``/path/in/container/scripts/post-consumption-example.sh``.
+
+Example (docker-compose.env): ``PAPERLESS_POST_CONSUME_SCRIPT=/usr/src/paperless/scripts/post-consumption-example.sh``
+
+Troubleshooting:
+
+- Monitor the docker-compose log ``cd ~/paperless-ngx; docker-compose logs -f``
+- Check your script's permission e.g. in case of permission error ``sudo chmod 755 post-consumption-example.sh``
+- Pipe your scripts's output to a log file e.g. ``echo "${DOCUMENT_ID}" | tee --append /usr/src/paperless/scripts/post-consumption-example.log``
+
+.. _post-consumption-example.sh: https://github.com/jonaswinkler/paperless-ngx/blob/master/scripts/post-consumption-example.sh
+
 .. _advanced-file_name_handling:
 
 File name handling
@@ -222,14 +250,14 @@ Paperless provides the following placeholders withing filenames:
 * ``{document_type}``: The name of the document type, or "none".
 * ``{tag_list}``: A comma separated list of all tags assigned to the document.
 * ``{title}``: The title of the document.
-* ``{created}``: The full date and time the document was created.
+* ``{created}``: The full date (ISO format) the document was created.
 * ``{created_year}``: Year created only.
-* ``{created_month}``: Month created only (number 1-12).
-* ``{created_day}``: Day created only (number 1-31).
-* ``{added}``: The full date and time the document was added to paperless.
+* ``{created_month}``: Month created only (number 01-12).
+* ``{created_day}``: Day created only (number 01-31).
+* ``{added}``: The full date (ISO format) the document was added to paperless.
 * ``{added_year}``: Year added only.
-* ``{added_month}``: Month added only (number 1-12).
-* ``{added_day}``: Day added only (number 1-31).
+* ``{added_month}``: Month added only (number 01-12).
+* ``{added_day}``: Day added only (number 01-31).
 
 
 Paperless will try to conserve the information from your database as much as possible.

docs/api.rst

@@ -60,7 +60,7 @@ The endpoints correctly serve the response header fields ``Content-Disposition``
 and ``Content-Type`` to indicate the filename for download and the type of content of
 the document.
 
-In order to download or preview the original document when an archied document is available,
+In order to download or preview the original document when an archived document is available,
 supply the query parameter ``original=true``.
 
 .. hint::
@@ -147,93 +147,57 @@ The REST api provides three different forms of authentication.
 Searching for documents
 #######################
 
-Paperless-ng offers API endpoints for full text search. These are as follows:
+Full text searching is available on the ``/api/documents/`` endpoint. Two specific
+query parameters cause the API to return full text search results:
 
-``/api/search/``
-================
+*   ``/api/documents/?query=your%20search%20query``: Search for a document using a full text query.
+    For details on the syntax, see :ref:`basic-usage_searching`.
 
-Get search results based on a query.
+*   ``/api/documents/?more_like=1234``: Search for documents similar to the document with id 1234.
 
-Query parameters:
+Pagination works exactly the same as it does for normal requests on this endpoint.
 
-*   ``query``: The query string. See
-    `here <https://whoosh.readthedocs.io/en/latest/querylang.html>`_
-    for details on the syntax.
-*   ``page``: Specify the page you want to retrieve. Each page
-    contains 10 search results and the first page is ``page=1``, which
-    is the default if this is omitted.
+Certain limitations apply to full text queries:
 
-Result list object returned by the endpoint:
+*   Results are always sorted by search score. The results matching the query best will show up first.
 
-.. code:: json
+*   Only a small subset of filtering parameters are supported.
+
+Furthermore, each returned document has an additional ``__search_hit__`` attribute with various information
+about the search results:
+
+.. code::
 
     {
-        "count": 1,
-        "page": 1,
-        "page_count": 1,
-        "corrected_query": "",
+        "count": 31,
+        "next": "http://localhost:8000/api/documents/?page=2&query=test",
+        "previous": null,
         "results": [
 
+            ...
+
+            {
+                "id": 123,
+                "title": "title",
+                "content": "content",
+
+                ...
+
+                "__search_hit__": {
+                    "score": 0.343,
+                    "highlights": "text <span class=\"match\">Test</span> text",
+                    "rank": 23
+                }
+            },
+
+            ...
+
         ]
     }
 
-*   ``count``: The approximate total number of results.
-*   ``page``: The page returned to you. This might be different from
-    the page you requested, if you requested a page that is behind
-    the last page. In that case, the last page is returned.
-*   ``page_count``: The total number of pages.
-*   ``corrected_query``: Corrected version of the query string. Can be null.
-    If not null, can be used verbatim to start a new query.
-*   ``results``: A list of result objects on the current page.
-
-Result object:
-
-.. code:: json
-
-    {
-        "id": 1,
-        "highlights": [
-
-        ],
-        "score": 6.34234,
-        "rank": 23,
-        "document": {
-
-        }
-    }
-
-*   ``id``: the primary key of the found document
-*   ``highlights``: an object containing parsable highlights for the result.
-    See below.
-*   ``score``: The score assigned to the document. A higher score indicates a
-    better match with the query. Search results are sorted descending by score.
-*   ``rank``: the position of the document within the entire search results list.
-*   ``document``: The full json of the document, as returned by
-    ``/api/documents/<id>/``.
-
-Highlights object:
-
-Highlights are provided as a list of fragments. A fragment is a longer section of
-text from the original document.
-Each fragment contains a list of strings, and some of them are marked as a highlight.
-
-.. code:: json
-
-    [
-        [
-            {"text": "This is a sample text with a ", "highlight": false},
-            {"text": "highlighted", "highlight": true},
-            {"text": " word.", "highlight": false}
-        ],
-        [
-            {"text": "Another", "highlight": true},
-            {"text": " fragment with a highlight.", "highlight": false}
-        ]
-    ]
-
-A client may use this example to produce the following output:
-
-... This is a sample text with a **highlighted** word. ... **Another** fragment with a highlight. ...
+*   ``score`` is an indication how well this document matches the query relative to the other search results.
+*   ``highlights`` is an excerpt from the document content and highlights the search terms with ``<span>`` tags as shown above.
+*   ``rank`` is the index of the search results. The first result will have rank 0.
 
 ``/api/search/autocomplete/``
 =============================
@@ -284,3 +248,53 @@ The endpoint supports the following optional form fields:
 The endpoint will immediately return "OK" if the document consumption process
 was started successfully. No additional status information about the consumption
 process itself is available, since that happens in a different process.
+
+
+.. _api-versioning:
+
+API Versioning
+##############
+
+The REST API is versioned since Paperless-ngx 1.3.0.
+
+* Versioning ensures that changes to the API don't break older clients.
+* Clients specify the specific version of the API they wish to use with every request and Paperless will handle the request using the specified API version.
+* Even if the underlying data model changes, older API versions will always serve compatible data.
+* If no version is specified, Paperless will serve version 1 to ensure compatibility with older clients that do not request a specific API version.
+
+API versions are specified by submitting an additional HTTP ``Accept`` header with every request:
+
+.. code::
+
+    Accept: application/json; version=6
+
+If an invalid version is specified, Paperless 1.3.0 will respond with "406 Not Acceptable" and an error message in the body.
+Earlier versions of Paperless will serve API version 1 regardless of whether a version is specified via the ``Accept`` header.
+
+If a client wishes to verify whether it is compatible with any given server, the following procedure should be performed:
+
+1.  Perform an *authenticated* request against any API endpoint. If the server is on version 1.3.0 or newer, the server will
+    add two custom headers to the response:
+
+    .. code::
+
+        X-Api-Version: 2
+        X-Version: 1.3.0
+
+2.  Determine whether the client is compatible with this server based on the presence/absence of these headers and their values if present.
+
+
+API Changelog
+=============
+
+Version 1
+---------
+
+Initial API version.
+
+Version 2
+---------
+
+* Added field ``Tag.color``. This read/write string field contains a hex color such as ``#a6cee3``.
+* Added read-only field ``Tag.text_color``. This field contains the text color to use for a specific tag, which is either black or white depending on the brightness of ``Tag.color``.
+* Removed field ``Tag.colour``.

docs/changelog.rst

@@ -5,8 +5,228 @@
 Changelog
 *********
 
+paperless-ngx 1.6.0
+###################
+
+This is the first release of the revived paperless-ngx project 🎉. Thank you to everyone on the paperless-ngx team for your initiative and excellent teamwork!
+
+Version 1.6.0 merges several pending PRs from jonaswinkler's repo and includes new feature updates and bug fixes. Major backend and UI changes include:
+
+* Updated docs, scripts, CI, and containers to paperless-ngx.
+* Updated Python and Angular dependencies.
+* Dropped support for Python 3.7.
+* Dropped support for Ansible playbooks (thanks `@slankes`_ #109). If someone would like to continue supporting them, please see the `ansible repo`_.
+* Python code is now required to use Black formatting (thanks `@kpj`_ #168).
+* `@tribut`_ added support for a custom SSO logout redirect (jonaswinkler#1258). See ``PAPERLESS_LOGOUT_REDIRECT_URL``.
+* `@shamoon`_ added a loading indicator when document list is reloading (jonaswinkler#1297).
+* `@shamoon`_ improved the PDF viewer on mobile (#2).
+* `@shamoon`_ added 'any' / 'all' and 'not' filtering with tags (#10).
+* `@shamoon`_ added warnings for unsaved changes, with smart edit buttons (#13).
+* `@benjaminfrank`_ enabled a non-root access to port 80 via systemd (#18).
+* `@tribut`_ added simple "delete to trash" functionality (#24). See ``PAPERLESS_TRASH_DIR``.
+* `@amenk`_ fixed the search box overlay menu on mobile (#32).
+* `@dblitt`_ updated the login form to not auto-capitalize usernames (#36).
+* `@evilsidekick293`_ made the worker timeout configurable (#37). See ``PAPERLESS_WORKER_TIMEOUT``.
+* `@Nicarim`_ fixed downloads of UTF-8 formatted documents in Firefox (#56).
+* `@mweimerskirch`_ sorted the language dropdown by locale (#78).
+* `@mweimerskirch`_ enabled the Czech (#83) and Danish (#84) translations.
+* `@cschmatzler`_ enabled specifying the webserver port (#124). See ``PAPERLESS_PORT``.
+* `@muellermartin`_ fixed an error when uploading transparent PNGs (#133).
+* `@shamoon`_ created a slick new logo (#165).
+* `@tim-vogel`_ fixed exports missing groups (#193).
+
+Thank you to the following people for their documentation updates, fixes, and comprehensive testing:
+
+`@m0veax`_, `@a17t`_, `@fignew`_, `@muued`_, `@bauerj`_, `@isigmund`_, `@denilsonsa`_, `@mweimerskirch`_, `@alexander-bauer`_, `@apeltzer`_, `@tribut`_, `@yschroeder`_, `@gador`_, `@sAksham-Ar`_, `@sbrunner`_, `@philpagel`_, `@davemachado`_, `@2600box`_, `@qcasey`_, `@Nicarim`_, `@kpj`_, `@filcuk`_, `@Timoms`_, `@mattlamb99`_, `@padraigkitterick`_, `@ajkavanagh`_, `@Tooa`_, `@Unkn0wnCat`_, `@pewter77`_, `@stumpylog`_, `@Toxix`_, `@azapater`_, `@jschpp`_
+
+Another big thanks to the people who have contributed translations:
+
+* Michel Weimerskirch (michel_weimerskirch) suggested 31 translations into French and Luxembourgish.
+* jo.vandeginste suggested 21 translations into Dutch.
+* Lars Sørensen (Lrss) suggested 486 translations into Danish.
+* Alex (Sky-Dragon) voted for 46 translations in German.
+* Yannic Schröder (yschroeder) suggested 14 translations into German.
+* David Morais Ferreira (DavidMoraisFerreira) voted for 10 translations in Portuguese and Luxembourgish.
+* David Morais Ferreira (DavidMoraisFerreira) suggested 88 translations into French, German, Portuguese, Portuguese, Brazilian and Luxembourgish.
+* 汪泠沣 (wlfcss) suggested 13 translations into Chinese Traditional.
+* Lars Sørensen (Lrss) suggested 167 translations into Danish.
+* Philmo67 suggested 11 translations into French.
+
+Paperless-ng
+############
+
+paperless-ng 1.5.0
+==================
+
+Support for Python 3.6 was dropped.
+
+* Updated python dependencies.
+* Base image of the docker image changed from Debian Buster to Debian Bullseye due to its recent release.
+* The docker image now uses python 3.9.
+* Added the Luxembourgish locale. Thanks for translating!
+* `Daniel Albers`_ added support for making the files and folders ignored by the paperless consume folder scanner configurable. See ``PAPERLESS_CONSUMER_IGNORE_PATTERNS``.
+
+paperless-ng 1.4.5
+==================
+
+This is a maintenance release.
+
+* Updated Python and Angular dependencies.
+* Changed the algorithm that changes permissions during startup. This is still fast,
+  and will hopefully cause less issues.
+* Fixed an issue that would sometimes cause paperless to write an incomplete
+  classification model file to disk.
+* Fixed an issue with the OCRmyPDF parser that would always try to extract text
+  with PDFminer even from non-PDF files.
+
+paperless-ng 1.4.4
+==================
+
+* Drastically decreased the startup time of the docker container. The startup script adjusts file permissions of all data only if changes are required.
+* Paperless mail: Added ability to specify the character set for each server.
+* Document consumption: Ignore Mac OS specific files such as ``.DS_STORE`` and ``._XXXXX.pdf``.
+* Fixed an issue with the automatic matching algorithm that prevents paperless from consuming new files.
+* Updated translations.
+
+paperless-ng 1.4.3
+==================
+
+* Additions and changes
+
+  * Added Swedish locale.
+  * `Stéphane Brunner`_ added an option to disable the progress bars of all management commands.
+  * `Jo Vandeginste`_ added support for RTF documents to the Apache TIKA parser.
+  * `Michael Shamoon`_ added dark mode for the login and logout pages.
+  * `Alexander Menk`_ added additional stylesheets for printing. You can now print any page of paperless and the print result will hide the page header, sidebar, and action buttons.
+  * Added support for sorting when using full text search.
+
+* Fixes
+
+  * `puuu`_ fixed ``PAPERLESS_FORCE_SCRIPT_NAME``. You can now host paperless on sub paths such as ``https://localhost:8000/paperless/``.
+  * Fixed an issue with the document consumer crashing on certain documents due to issues with pdfminer.six. This library is used for PDF text extraction.
+
+paperless-ng 1.4.2
+==================
+
+* Fixed an issue with ``sudo`` that caused paperless to not start on many Raspberry Pi devices. Thank you `WhiteHatTux`_!
+
+paperless-ng 1.4.1
+==================
+
+* Added Polish locale.
+
+* Changed some parts of the Dockerfile to hopefully restore functionality on certain ARM devices.
+
+* Updated python dependencies.
+
+* `Michael Shamoon`_ added a sticky filter / bulk edit bar.
+
+* `sbrl`_ changed the docker-entrypoint.sh script to increase compatibility with NFS shares.
+
+* `Chris Nagy`_ added support for creating a super user by passing ``PAPERLESS_ADMIN_USER`` and
+  ``PAPERLESS_ADMIN_PASSWORD`` as environment variables to the docker container.
+
+paperless-ng 1.4.0
+==================
+
+* Docker images now use tesseract 4.1.1, which should fix a series of issues with OCR.
+
+* The full text search now displays results using the default document list. This enables
+  selection, filtering and bulk edit on search results.
+
+* Changes
+
+  * Firefox only: Highlight search query in PDF previews.
+
+  * New URL pattern for accessing documents by ASN directly (http://<paperless>/asn/123)
+
+  * Added logging when executing pre- and post-consume scripts.
+
+  * Better error logging during document consumption.
+
+  * Updated python dependencies.
+
+  * Automatically inserts typed text when opening "Create new" dialogs on the document details page.
+
+* Fixes
+
+  * Fixed an issue with null characters in the document content.
+
+.. note::
+
+  The changed to the full text searching require you to reindex your documents.
+  *The docker image does this automatically, you don't need to do anything.*
+  To do this, execute the ``document_index reindex`` management command
+  (see :ref:`administration-index`).
+
+paperless-ng 1.3.2
+==================
+
+* Added translation into Portuguese.
+
+* Changes
+
+  * The exporter now exports user accounts, mail accounts, mail rules and saved views as well.
+
+* Fixes
+
+  * Minor layout issues with document cards and the log viewer.
+
+  * Fixed an issue with any/all/exact matching when characters used in regular expressions were used for the match.
+
+paperless-ng 1.3.1
+==================
+
+* Added translation into Spanish and Russian.
+
+* Other changes
+
+  * ISO-8601 date format will now always show years with 4 digits.
+
+  * Added the ability to search for a document with a specific ASN.
+
+  * The document cards now display ASN, types and dates in a more organized way.
+
+  * Added document previews when hovering over the preview button.
+
+* Fixes
+
+  * The startup check for write permissions now works properly on NFS shares.
+
+  * Fixed an issue with the search results score indicator.
+
+  * Paperless was unable to generate thumbnails for encrypted PDF files and failed. Paperless will now generate a default thumbnail for these files.
+
+  * Fixed ``AUTO_LOGIN_USERNAME``: Unable to perform POST/PUT/DELETE requests and unable to receive WebSocket messages.
+
+paperless-ng 1.3.0
+==================
+
+This release contains new database migrations.
+
+* Changes
+
+  * The REST API is versioned from this point onwards. This will allow me to make changes without breaking existing clients. See the documentation about :ref:`api-versioning` for details.
+
+  * Added a color picker for tag colors.
+
+  * Added the ability to use the filter for searching the document content as well.
+
+  * Added translations into Italian and Romanian. Thank you!
+
+  * Close individual documents from the sidebar. Thanks to `Michael Shamoon`_.
+
+  * `BolkoSchreiber <https://github.com/BolkoSchreiber>`_ added an option to disable/enable thumbnail inversion in dark mode.
+
+  * `Simon Taddiken <https://github.com/skuzzle>`_ added the ability to customize the header used for remote user authentication with SSO applications.
+
+* Bug fixes
+
+  * Fixed an issue with the auto matching algorithm when more than 256 tags were used.
+
+
 paperless-ng 1.2.1
-##################
+==================
 
 * `Rodrigo Avelino <https://github.com/rodavelino>`_ translated Paperless into Portuguese (Brazil)!
 
@@ -19,7 +239,7 @@ paperless-ng 1.2.1
 * Regression fix: Dates on the front end did not respect date locale settings in some cases.
 
 paperless-ng 1.2.0
-##################
+==================
 
 * Changes to the OCRmyPDF integration
 
@@ -42,26 +262,15 @@ paperless-ng 1.2.0
 
 * Paperless no longer depends on ``libpoppler-cpp-dev``.
 
-.. note::
-
-  Some packages that paperless depends on are slowly dropping Python 3.6
-  support one after another, including the web server. Supporting Python
-  3.6 means that I cannot update these packages anymore.
-
-  At some point, paperless will drop Python 3.6 support. If using a bare
-  metal installation and you're still on Python 3.6, upgrade to 3.7 or newer.
-
-  If using docker, this does not affect you.
-
 paperless-ng 1.1.4
-##################
+==================
 
 * Added English (GB) locale.
 
 * Added ISO-8601 date display option.
 
 paperless-ng 1.1.3
-##################
+==================
 
 * Added a docker-specific configuration option to adjust the number of
   worker processes of the web server. See :ref:`configuration-docker`.
@@ -71,7 +280,7 @@ paperless-ng 1.1.3
 * Don't show inbox statistics if no inbox tag is defined.
 
 paperless-ng 1.1.2
-##################
+==================
 
 * Always show top left corner of thumbnails, even for extra wide documents.
 
@@ -87,7 +296,7 @@ paperless-ng 1.1.2
 * Some memory usage optimizations.
 
 paperless-ng 1.1.1
-##################
+==================
 
 This release contains new database migrations.
 
@@ -108,7 +317,7 @@ This release contains new database migrations.
   also ensure that they're always executed as the paperless user and you're less likely to run into permission issues. See :ref:`utilities-management-commands`.
 
 paperless-ng 1.1.0
-##################
+==================
 
 * Document processing status
 
@@ -168,7 +377,7 @@ paperless-ng 1.1.0
     ``PAPERLESS_LOGROTATE_MAX_BACKUPS``.
 
 paperless-ng 1.0.0
-##################
+==================
 
 Nothing special about this release, but since there are relatively few bug reports coming in, I think that this is reasonably stable.
 
@@ -191,7 +400,7 @@ Nothing special about this release, but since there are relatively few bug repor
 
 
 paperless-ng 0.9.14
-###################
+===================
 
 Starting with this version, releases are getting built automatically. This release also comes with changes on how to install and
 update paperless.
@@ -239,13 +448,13 @@ update paperless.
   * An issue with the consumer crashing when invalid regular expression were used was fixed.
 
 paperless-ng 0.9.13
-###################
+===================
 
 * Fixed an issue with Paperless not starting due to the new Tika integration when ``USERMAP_UID`` and ``USERMAP_GID`` was used
   in the ``docker-compose.env`` file.
 
 paperless-ng 0.9.12
-###################
+===================
 
 * Paperless localization
 
@@ -287,13 +496,13 @@ paperless-ng 0.9.12
     a document that did not yet exist in the database.
 
 paperless-ng 0.9.11
-###################
+===================
 
 * Fixed an issue with the docker image not starting at all due to a configuration change of the web server.
 
 
 paperless-ng 0.9.10
-###################
+===================
 
 * Bulk editing
 
@@ -326,7 +535,7 @@ paperless-ng 0.9.10
   by :ref:`running the management command document_index with the argument reindex <administration-index>`.
 
 paperless-ng 0.9.9
-##################
+==================
 
 Christmas release!
 
@@ -360,7 +569,7 @@ Christmas release!
   * Most of the guesswork features have been removed. Paperless no longer tries to extract correspondents and tags from file names.
 
 paperless-ng 0.9.8
-##################
+==================
 
 This release addresses two severe issues with the previous release.
 
@@ -369,7 +578,7 @@ This release addresses two severe issues with the previous release.
 
 
 paperless-ng 0.9.7
-##################
+==================
 
 
 * Front end
@@ -411,7 +620,7 @@ paperless-ng 0.9.7
 
 
 paperless-ng 0.9.6
-##################
+==================
 
 This release focusses primarily on many small issues with the UI.
 
@@ -452,7 +661,7 @@ This release focusses primarily on many small issues with the UI.
 
 
 paperless-ng 0.9.5
-##################
+==================
 
 This release concludes the big changes I wanted to get rolled into paperless. The next releases before 1.0 will
 focus on fixing issues, primarily.
@@ -502,7 +711,7 @@ focus on fixing issues, primarily.
   * Assigning correspondents from mail sender names failed for very long names. Paperless no longer assigns correspondents in these cases.
 
 paperless-ng 0.9.4
-##################
+==================
 
 * Searching:
 
@@ -530,7 +739,7 @@ paperless-ng 0.9.4
   how to setup the development environment.
 
 paperless-ng 0.9.3
-##################
+==================
 
 * Setting ``PAPERLESS_AUTO_LOGIN_USERNAME`` replaces ``PAPERLESS_DISABLE_LOGIN``.
   You have to specify your username.
@@ -548,7 +757,7 @@ paperless-ng 0.9.3
 * Added lots of tests for various parts of the application.
 
 paperless-ng 0.9.2
-##################
+==================
 
 * Major changes to the front end (colors, logo, shadows, layout of the cards,
   better mobile support)
@@ -578,7 +787,7 @@ paperless-ng 0.9.2
   up in the admin.
 
 paperless-ng 0.9.1
-##################
+==================
 
 * Moved documentation of the settings to the actual documentation.
 * Updated release script to force the user to choose between SQLite
@@ -586,7 +795,7 @@ paperless-ng 0.9.1
 
 
 paperless-ng 0.9.0
-##################
+==================
 
 * **Deprecated:** GnuPG. :ref:`See this note on the state of GnuPG in paperless-ng. <utilities-encyption>`
   This features will most likely be removed in future versions.
@@ -1246,6 +1455,11 @@ bulk of the work on this big change.
 
 * Initial release
 
+.. _Alexander Menk: https://github.com/amenk
+.. _puuu: https://github.com/puuu
+.. _WhiteHatTux: https://github.com/WhiteHatTux
+.. _Chris Nagy: https://github.com/what-name
+.. _sbrl: https://github.com/sbrl
 .. _slorenz: https://github.com/sisao
 .. _Jo Vandeginste: https://github.com/jovandeginste
 .. _zjean: https://github.com/zjean
@@ -1318,6 +1532,50 @@ bulk of the work on this big change.
 .. _JOKer: https://github.com/MasterofJOKers
 .. _Brian Cribbs: https://github.com/cribbstechnolog
 .. _Brendan M. Sleight: https://github.com/bmsleight
+.. _Daniel Albers: https://github.com/AlD
+.. _@shamoon: https://github.com/shamoon
+.. _@amenk: https://github.com/amenk
+.. _@dblitt: https://github.com/dblitt
+.. _@evilsidekick293: https://github.com/evilsidekick293
+.. _@m0veax: https://github.com/m0veax
+.. _@fignew: https://github.com/fignew
+.. _@muued: https://github.com/muued
+.. _@isigmund: https://github.com/isigmund
+.. _@denilsonsa: https://github.com/denilsonsa
+.. _@sAksham-Ar: https://github.com/sAksham-Ar
+.. _@philpagel: https://github.com/philpagel
+.. _@davemachado: https://github.com/davemachado
+.. _@2600box: https://github.com/2600box
+.. _@qcasey: https://github.com/qcasey
+.. _@kpj: https://github.com/kpj
+.. _@mweimerskirch: https://github.com/mweimerskirch
+.. _@filcuk: https://github.com/filcuk
+.. _@FrankStrieter: https://github.com/FrankStrieter
+.. _@tribut: https://github.com/tribut
+.. _@yschroeder: https://github.com/yschroeder
+.. _@gador: https://github.com/gador
+.. _@Nicarim: https://github.com/Nicarim
+.. _@bauerj: https://github.com/bauerj
+.. _@a17t: https://github.com/a17t
+.. _@alexander-bauer: https://github.com/alexander-bauer
+.. _@apeltzer: https://github.com/apeltzer
+.. _@Timoms: https://github.com/Timoms
+.. _@sbrunner: https://github.com/sbrunner
+.. _@slankes: https://github.com/slankes
+.. _@mattlamb99: https://github.com/mattlamb99
+.. _@padraigkitterick: https://github.com/padraigkitterick
+.. _@ajkavanagh: https://github.com/ajkavanagh
+.. _@Tooa: https://github.com/Tooa
+.. _@Unkn0wnCat: https://github.com/Unkn0wnCat
+.. _@pewter77: https://github.com/pewter77
+.. _@cschmatzler: https://github.com/cschmatzler
+.. _@muellermartin: https://github.com/muellermartin
+.. _@stumpylog: https://github.com/stumpylog
+.. _@Toxix: https://github.com/Toxix
+.. _@benjaminfrank: https://github.com/benjaminfrank
+.. _@azapater: https://github.com/azapater
+.. _@tim-vogel: https://github.com/tim-vogel
+.. _@jschpp: https://github.com/jschpp
 
 .. _#20: https://github.com/the-paperless-project/paperless/issues/20
 .. _#44: https://github.com/the-paperless-project/paperless/issues/44
@@ -1430,3 +1688,4 @@ bulk of the work on this big change.
 .. _a new home on Docker Hub: https://hub.docker.com/r/danielquinn/paperless/
 .. _optipng: http://optipng.sourceforge.net/
 .. _DjangoQL: https://github.com/ivelum/djangoql
+.. _ansible repo: https://github.com/paperless-ngx/paperless-ngx-ansible

docs/conf.py

@@ -6,29 +6,29 @@ exec(open("../src/paperless/version.py").read())
 
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.imgmath',
-    'sphinx.ext.viewcode',
-    'sphinx_rtd_theme',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.imgmath",
+    "sphinx.ext.viewcode",
+    "sphinx_rtd_theme",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'Paperless-ng'
-copyright = u'2021, Daniel Quinn, Jonas Winkler'
+project = "Paperless-ngx"
+copyright = "2015-2022, Daniel Quinn, Jonas Winkler, and the paperless-ngx team"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -47,180 +47,174 @@ release = ".".join([str(_) for _ in __version__[:3]])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'paperless'
+htmlhelp_basename = "paperless"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'paperless.tex', u'Paperless Documentation',
-   u'Daniel Quinn', 'manual'),
+    ("index", "paperless.tex", "Paperless Documentation", "Daniel Quinn", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'paperless', u'Paperless Documentation',
-     [u'Daniel Quinn'], 1)
-]
+man_pages = [("index", "paperless", "Paperless Documentation", ["Daniel Quinn"], 1)]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -229,93 +223,99 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'Paperless', u'Paperless Documentation',
-   u'Daniel Quinn', 'paperless', 'Scan, index, and archive all of your paper documents.',
-   'Miscellaneous'),
+    (
+        "index",
+        "Paperless",
+        "Paperless Documentation",
+        "Daniel Quinn",
+        "paperless",
+        "Scan, index, and archive all of your paper documents.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
 
 
 # -- Options for Epub output ----------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = u'Paperless'
-epub_author = u'Daniel Quinn'
-epub_publisher = u'Daniel Quinn'
-epub_copyright = u'2015, Daniel Quinn'
+epub_title = "Paperless"
+epub_author = "Daniel Quinn"
+epub_publisher = "Daniel Quinn"
+epub_copyright = "2015, Daniel Quinn"
 
 # The basename for the epub file. It defaults to the project name.
-#epub_basename = u'Paperless'
+# epub_basename = u'Paperless'
 
 # The HTML theme for the epub output. Since the default themes are not optimized
 # for small screen space, using the same theme for HTML and epub output is
 # usually not wise. This defaults to 'epub', a theme designed to save visual
 # space.
-#epub_theme = 'epub'
+# epub_theme = 'epub'
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.
-#epub_language = ''
+# epub_language = ''
 
 # The scheme of the identifier. Typical schemes are ISBN or URL.
-#epub_scheme = ''
+# epub_scheme = ''
 
 # The unique identifier of the text. This can be a ISBN number
 # or the project homepage.
-#epub_identifier = ''
+# epub_identifier = ''
 
 # A unique identification for the text.
-#epub_uid = ''
+# epub_uid = ''
 
 # A tuple containing the cover image and cover page html template filenames.
-#epub_cover = ()
+# epub_cover = ()
 
 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
-#epub_guide = ()
+# epub_guide = ()
 
 # HTML files that should be inserted before the pages created by sphinx.
 # The format is a list of tuples containing the path and title.
-#epub_pre_files = []
+# epub_pre_files = []
 
 # HTML files shat should be inserted after the pages created by sphinx.
 # The format is a list of tuples containing the path and title.
-#epub_post_files = []
+# epub_post_files = []
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 # The depth of the table of contents in toc.ncx.
-#epub_tocdepth = 3
+# epub_tocdepth = 3
 
 # Allow duplicate toc entries.
-#epub_tocdup = True
+# epub_tocdup = True
 
 # Choose between 'default' and 'includehidden'.
-#epub_tocscope = 'default'
+# epub_tocscope = 'default'
 
 # Fix unsupported image types using the PIL.
-#epub_fix_images = False
+# epub_fix_images = False
 
 # Scale large images.
-#epub_max_image_width = 0
+# epub_max_image_width = 0
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#epub_show_urls = 'inline'
+# epub_show_urls = 'inline'
 
 # If false, no index is generated.
-#epub_use_index = True
+# epub_use_index = True
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+intersphinx_mapping = {"http://docs.python.org/": None}

docs/configuration.rst

@@ -80,6 +80,15 @@ PAPERLESS_DATA_DIR=<path>
 
     Defaults to "../data/", relative to the "src" directory.
 
+PAPERLESS_TRASH_DIR=<path>
+    Instead of removing deleted documents, they are moved to this directory.
+
+    This must be writeable by the user running paperless. When running inside
+    docker, ensure that this path is within a permanent volume (such as
+    "../media/trash") so it won't get lost on upgrades.
+
+    Defaults to empty (i.e. really delete documents).
+
 PAPERLESS_MEDIA_ROOT=<path>
     This is where your documents and thumbnails are stored.
 
@@ -154,10 +163,6 @@ PAPERLESS_FORCE_SCRIPT_NAME=<path>
     To host paperless under a subpath url like example.com/paperless you set
     this value to /paperless. No trailing slash!
 
-    .. note::
-
-        I don't know if this works in paperless-ng. Probably not.
-
     Defaults to none, which hosts paperless at "/".
 
 PAPERLESS_STATIC_URL=<path>
@@ -177,6 +182,30 @@ PAPERLESS_AUTO_LOGIN_USERNAME=<username>
 
     Defaults to none, which disables this feature.
 
+PAPERLESS_ADMIN_USER=<username>
+    If this environment variable is specified, Paperless automatically creates
+    a superuser with the provided username at start. This is useful in cases
+    where you can not run the `createsuperuser` command seperately, such as Kubernetes
+    or AWS ECS.
+
+    Requires `PAPERLESS_ADMIN_PASSWORD` to be set.
+
+    .. note::
+
+        This will not change an existing [super]user's password, nor will
+        it recreate a user that already exists. You can leave this throughout
+        the lifecycle of the containers.
+
+PAPERLESS_ADMIN_MAIL=<email>
+    (Optional) Specify superuser email address. Only used when
+    `PAPERLESS_ADMIN_USER` is set.
+
+    Defaults to ``root@localhost``.
+
+PAPERLESS_ADMIN_PASSWORD=<password>
+    Only used when `PAPERLESS_ADMIN_USER` is set.
+    This will be the password of the automatically created superuser.
+
 
 PAPERLESS_COOKIE_PREFIX=<str>
     Specify a prefix that is added to the cookies used by paperless to identify
@@ -191,8 +220,35 @@ PAPERLESS_ENABLE_HTTP_REMOTE_USER=<bool>
     Allows authentication via HTTP_REMOTE_USER which is used by some SSO
     applications.
 
+    .. warning::
+
+        This will allow authentication by simply adding a ``Remote-User: <username>`` header
+        to a request. Use with care! You especially *must* ensure that any such header is not
+        passed from your proxy server to paperless.
+
+        If you're exposing paperless to the internet directly, do not use this.
+
+        Also see the warning `in the official documentation <https://docs.djangoproject.com/en/3.1/howto/auth-remote-user/#configuration>`.
+
     Defaults to `false` which disables this feature.
 
+PAPERLESS_HTTP_REMOTE_USER_HEADER_NAME=<str>
+    If `PAPERLESS_ENABLE_HTTP_REMOTE_USER` is enabled, this property allows to
+    customize the name of the HTTP header from which the authenticated username
+    is extracted. Values are in terms of
+    [HttpRequest.META](https://docs.djangoproject.com/en/3.1/ref/request-response/#django.http.HttpRequest.META).
+    Thus, the configured value must start with `HTTP_` followed by the
+    normalized actual header name.
+
+    Defaults to `HTTP_REMOTE_USER`.
+
+PAPERLESS_LOGOUT_REDIRECT_URL=<str>
+    URL to redirect the user to after a logout. This can be used together with
+    `PAPERLESS_ENABLE_HTTP_REMOTE_USER` to redirect the user back to the SSO
+    application's logout page.
+
+    Defaults to None, which disables this feature.
+
 .. _configuration-ocr:
 
 OCR settings
@@ -218,6 +274,8 @@ PAPERLESS_OCR_LANGUAGE=<lang>
 
     Defaults to "eng".
 
+		Note: If your language contains a '-' such as chi-sim, you must use chi_sim
+
 PAPERLESS_OCR_MODE=<mode>
     Tell paperless when and how to perform ocr on your documents. Four modes
     are available:
@@ -331,6 +389,15 @@ PAPERLESS_OCR_IMAGE_DPI=<num>
     Default is none, which will automatically calculate image DPI so that
     the produced PDF documents are A4 sized.
 
+PAPERLESS_OCR_MAX_IMAGE_PIXELS=<num>
+    Paperless will not OCR images that have more pixels than this limit.
+    This is intended to prevent decompression bombs from overloading paperless.
+    Increasing this limit is desired if you face a DecompressionBombError despite
+    the concerning file not being malicious; this could e.g. be caused by invalidly
+    recognized metadata.
+    If you have enough resources or if you are certain that your uploaded files
+    are not malicious you can increase this value to your needs.
+    The default value is 256000000, an image with more pixels than that would not be parsed.
 
 PAPERLESS_OCR_USER_ARGS=<json>
     OCRmyPDF offers many more options. Use this parameter to specify any
@@ -360,7 +427,7 @@ Tika settings
 #############
 
 Paperless can make use of `Tika <https://tika.apache.org/>`_ and
-`Gotenberg <https://thecodingmachine.github.io/gotenberg/>`_ for parsing and
+`Gotenberg <https://gotenberg.dev/>`_ for parsing and
 converting "Office" documents (such as ".doc", ".xlsx" and ".odt"). If you
 wish to use this, you must provide a Tika server and a Gotenberg server,
 configure their endpoints, and enable the feature.
@@ -402,10 +469,11 @@ requires are as follows:
         # ...
 
         gotenberg:
-            image: thecodingmachine/gotenberg
+            image: gotenberg/gotenberg:7
             restart: unless-stopped
-            environment:
-                DISABLE_GOOGLE_CHROME: 1
+            command:
+                - "gotenberg"
+                - "--chromium-disable-routes=true"
 
         tika:
             image: apache/tika
@@ -415,6 +483,8 @@ Add the configuration variables to the environment of the webserver (alternative
 put the configuration in the ``docker-compose.env`` file) and add the additional
 services below the webserver service. Watch out for indentation.
 
+Make sure to use the correct format `PAPERLESS_TIKA_ENABLED = 1` so python_dotenv can parse the statement correctly.
+
 Software tweaks
 ###############
 
@@ -465,6 +535,12 @@ PAPERLESS_THREADS_PER_WORKER=<num>
     PAPERLESS_THREADS_PER_WORKER automatically.
 
 
+PAPERLESS_WORKER_TIMEOUT=<num>
+    Machines with few cores or weak ones might not be able to finish OCR on
+    large documents within the default 1800 seconds. So extending this timeout
+    may prove to be useful on weak hardware setups.
+
+
 PAPERLESS_TIME_ZONE=<timezone>
     Set the time zone here.
     See https://docs.djangoproject.com/en/3.1/ref/settings/#std:setting-TIME_ZONE
@@ -582,6 +658,20 @@ PAPERLESS_IGNORE_DATES=<string>
 
     Defaults to an empty string to not ignore any dates.
 
+PAPERLESS_DATE_ORDER=<format>
+    Paperless will try to determine the document creation date from its contents.
+    Specify the date format Paperless should expect to see within your documents.
+
+    This option defaults to DMY which translates to day first, month second, and year
+    last order. Characters D, M, or Y can be shuffled to meet the required order.
+
+PAPERLESS_CONSUMER_IGNORE_PATTERNS=<json>
+    By default, paperless ignores certain files and folders in the consumption
+    directory, such as system files created by the Mac OS.
+
+    This can be adjusted by configuring a custom json array with patterns to exclude.
+
+    Defautls to ``[".DS_STORE/*", "._*", ".stfolder/*"]``.
 
 Binaries
 ########
@@ -621,6 +711,17 @@ PAPERLESS_WEBSERVER_WORKERS=<num>
 
     Defaults to 2.
 
+PAPERLESS_PORT=<port>
+    The port number the webserver will listen on inside the container. There are
+    special setups where you may need this to avoid collisions with other
+    services (like using podman with multiple containers in one pod).
+
+    Don't change this when using Docker. To change the port the webserver is
+    reachable outside of the container, instead refer to the "ports" key in
+    ``docker-compose.yml``.
+
+    Defaults to 8000.
+
 USERMAP_UID=<uid>
     The ID of the paperless user in the container. Set this to your actual user ID on the
     host system, which you can get by executing

docs/contributing.rst

@@ -1,145 +0,0 @@
-.. _contributing:
-
-Contributing to Paperless
-#########################
-
-.. warning::
-
-    This section is not updated to paperless-ng yet.
-    
-Maybe you've been using Paperless for a while and want to add a feature or two,
-or maybe you've come across a bug that you have some ideas how to solve.  The
-beauty of Free software is that you can see what's wrong and help to get it
-fixed for everyone!
-
-
-How to Get Your Changes Rolled Into Paperless
-=============================================
-
-If you've found a bug, but don't know how to fix it, you can always post an
-issue on `GitHub`_ in the hopes that someone will have the time to fix it for
-you.  If however you're the one with the time, pull requests are always
-welcome, you just have to make sure that your code conforms to a few standards:
-
-Pep8
-----
-
-It's the standard for all Python development, so it's `very well documented`_.
-The short version is:
-
-* Lines should wrap at 79 characters
-* Use ``snake_case`` for variables, ``CamelCase`` for classes, and ``ALL_CAPS``
-  for constants.
-* Space out your operators: ``stuff + 7`` instead of ``stuff+7``
-* Two empty lines between classes, and functions, but 1 empty line between
-  class methods.
-
-There's more to it than that, but if you follow those, you'll probably be
-alright.  When you submit your pull request, there's a pep8 checker that'll
-look at your code to see if anything is off.  If it finds anything, it'll
-complain at you until you fix it.
-
-
-Additional Style Guides
------------------------
-
-Where pep8 is ambiguous, I've tried to be a little more specific.  These rules
-aren't hard-and-fast, but if you can conform to them, I'll appreciate it and
-spend less time trying to conform your PR before merging:
-
-
-Function calls
-..............
-
-If you're calling a function and that necessitates more than one line of code,
-please format it like this:
-
-.. code:: python
-
-    my_function(
-        argument1,
-        kwarg1="x",
-        kwarg2="y"
-        another_really_long_kwarg="some big value"
-        a_kwarg_calling_another_long_function=another_function(
-            another_arg,
-            another_kwarg="kwarg!"
-        )
-    )
-
-This is all in the interest of code uniformity rather than anything else.  If
-we stick to a style, everything is understandable in the same way.
-
-
-Quoting Strings
-...............
-
-pep8 is a little too open-minded on this for my liking.  Python strings should
-be quoted with double quotes (``"``) except in cases where the resulting string
-would require too much escaping of a double quote, in which case, a single
-quoted, or triple-quoted string will do:
-
-.. code:: python
-
-    my_string = "This is my string"
-    problematic_string = 'This is a "string" with "quotes" in it'
-
-In HTML templates, please use double-quotes for tag attributes, and single
-quotes for arguments passed to Django template tags:
-
-.. code:: html
-
-    <div class="stuff">
-        <a href="{% url 'some-url-name' pk='w00t' %}">link this</a>
-    </div>
-
-This is to keep linters happy they look at an HTML file and see an attribute
-closing the ``"`` before it should have been.
-
---
-
-That's all there is in terms of guidelines, so I hope it's not too daunting.
-
-
-Indentation & Spacing
-.....................
-
-When it comes to indentation:
-
-* For Python, the rule is: follow pep8 and use 4 spaces.
-* For Javascript, CSS, and HTML, please use 1 tab.
-
-Additionally, Django templates making use of block elements like ``{% if %}``,
-``{% for %}``, and ``{% block %}`` etc. should be indented:
-
-Good:
-
-.. code:: html
-
-    {% block stuff %}
-    	<h1>This is the stuff</h1>
-    {% endblock %}
-
-Bad:
-
-.. code:: html
-
-    {% block stuff %}
-    <h1>This is the stuff</h1>
-    {% endblock %}
-
-
-The Code of Conduct
-===================
-
-Paperless has a `code of conduct`_.  It's a lot like the other ones you see out
-there, with a few small changes, but basically it boils down to:
-
-> Don't be an ass, or you might get banned.
-
-I'm proud to say that the CoC has never had to be enforced because everyone has
-been awesome, friendly, and professional.
-
-.. _GitHub: https://github.com/the-paperless-project/paperless/issues
-.. _very well documented: https://www.python.org/dev/peps/pep-0008/
-.. _code of conduct: https://github.com/the-paperless-project/paperless/blob/master/CODE_OF_CONDUCT.md

docs/extending.rst

@@ -1,76 +1,163 @@
 .. _extending:
 
-Paperless development
-#####################
+Paperless-ngx Development
+#########################
 
-This section describes the steps you need to take to start development on paperless-ng.
+This section describes the steps you need to take to start development on paperless-ngx.
 
-1.  Check out the source from github. The repository is organized in the following way:
+Check out the source from github. The repository is organized in the following way:
 
-    *   ``master`` always represents the latest release and will only see changes
-        when a new release is made.
-    *   ``dev`` contains the code that will be in the next release.
-    *   ``feature-X`` contain bigger changes that will be in some release, but not
-        necessarily the next one.
-    
-    Apart from that, the folder structure is as follows:
+*   ``main`` always represents the latest release and will only see changes
+    when a new release is made.
+*   ``dev`` contains the code that will be in the next release.
+*   ``feature-X`` contain bigger changes that will be in some release, but not
+    necessarily the next one.
 
-    *   ``docs/`` - Documentation.
-    *   ``src-ui/`` - Code of the front end.
-    *   ``src/`` - Code of the back end.
-    *   ``scripts/`` - Various scripts that help with different parts of development.
-    *   ``docker/`` - Files required to build the docker image.
+When making functional changes to paperless, *always* make your changes on the ``dev`` branch.
 
-2.  Install some dependencies.
+Apart from that, the folder structure is as follows:
 
-    *   Python 3.6.
-    *   All dependencies listed in the :ref:`Bare metal route <setup-bare_metal>`
-    *   redis. You can either install redis or use the included scripts/start-services.sh
-        to use docker to fire up a redis instance (and some other services such as tika,
-        gotenberg and a postgresql server).
+*   ``docs/`` - Documentation.
+*   ``src-ui/`` - Code of the front end.
+*   ``src/`` - Code of the back end.
+*   ``scripts/`` - Various scripts that help with different parts of development.
+*   ``docker/`` - Files required to build the docker image.
+
+Contributing to Paperless
+=========================
+
+Maybe you've been using Paperless for a while and want to add a feature or two,
+or maybe you've come across a bug that you have some ideas how to solve.  The
+beauty of open source software is that you can see what's wrong and help to get
+it fixed for everyone!
+
+Before contributing please review our `code of conduct`_ and other important
+information in the `contributing guidelines`_.
+
+.. _code-formatting-with-pre-commit-hooks:
+
+Code formatting with pre-commit Hooks
+=====================================
+
+To ensure a consistent style and formatting across the project source, the project
+utilizes a Git `pre-commit` hook to perform some formatting and linting before a
+commit is allowed. That way, everyone uses the same style and some common issues
+can be caught early on. See below for installation instructions.
+
+Once installed, hooks will run when you commit. If the formatting isn't quite right
+or a linter catches something, the commit will be rejected. You'll need to look at the
+output and fix the issue. Some hooks, such as the Python formatting tool `black`,
+will format failing files, so all you need to do is `git add` those files again and
+retry your commit.
+
+Initial setup and first start
+=============================
+
+After you forked and cloned the code from github you need to perform a first-time setup.
+To do the setup you need to perform the steps from the following chapters in a certain order:
+
+1.  Install prerequisites + pipenv as mentioned in :ref:`Bare metal route <setup-bare_metal>`
+2.  Copy ``paperless.conf.example`` to ``paperless.conf`` and enable debug mode.
+3.  Install the Angular CLI interface:
+
+    .. code:: shell-session
+
+        $ npm install -g @angular/cli
+
+4.  Install pre-commit
+
+    .. code:: shell-session
+
+        pre-commit install
+
+5.  Create ``consume`` and ``media`` folders in the cloned root folder.
+
+    .. code:: shell-session
+
+        mkdir -p consume media
+
+6.  You can now either ...
+
+    *  install redis or
+    *  use the included scripts/start-services.sh to use docker to fire up a redis instance (and some other services such as tika, gotenberg and a postgresql server) or
+    *  spin up a bare redis container
+
+        .. code:: shell-session
+
+            docker run -d -p 6379:6379 --restart unless-stopped redis:latest
+
+7.  Install the python dependencies by performing in the src/ directory.
+
+    .. code:: shell-session
+
+        pipenv install --dev
+
+  * Make sure you're using python 3.9.x or lower. Otherwise you might get issues with building dependencies. You can use `pyenv <https://github.com/pyenv/pyenv>`_ to install a specific python version.
+
+8.  Generate the static UI so you can perform a login to get session that is required for frontend development (this needs to be done one time only). From src-ui directory:
+
+    .. code:: shell-session
+
+        npm install .
+        ./node_modules/.bin/ng build --configuration production
+
+9.  Apply migrations and create a superuser for your dev instance:
+
+    .. code:: shell-session
+
+        python3 manage.py migrate
+        python3 manage.py createsuperuser
+
+10.  Now spin up the dev backend. Depending on which part of paperless you're developing for, you need to have some or all of them running.
+
+    .. code:: shell-session
+
+        python3 manage.py runserver & python3 manage.py document_consumer & python3 manage.py qcluster
+
+11. Login with the superuser credentials provided in step 8 at ``http://localhost:8000`` to create a session that enables you to use the backend.
+
+Backend development environment is now ready, to start Frontend development go to ``/src-ui`` and run ``ng serve``. From there you can use ``http://localhost:4200`` for a preview.
 
 Back end development
 ====================
 
-The backend is a django application. I use PyCharm for development, but you can use whatever
+The backend is a django application. PyCharm works well for development, but you can use whatever
 you want.
 
-Install the python dependencies by performing ``pipenv install --dev`` in the src/ directory.
-This will also create a virtual environment, which you can enter with ``pipenv shell`` or
-execute one-shot commands in with ``pipenv run``.
-
-Copy ``paperless.conf.example`` to ``paperless.conf`` and enable debug mode.
-
 Configure the IDE to use the src/ folder as the base source folder. Configure the following
 launch configurations in your IDE:
 
 *   python3 manage.py runserver
 *   python3 manage.py qcluster
-*   python3 manage.py consumer
+*   python3 manage.py document_consumer
 
-Depending on which part of paperless you're developing for, you need to have some or all of
-them running.
+To start them all:
+
+.. code:: shell-session
+
+    python3 manage.py runserver & python3 manage.py document_consumer & python3 manage.py qcluster
 
 Testing and code style:
 
 *   Run ``pytest`` in the src/ directory to execute all tests. This also generates a HTML coverage
     report. When runnings test, paperless.conf is loaded as well. However: the tests rely on the default
     configuration. This is not ideal. But for now, make sure no settings except for DEBUG are overridden when testing.
-*   Run ``pycodestyle`` to test your code for issues with the configured code style settings.
+*   Coding style is enforced by the Git pre-commit hooks.  These will ensure your code is formatted and do some
+    linting when you do a `git commit`.
+*   You can also run ``black`` manually to format your code
 
     .. note::
 
         The line length rule E501 is generally useful for getting multiple source files
         next to each other on the screen. However, in some cases, its just not possible
-        to make some lines fit, especially complicated IF cases. Append ``  # NOQA: E501``
+        to make some lines fit, especially complicated IF cases. Append ``# NOQA: E501``
         to disable this check for certain lines.
 
 Front end development
 =====================
 
-The front end is build using angular. I use the ``Code - OSS`` IDE for development.
-
-In order to get started, you need ``npm``. Install the Angular CLI interface with
+The front end is built using Angular. In order to get started, you need ``npm``.
+Install the Angular CLI interface with
 
 .. code:: shell-session
 
@@ -99,6 +186,31 @@ X-Frame-Options are in place so that the front end behaves exactly as in product
 relies on you being logged into the back end. Without a valid session, The front end will simply
 not work.
 
+Testing and code style:
+
+*   The frontend code (.ts, .html, .scss) use ``prettier`` for code formatting via the Git
+    ``pre-commit`` hooks which run automatically on commit. See
+    :ref:`above <code-formatting-with-pre-commit-hooks>` for installation. You can also run this
+    via cli with a command such as
+
+    .. code:: shell-session
+
+        $ git ls-files -- '*.ts' | xargs pre-commit run prettier --files
+
+*   Frontend testing uses jest and cypress. There is currently a need for significantly more
+    frontend tests. Unit tests and e2e tests, respectively, can be run non-interactively with:
+
+    .. code:: shell-session
+
+        $ ng test
+        $ npm run e2e:ci
+
+    Cypress also includes a UI which can be run from within the ``src-ui`` directory with
+
+    .. code:: shell-session
+
+        $ ./node_modules/.bin/cypress open
+
 In order to build the front end and serve it as part of django, execute
 
 .. code:: shell-session
@@ -109,6 +221,92 @@ This will build the front end and put it in a location from which the Django ser
 it as static content. This way, you can verify that authentication is working.
 
 
+Localization
+============
+
+Paperless is available in many different languages. Since paperless consists both of a django
+application and an Angular front end, both these parts have to be translated separately.
+
+Front end localization
+----------------------
+
+*   The Angular front end does localization according to the `Angular documentation <https://angular.io/guide/i18n>`_.
+*   The source language of the project is "en_US".
+*   The source strings end up in the file "src-ui/messages.xlf".
+*   The translated strings need to be placed in the "src-ui/src/locale/" folder.
+*   In order to extract added or changed strings from the source files, call ``ng xi18n --ivy``.
+
+Adding new languages requires adding the translated files in the "src-ui/src/locale/" folder and adjusting a couple files.
+
+1.  Adjust "src-ui/angular.json":
+
+    .. code:: json
+
+        "i18n": {
+            "sourceLocale": "en-US",
+            "locales": {
+                "de": "src/locale/messages.de.xlf",
+                "nl-NL": "src/locale/messages.nl_NL.xlf",
+                "fr": "src/locale/messages.fr.xlf",
+                "en-GB": "src/locale/messages.en_GB.xlf",
+                "pt-BR": "src/locale/messages.pt_BR.xlf",
+                "language-code": "language-file"
+            }
+        }
+
+2.  Add the language to the available options in "src-ui/src/app/services/settings.service.ts":
+
+    .. code:: typescript
+
+        getLanguageOptions(): LanguageOption[] {
+            return [
+                {code: "en-us", name: $localize`English (US)`, englishName: "English (US)", dateInputFormat: "mm/dd/yyyy"},
+                {code: "en-gb", name: $localize`English (GB)`, englishName: "English (GB)", dateInputFormat: "dd/mm/yyyy"},
+                {code: "de", name: $localize`German`, englishName: "German", dateInputFormat: "dd.mm.yyyy"},
+                {code: "nl", name: $localize`Dutch`, englishName: "Dutch", dateInputFormat: "dd-mm-yyyy"},
+                {code: "fr", name: $localize`French`, englishName: "French", dateInputFormat: "dd/mm/yyyy"},
+                {code: "pt-br", name: $localize`Portuguese (Brazil)`, englishName: "Portuguese (Brazil)", dateInputFormat: "dd/mm/yyyy"}
+                // Add your new language here
+            ]
+        }
+
+    ``dateInputFormat`` is a special string that defines the behavior of the date input fields and absolutely needs to contain "dd", "mm" and "yyyy".
+
+3.  Import and register the Angular data for this locale in "src-ui/src/app/app.module.ts":
+
+    .. code:: typescript
+
+        import localeDe from '@angular/common/locales/de';
+        registerLocaleData(localeDe)
+
+Back end localization
+---------------------
+
+A majority of the strings that appear in the back end appear only when the admin is used. However,
+some of these are still shown on the front end (such as error messages).
+
+*   The django application does localization according to the `django documentation <https://docs.djangoproject.com/en/3.1/topics/i18n/translation/>`_.
+*   The source language of the project is "en_US".
+*   Localization files end up in the folder "src/locale/".
+*   In order to extract strings from the application, call ``python3 manage.py makemessages -l en_US``. This is important after making changes to translatable strings.
+*   The message files need to be compiled for them to show up in the application. Call ``python3 manage.py compilemessages`` to do this. The generated files don't get
+    committed into git, since these are derived artifacts. The build pipeline takes care of executing this command.
+
+Adding new languages requires adding the translated files in the "src/locale/" folder and adjusting the file "src/paperless/settings.py" to include the new language:
+
+.. code:: python
+
+    LANGUAGES = [
+        ("en-us", _("English (US)")),
+        ("en-gb", _("English (GB)")),
+        ("de", _("German")),
+        ("nl-nl", _("Dutch")),
+        ("fr", _("French")),
+        ("pt-br", _("Portuguese (Brazil)")),
+        # Add language here.
+    ]
+
+
 Building the documentation
 ==========================
 
@@ -133,6 +331,15 @@ this is how you do it:
 This will build the HTML documentation, and put the resulting files in the ``_build/html``
 directory.
 
+Building the Docker image
+=========================
+
+Building the docker image from source:
+
+    .. code:: shell-session
+
+        docker build . -t <your-tag>
+
 Extending Paperless
 ===================
 
@@ -167,7 +374,7 @@ methods ``parse`` and ``get_thumbnail``. You can provide your own implementation
 
             # The content of the document.
             self.text = "content"
-            
+
             # Optional: path to a PDF document that you created from the original.
             self.archive_path = os.path.join(self.tempdir, "archived.pdf")
 
@@ -213,3 +420,6 @@ that returns information about your parser:
     download. We could guess that from the file extensions, but some mime types have many extensions
     associated with them and the python methods responsible for guessing the extension do not always
     return the same value.
+
+.. _code of conduct: https://github.com/paperless-ngx/paperless-ngx/blob/main/CODE_OF_CONDUCT.md
+.. _contributing guidelines: https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md

docs/faq.rst

@@ -3,17 +3,13 @@
 Frequently asked questions
 **************************
 
-**Q:** *What's the general plan for Paperless-ng?*
+**Q:** *What's the general plan for Paperless-ngx?*
 
-**A:** Paperless-ng is already almost feature-complete. This project will remain
-as simple as it is right now. It will see improvements to features that are already there.
-If you need advanced features such as document versions,
-workflows or multi-user with customizable access to individual files, this is
-not the tool for you.
-
-Features that *are* planned are some more quality of life extensions for the searching
-(i.e., search for similar documents, group results by correspondents with "more from this"
-links, etc), bulk editing and hierarchical tags.
+**A:** While Paperless-ngx is already considered largely "feature-complete" it is a community-driven
+project and development will be guided in this way. New features can be submitted via
+GitHub discussions and "up-voted" by the community but this is not a garauntee the feature
+will be implemented. This project will always be open to collaboration in the form of PRs,
+ideas etc.
 
 **Q:** *I'm using docker. Where are my documents?*
 
@@ -33,19 +29,19 @@ is
     files around manually. This folder is meant to be entirely managed by docker
     and paperless.
 
-**Q:** *Let's say you don't support this project anymore in a year. Can I easily move to other systems?*
+**Q:** *Let's say I want to switch tools in a year. Can I easily move to other systems?*
 
 **A:** Your documents are stored as plain files inside the media folder. You can always drag those files
 out of that folder to use them elsewhere. Here are a couple notes about that.
 
-*   Paperless never modifies your original documents. It keeps checksums of all documents and uses a
+*   Paperless-ngx never modifies your original documents. It keeps checksums of all documents and uses a
     scheduled sanity checker to check that they remain the same.
 *   By default, paperless uses the internal ID of each document as its filename. This might not be very
     convenient for export. However, you can adjust the way files are stored in paperless by
     :ref:`configuring the filename format <advanced-file_name_handling>`.
 *   :ref:`The exporter <utilities-exporter>` is another easy way to get your files out of paperless with reasonable file names.
 
-**Q:** *What file types does paperless-ng support?*
+**Q:** *What file types does paperless-ngx support?*
 
 **A:** Currently, the following files are supported:
 
@@ -55,10 +51,10 @@ out of that folder to use them elsewhere. Here are a couple notes about that.
 *   With the optional Tika integration enabled (see :ref:`Configuration <configuration-tika>`), Paperless also supports various
     Office documents (.docx, .doc, odt, .ppt, .pptx, .odp, .xls, .xlsx, .ods).
 
-Paperless determines the type of a file by inspecting its content. The
+Paperless-ngx determines the type of a file by inspecting its content. The
 file extensions do not matter.
 
-**Q:** *Will paperless-ng run on Raspberry Pi?*
+**Q:** *Will paperless-ngx run on Raspberry Pi?*
 
 **A:** The short answer is yes. I've tested it on a Raspberry Pi 3 B.
 The long answer is that certain parts of
@@ -68,12 +64,12 @@ reuse the text. The web interface is a lot snappier, since it runs
 in your browser and paperless has to do much less work to serve the data.
 
 .. note::
-    
+
     You can adjust some of the settings so that paperless uses less processing
     power. See :ref:`setup-less_powerful_devices` for details.
-    
 
-**Q:** *How do I install paperless-ng on Raspberry Pi?*
+
+**Q:** *How do I install paperless-ngx on Raspberry Pi?*
 
 **A:** Docker images are available for arm and arm64 hardware, so just follow
 the docker-compose instructions. Apart from more required disk space compared to
@@ -85,11 +81,10 @@ python requirements do not have precompiled packages for ARM / ARM64. Installati
 of these will require additional development libraries and compilation will take
 a long time.
 
-**Q:** *How do I run this on unRaid?*
+**Q:** *How do I run this on Unraid?*
 
-**A:** Head over to `<https://github.com/selfhosters/unRAID-CA-templates>`_,
-`Uli Fahrer <https://github.com/Tooa>`_ created a container template for that.
-I don't exactly know how to use that though, since I don't use unRaid.
+**A:** Paperless-ngx is available as `community app <https://unraid.net/community/apps?q=paperless-ngx>`_
+in Unraid. `Uli Fahrer <https://github.com/Tooa>`_ created a container template for that.
 
 **Q:** *How do I run this on my toaster?*
 

docs/index.rst

@@ -22,19 +22,21 @@ finding stuff again. I feed documents right from the post box into the scanner
 and then shred them.  Perhaps you might find it useful too.
 
 
-Paperless-ng
-============
+Paperless-ngx
+=============
 
-Paperless-ng is a fork of the original paperless project. It changes many
-things both on the surface and under the hood. Paperless-ng was created
-because I feel that these changes are too big to be pushed into the main
-repository right away.
+Paperless-ngx is a document management system that transforms your physical
+documents into a searchable online archive so you can keep, well, *less paper*.
+
+Paperless-ngx forked from paperless-ng to continue the great work and
+distribute responsibility of supporting and advancing the project among a team
+of people.
 
 NG stands for both Angular (the framework used for the
 Frontend) and next-gen. Publishing this project under a different name also
-avoids confusion between paperless and paperless-ng.
+avoids confusion between paperless and paperless-ngx.
 
-If you want to learn about what's different in paperless-ng, check out these
+If you want to learn about what's different in paperless-ngx from Paperless, check out these
 resources in the documentation:
 
 *   :ref:`Some screenshots <screenshots>` of the new UI are available.
@@ -46,16 +48,12 @@ resources in the documentation:
     the consumption directory. This means that you can select text in
     image-only documents coming from your scanner.
 *   See :ref:`this note <utilities-encyption>` about GnuPG encryption in
-    paperless-ng.
+    paperless-ngx.
 *   Paperless is now integrated with a
     :ref:`task processing queue <setup-task_processor>` that tells you
-    at a glance when and why something is not working. 
+    at a glance when and why something is not working.
 *   The :ref:`changelog <paperless_changelog>` contains a detailed list of all changes
-    in paperless-ng.
-
-It would be great if this project could eventually merge back into the main
-repository, but it needs a lot more work before that can happen.
-
+    in paperless-ngx.
 
 Contents
 ========
@@ -72,7 +70,6 @@ Contents
    faq
    troubleshooting
    extending
-   contributing
    scanners
    screenshots
    changelog

docs/scanners.rst

@@ -13,60 +13,122 @@ that works right for you based on recommendations from other Paperless users.
 Physical scanners
 =================
 
-+---------+----------------+-----+-----+-----+----------------+
-| Brand   | Model          | Supports        | Recommended By |
-+---------+----------------+-----+-----+-----+----------------+
-|         |                | FTP | NFS | SMB |                |
-+=========+================+=====+=====+=====+================+
-| Brother | `ADS-1500W`_   | yes | no  | yes | `danielquinn`_ |
-+---------+----------------+-----+-----+-----+----------------+
-| Brother | `MFC-J6930DW`_ | yes |     |     | `ayounggun`_   |
-+---------+----------------+-----+-----+-----+----------------+
-| Brother | `MFC-J5910DW`_ | yes |     |     | `bmsleight`_   |
-+---------+----------------+-----+-----+-----+----------------+
-| Brother | `MFC-9142CDN`_ | yes |     | yes | `REOLDEV`_     |
-+---------+----------------+-----+-----+-----+----------------+
-| Fujitsu | `ix500`_       | yes |     | yes | `eonist`_      |
-+---------+----------------+-----+-----+-----+----------------+
-| Epson   | `WF-7710DWF`_  | yes |     | yes | `Skylinar`_    |
-+---------+----------------+-----+-----+-----+----------------+
-| Fujitsu | `S1300i`_      | yes |     | yes | `jonaswinkler`_|
-+---------+----------------+-----+-----+-----+----------------+
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brand   | Model          | Supports                          | Recommended By |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+|         |                | FTP | NFS | SMB | SMTP | API [1]_ |                |
++=========+================+=====+=====+=====+======+==========+================+
+| Brother | `ADS-1700W`_   | yes |     | yes | yes  |          |`holzhannes`_   |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brother | `ADS-1600W`_   | yes |     | yes | yes  |          |`holzhannes`_   |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brother | `ADS-1500W`_   | yes |     | yes | yes  |          |`danielquinn`_  |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brother | `ADS-1100W`_   | yes |     |     |      |          |`ytzelf`_       |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brother | `ADS-2800W`_   | yes | yes |     | yes  | yes      |`philpagel`_    |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brother | `MFC-J6930DW`_ | yes |     |     |      |          |`ayounggun`_    |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brother | `MFC-L5850DW`_ | yes |     |     | yes  |          |`holzhannes`_   |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brother | `MFC-L2750DW`_ | yes |     | yes | yes  |          |`muued`_        |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brother | `MFC-J5910DW`_ | yes |     |     |      |          |`bmsleight`_    |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brother | `MFC-8950DW`_  | yes |     |     | yes  | yes      |`philpagel`_    |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Brother | `MFC-9142CDN`_ | yes |     | yes |      |          |`REOLDEV`_      |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Fujitsu | `ix500`_       | yes |     | yes |      |          |`eonist`_       |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Epson   | `ES-580W`_     | yes |     | yes | yes  |          |`fignew`_       |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Epson   | `WF-7710DWF`_  | yes |     | yes |      |          |`Skylinar`_     |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Fujitsu | `S1300i`_      | yes |     | yes |      |          |`jonaswinkler`_ |
++---------+----------------+-----+-----+-----+------+----------+----------------+
+| Doxie   | `Q2`_          |     |     |     |      | yes      |`Unkn0wnCat`_   |
++---------+----------------+-----+-----+-----+------+----------+----------------+
 
+.. _MFC-L5850DW: https://www.brother-usa.com/products/mfcl5850dw
+.. _MFC-L2750DW: https://www.brother.de/drucker/laserdrucker/mfc-l2750dw
+.. _ADS-1700W: https://www.brother-usa.com/products/ads1700w
+.. _ADS-1600W: https://www.brother-usa.com/products/ads1600w
 .. _ADS-1500W: https://www.brother.ca/en/p/ads1500w
+.. _ADS-1100W: https://support.brother.com/g/b/downloadtop.aspx?c=fr&lang=fr&prod=ads1100w_eu_as_cn
+.. _ADS-2800W: https://www.brother-usa.com/products/ads2800w
 .. _MFC-J6930DW: https://www.brother.ca/en/p/MFCJ6930DW
 .. _MFC-J5910DW: https://www.brother.co.uk/printers/inkjet-printers/mfcj5910dw
+.. _MFC-8950DW: https://www.brother-usa.com/products/mfc8950dw
 .. _MFC-9142CDN: https://www.brother.co.uk/printers/laser-printers/mfc9140cdn
-.. _ix500: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/
+.. _ES-580W: https://epson.com/Support/Scanners/ES-Series/Epson-WorkForce-ES-580W/s/SPT_B11B258201
 .. _WF-7710DWF: https://www.epson.de/en/products/printers/inkjet-printers/for-home/workforce-wf-7710dwf
+.. _ix500: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/
 .. _S1300i: https://www.fujitsu.com/global/products/computing/peripheral/scanners/soho/s1300i/
+.. _Q2: https://www.getdoxie.com/product/doxie-q/
 
-.. _danielquinn: https://github.com/danielquinn
 .. _ayounggun: https://github.com/ayounggun
 .. _bmsleight: https://github.com/bmsleight
+.. _danielquinn: https://github.com/danielquinn
 .. _eonist: https://github.com/eonist
+.. _fignew: https://github.com/fignew
+.. _holzhannes: https://github.com/holzhannes
+.. _jonaswinkler: https://github.com/jonaswinkler
 .. _REOLDEV: https://github.com/REOLDEV
 .. _Skylinar: https://github.com/Skylinar
-.. _jonaswinkler: https://github.com/jonaswinkler
+.. _ytzelf: https://github.com/ytzelf
+.. _Unkn0wnCat: https://github.com/Unkn0wnCat
+.. _muued: https://github.com/muued
+.. _philpagel: https://github.com/philpagel
+
+.. [1] Scanners with API Integration allow to push scanned documents directly to :ref:`Paperless API <api-file_uploads>`, sometimes referred to as Webhook or Document POST.
 
 Mobile phone software
 =====================
 
 You can use your phone to "scan" documents. The regular camera app will work, but may have too low contrast for OCR to work well. Apps specifically for scanning are recommended.
 
-+-------------------+----------------+-----+-----+-----+-------+--------+----------------+
-| Name              | OS             | Supports                         | Recommended By |
-+-------------------+----------------+-----+-----+-----+-------+--------+----------------+
-|                   |                | FTP | NFS | SMB | Email | WebDav |                |
-+===================+================+=====+=====+=====+=======+========+================+
-| `Office Lens`_    | Android        | ?   | ?   | ?   | ?     | ?      | `jonaswinkler`_|
-+-------------------+----------------+-----+-----+-----+-------+--------+----------------+
-| `Genius Scan`_    | Android        | yes | no  | yes | yes   | yes    | `hannahswain`_ |
-+-------------------+----------------+-----+-----+-----+-------+--------+----------------+
++-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+
+| Name                        | OS             | Supports                         | Recommended By   |
++-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+
+|                             |                | FTP | NFS | SMB | Email | WebDAV |                  |
++=============================+================+=====+=====+=====+=======+========+==================+
+| `Office Lens`_              | Android        | ?   | ?   | ?   | ?     | ?      | `jonaswinkler`_  |
++-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+
+| `Genius Scan`_              | Android        | yes | no  | yes | yes   | yes    | `hannahswain`_   |
++-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+
+| `OpenScan`_                 | Android        | no  | no  | no  | no    | no     | `benjaminfrank`_ |
++-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+
+| `OCR Scanner - QuickScan`_  | iOS            | no  | no  | no  | no    | yes    | `holzhannes`_    |
++-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+
 
-On Android, you can use these applications in combination with one of the :ref:`Paperless-ng compatible apps <usage-mobile_upload>` to "Share" the documents produced by these scanner apps with paperless.
+On Android, you can use these applications in combination with one of the :ref:`Paperless-ngx compatible apps <usage-mobile_upload>` to "Share" the documents produced by these scanner apps with paperless. On iOS, you can share the scanned documents via iOS-Sharing to other mail, WebDav or FTP apps.
 
 .. _Office Lens: https://play.google.com/store/apps/details?id=com.microsoft.office.officelens
 .. _Genius Scan: https://play.google.com/store/apps/details?id=com.thegrizzlylabs.geniusscan.free
+.. _OCR Scanner - QuickScan: https://apps.apple.com/us/app/quickscan-scanner-text-ocr/id1513790291
+.. _OpenScan: https://github.com/Ethereal-Developers-Inc/OpenScan
 
 .. _hannahswain: https://github.com/hannahswain
+.. _benjaminfrank: https://github.com/benjaminfrank
+
+API Scanning Setup
+==================
+
+This sections contains information on how to set up scanners to post directly to :ref:`Paperless API <api-file_uploads>`.
+
+Doxie Q2
+--------
+
+This part assumes your Doxie is connected to WiFi and you know its IP.
+
+1. Open your Doxie web UI by navigating to its IP address
+2. Navigate to Options -> Webhook
+3. Set the *URL* to ``https://[your-paperless-ngx-instance]/api/documents/post_document/``
+4. Set the *File Parameter Name* to ``document``
+5. Add the username and password to the respective fields (Consider creating a user just for your Doxie)
+6. Click *Submit* at the bottom of the page
+
+Congrats, you can now scan directly from your Doxie to your Paperless-ngx instance!
+

docs/screenshots.rst

@@ -4,7 +4,7 @@
 Screenshots
 ***********
 
-This is what paperless-ng looks like. You shouldn't use paperless to index
+This is what paperless-ngx looks like. You shouldn't use paperless to index
 research papers though, its a horrible tool for that job.
 
 The dashboard shows customizable views on your document and allows document uploads:
@@ -42,4 +42,3 @@ Mobile support in the future? This kinda works, however some layouts are still
 too wide.
 
 .. image:: _static/screenshots/mobile.png
-

docs/setup.rst

@@ -3,10 +3,10 @@
 Setup
 *****
 
-Overview of Paperless-ng
-########################
+Overview of Paperless-ngx
+#########################
 
-Compared to paperless, paperless-ng works a little different under the hood and has
+Compared to paperless, paperless-ngx works a little different under the hood and has
 more moving parts that work together. While this increases the complexity of
 the system, it also brings many benefits.
 
@@ -85,22 +85,16 @@ You can go multiple routes to setup and run Paperless:
 * :ref:`Pull the image from Docker Hub <setup-docker_hub>`
 * :ref:`Build the Docker image yourself <setup-docker_build>`
 * :ref:`Install Paperless directly on your system manually (bare metal) <setup-bare_metal>`
-* :ref:`Use ansible to install Paperless on your system automatically (bare metal) <setup-ansible>`
 
 The Docker routes are quick & easy. These are the recommended routes. This configures all the stuff
 from the above automatically so that it just works and uses sensible defaults for all configuration options.
-Here you find a cheat-sheet for docker beginners: `CLI Basics <https://sehn.tech/post/devops-with-docker/>`_
+Here you find a cheat-sheet for docker beginners: `CLI Basics <https://www.sehn.tech/refs/devops-with-docker/>`_
 
 The bare metal route is complicated to setup but makes it easier
 should you want to contribute some code back. You need to configure and
 run the above mentioned components yourself.
 
-The ansible route combines benefits of both options:
-the setup process is fully automated, reproducible and `idempotent <https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#Idempotency>`_,
-it includes the same sensible defaults, and it simultaneously provides the flexibility of a bare metal installation.
-
-.. _CLI Basics: https://sehn.tech/post/devops-with-docker/
-.. _idempotent: https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#Idempotency
+.. _CLI Basics: https://www.sehn.tech/refs/devops-with-docker/
 
 .. _setup-docker_script:
 
@@ -116,18 +110,16 @@ performs all the steps described in :ref:`setup-docker_hub` automatically.
 
     .. code:: shell-session
 
-        $ wget https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/install-paperless-ng.sh
-        $ chmod +x install-paperless-ng.sh
-        $ ./install-paperless-ng.sh
+        $ bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
 
 .. _setup-docker_hub:
 
 Install Paperless from Docker Hub
 =================================
 
-1.  Login with your user and create a folder in your home-directory `mkdir -v ~/paperless-ng` to have a place for your configuration files and consumption directory.
+1.  Login with your user and create a folder in your home-directory `mkdir -v ~/paperless-ngx` to have a place for your configuration files and consumption directory.
 
-2.  Go to the `/docker/compose directory on the project page <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`_
+2.  Go to the `/docker/compose directory on the project page <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`_
     and download one of the `docker-compose.*.yml` files, depending on which database backend you
     want to use. Rename this file to `docker-compose.yml`.
     If you want to enable optional support for Office documents, download a file with `-tika` in the file name.
@@ -173,6 +165,24 @@ Install Paperless from Docker Hub
 
     Don't change the part after the colon or paperless wont find your documents.
 
+    You may also need to change the default port that the webserver will use
+    from the default (8000):
+
+     .. code::
+
+        ports:
+          - 8000:8000
+
+    Replace the part BEFORE the colon with a port of your choice:
+
+     .. code::
+
+        ports:
+          - 8010:8000
+
+    Don't change the part after the colon or edit other lines that refer to
+    port 8000. Modifying the part before the colon will map requests on another
+    port to the webserver running on the default port.
 
 5.  Modify ``docker-compose.env``, following the comments in the file. The
     most important change is to set ``USERMAP_UID`` and ``USERMAP_GID``
@@ -228,7 +238,7 @@ Build the Docker image yourself
 
     .. code:: shell-session
 
-        git clone https://github.com/jonaswinkler/paperless-ng
+        git clone https://github.com/paperless-ngx/paperless-ngx
 
     The master branch always reflects the latest stable version.
 
@@ -241,7 +251,7 @@ Build the Docker image yourself
     .. code:: yaml
 
         webserver:
-            image: jonaswinkler/paperless-ng:latest
+            image: ghcr.io/paperless-ngx/paperless-ngx:latest
 
     and replace it with a line that instructs docker-compose to build the image from the current working directory instead:
 
@@ -250,9 +260,7 @@ Build the Docker image yourself
         webserver:
             build: .
 
-4.  Run the ``compile-frontend.sh`` script. This requires ``node`` and ``npm >= v15``.
-
-5.  Follow steps 3 to 8 of :ref:`setup-docker_hub`. When asked to run
+4.  Follow steps 3 to 8 of :ref:`setup-docker_hub`. When asked to run
     ``docker-compose pull`` to pull the image, do
 
     .. code:: shell-session
@@ -272,7 +280,7 @@ writing. Windows is not and will never be supported.
 
 1.  Install dependencies. Paperless requires the following packages.
 
-    *   ``python3`` 3.6, 3.7, 3.8, 3.9
+    *   ``python3`` 3.8, 3.9
     *   ``python3-pip``
     *   ``python3-dev``
 
@@ -284,6 +292,12 @@ writing. Windows is not and will never be supported.
     *   ``libmagic-dev`` for mime type detection
     *   ``mime-support`` for mime type detection
 
+    Use this list for your preferred package management:
+
+    .. code::
+
+        python3 python3-pip python3-dev imagemagick fonts-liberation optipng gnupg libpq-dev libmagic-dev mime-support
+
     These dependencies are required for OCRmyPDF, which is used for text recognition.
 
     *   ``unpaper``
@@ -297,6 +311,12 @@ writing. Windows is not and will never be supported.
     *   ``tesseract-ocr`` >= 4.0.0 for OCR
     *   ``tesseract-ocr`` language packs (``tesseract-ocr-eng``, ``tesseract-ocr-deu``, etc)
 
+    Use this list for your preferred package management:
+
+    .. code::
+
+        unpaper ghostscript icc-profiles-free qpdf liblept5 libxml2 pngquant zlib1g tesseract-ocr
+
     On Raspberry Pi, these libraries are required as well:
 
     *   ``libatlas-base-dev``
@@ -310,7 +330,7 @@ writing. Windows is not and will never be supported.
 3.  Optional. Install ``postgresql`` and configure a database, user and password for paperless. If you do not wish
     to use PostgreSQL, SQLite is available as well.
 
-4.  Get the release archive from `<https://github.com/jonaswinkler/paperless-ng/releases>`_.
+4.  Get the release archive from `<https://github.com/paperless-ngx/paperless-ngx/releases>`_.
     If you clone the git repo as it is, you also have to compile the front end by yourself.
     Extract the archive to a place from where you wish to execute it, such as ``/opt/paperless``.
 
@@ -348,7 +368,11 @@ writing. Windows is not and will never be supported.
     Adjust as necessary if you configured different folders.
 
 8.  Install python requirements from the ``requirements.txt`` file.
-    It is up to you if you wish to use a virtual environment or not.
+    It is up to you if you wish to use a virtual environment or not. First you should update your pip, so it gets the actual packages.
+
+    .. code:: shell-session
+
+        sudo -Hu paperless pip3 install --upgrade pip
 
     .. code:: shell-session
 
@@ -395,6 +419,10 @@ writing. Windows is not and will never be supported.
     ``consumer`` script to watch the input folder, and the ``scheduler``
     script to run tasks such as email checking and document consumption.
 
+		The ``socket`` script enables ``gunicorn`` to run on port 80 without
+		root privileges. For this you need to uncomment the ``Require=paperless-webserver.socket``
+		in the ``webserver`` script and configure ``gunicorn`` to listen on port 80 (see ``paperless/gunicorn.conf.py``).
+
     You may need to adjust the path to the ``gunicorn`` executable. This
     will be installed as part of the python dependencies, and is either located
     in the ``bin`` folder of your virtual environment, or in ``~/.local/bin/`` if
@@ -440,126 +468,41 @@ 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.
 
-.. _setup-ansible:
+Migrating to Paperless-ngx
+##########################
 
-Install Paperless using ansible
-===============================
+Migration is possible both from Paperless-ng or directly from the 'original' Paperless.
 
-.. note::
+Migrating from Paperless-ng
+===========================
 
-    This role currently only supports Debian 10 Buster and Ubuntu 20.04 Focal or later as target hosts.
+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:
 
-1.  Install ansible 2.7+ on the management node.
-    This may be the target host paperless-ng is being installed on or any remote host which can access the target host.
-    For further details, check the ansible `inventory <https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html>`_ documentation.
+.. code::
 
-    On Debian and Ubuntu, the official repositories should provide a suitable version:
+  image: jonaswinkler/paperless-ng:latest
 
-    .. code:: bash
+to
 
-        apt install ansible
-        ansible --version
+.. code::
 
-    Alternatively, you can install the most recent ansible release using PyPI:
+  image: ghcr.io/paperless-ngx/paperless-ngx:latest
 
-    .. code:: bash
+and then run ``docker-compose up -d`` which will pull the new image recreate the container.
+That's it!
 
-        python3 -m pip install ansible
-        ansible --version
+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.
 
-    Make sure your taget hosts are accessible:
+Migrating from Paperless
+========================
 
-    .. code:: sh
-
-        ansible -m ping YourAnsibleTargetHostGoesHere
-
-2.  Clone the repository of paperless-ng:
-
-    .. code:: sh
-
-        git clone https://github.com/jonaswinkler/paperless-ng
-
-    Checkout the latest release tag:
-
-    .. code:: sh
-
-        cd paperless-ng
-        git checkout ng-1.0.0
-
-3.  Create an ansible ``playbook.yml`` in the paperless-ng root directory:
-
-    .. code:: yaml
-
-        - hosts: YourAnsibleTargetHostGoesHere
-          become: yes
-          vars_files:
-            - ansible/vars.yml
-          roles:
-            - ansible
-
-    Optional: If you also want to use PostgreSQL on the target system, install and add (for example) the `geerlingguy.postgresql <https://github.com/geerlingguy/ansible-role-postgresql>`_ role:
-
-    .. code:: sh
-
-        ansible-galaxy install geerlingguy.postgresql
-
-    .. code:: yaml
-
-        - hosts: YourAnsibleTargetHostGoesHere
-          become: yes
-          vars_files:
-            - ansible/vars.yml
-          roles:
-            - geerlingguy.postgresql
-            - ansible
-
-    Optional: If you also want to use a reverse proxy on the target system, install and add (for example) the `geerlingguy.nginx <https://github.com/geerlingguy/ansible-role-nginx>`_ role:
-
-    .. code:: sh
-
-        ansible-galaxy install geerlingguy.nginx
-
-    .. code:: yaml
-
-        - hosts: YourAnsibleTargetHostGoesHere
-          become: yes
-          vars_files:
-            - ansible/vars.yml
-          roles:
-            - geerlingguy.postgresql
-            - ansible
-            - geerlingguy.nginx
-
-4.  Create ``ansible/vars.yml`` to configure your ansible deployment:
-
-    .. code:: yaml
-
-        paperlessng_secret_key: PleaseGenerateAStrongKeyForThis
-
-        paperlessng_superuser_name: YourUserName
-        paperlessng_superuser_email: name@domain.tld
-        paperlessng_superuser_password: YourDesiredPasswordUsedForFirstLogin
-
-        paperlessng_ocr_languages:
-            - eng
-            - deu
-
-    For all of the available options, please check ``ansible/README.md`` and :ref:`configuration`.
-
-    Optional configurations for the above-mentioned PostgreSQL and nginx roles would also go here.
-
-5. Run the ansible playbook from the management node:
-
-    .. code:: sh
-
-        ansible-playbook playbook.yml
-
-    When this step completes successfully, paperless-ng will be available on the target host at ``http://127.0.0.1:8000`` (or the address you configured).
-
-Migration to paperless-ng
-#########################
-
-At its core, paperless-ng is still paperless and fully compatible. However, some
+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
 how you installed paperless.
 
@@ -575,10 +518,10 @@ The important things to keep in mind are as follows:
   such as email checking and maintenance, requires a `redis`_ message broker
   instance. The docker-compose route takes care of that.
 * The layout of the folder structure for your documents and data remains the
-  same, so you can just plug your old docker volumes into paperless-ng and
+  same, so you can just plug your old docker volumes into paperless-ngx and
   expect it to find everything where it should be.
 
-Migration to paperless-ng is then performed in a few simple steps:
+Migration to paperless-ngx is then performed in a few simple steps:
 
 1.  Stop paperless.
 
@@ -588,20 +531,20 @@ Migration to paperless-ng is then performed in a few simple steps:
         $ docker-compose down
 
 2.  Do a backup for two purposes: If something goes wrong, you still have your
-    data. Second, if you don't like paperless-ng, you can switch back to
+    data. Second, if you don't like paperless-ngx, you can switch back to
     paperless.
 
-3.  Download the latest release of paperless-ng. You can either go with the
-    docker-compose files from `here <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`__
+3.  Download the latest release of paperless-ngx. You can either go with the
+    docker-compose files from `here <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`__
     or clone the repository to build the image yourself (see :ref:`above <setup-docker_build>`).
-    You can either replace your current paperless folder or put paperless-ng
+    You can either replace your current paperless folder or put paperless-ngx
     in a different location.
 
     .. caution::
 
-        Paperless-ng includes a ``.env`` file. This will set the
+        Paperless-ngx includes a ``.env`` file. This will set the
         project name for docker compose to ``paperless``, which will also define the name
-        of the volumes by paperless-ng. However, if you experience that paperless-ng
+        of the volumes by paperless-ngx. However, if you experience that paperless-ngx
         is not using your old paperless volumes, verify the names of your volumes with
 
         .. code:: shell-session
@@ -631,7 +574,7 @@ Migration to paperless-ng is then performed in a few simple steps:
     This will migrate your database and create the search index. After that,
     paperless will take care of maintaining the index by itself.
 
-8.  Start paperless-ng.
+8.  Start paperless-ngx.
 
     .. code:: bash
 
@@ -722,14 +665,14 @@ management commands as below.
 7.  Start paperless.
 
 
-Moving back to paperless
+Moving back to Paperless
 ========================
 
-Lets say you migrated to Paperless-ng and used it for a while, but decided that
+Lets say you migrated to Paperless-ngx and used it for a while, but decided that
 you don't like it and want to move back (If you do, send me a mail about what
 part you didn't like!), you can totally do that with a few simple steps.
 
-Paperless-ng modified the database schema slightly, however, these changes can
+Paperless-ngx modified the database schema slightly, however, these changes can
 be reverted while keeping your current data, so that your current data will
 be compatible with original Paperless.
 
@@ -747,7 +690,7 @@ Or without docker:
     $ cd /path/to/paperless/src
     $ python3 manage.py migrate documents 0023
 
-After that, you need to clear your cookies (Paperless-ng comes with updated
+After that, you need to clear your cookies (Paperless-ngx comes with updated
 dependencies that do cookie-processing differently) and probably your cache
 as well.
 
@@ -774,13 +717,15 @@ configuring some options in paperless can help improve performance immensely:
     your documents before feeding them into paperless. Some scanners are able to
     do this! You might want to even specify ``skip_noarchive`` to skip archive
     file generation for already ocr'ed documents entirely.
-*   If you want to perform OCR on the the device, consider using ``PAPERLESS_OCR_CLEAN=none``.
+*   If you want to perform OCR on the device, consider using ``PAPERLESS_OCR_CLEAN=none``.
     This will speed up OCR times and use less memory at the expense of slightly worse
     OCR results.
 *   Set ``PAPERLESS_OPTIMIZE_THUMBNAILS`` to 'false' if you want faster consumption
     times. Thumbnails will be about 20% larger.
 *   If using docker, consider setting ``PAPERLESS_WEBSERVER_WORKERS`` to
     1. This will save some memory.
+*   Use the arm compatible docker-compose if you're wanting to use Tika on something like
+		a raspberry pi. The official apache/tika image does not support the arm architecture.
 
 For details, refer to :ref:`configuration`.
 

docs/troubleshooting.rst

@@ -25,6 +25,19 @@ Check for the following issues:
 *   Go to the admin interface, and check if there are failed tasks. If so, the
     tasks will contain an error message.
 
+Consumer warns ``OCR for XX failed``
+####################################
+
+If you find the OCR accuracy to be too low, and/or the document consumer warns
+that ``OCR for XX failed, but we're going to stick with what we've got since
+FORGIVING_OCR is enabled``, then you might need to install the
+`Tesseract language files <http://packages.ubuntu.com/search?keywords=tesseract-ocr>`_
+marching your document's languages.
+
+As an example, if you are running Paperless-ngx from any Ubuntu or Debian
+box, and your documents are written in Spanish you may need to run::
+
+    apt-get install -y tesseract-ocr-spa
 
 Consumer fails to pickup any new files
 ######################################
@@ -81,7 +94,7 @@ UserWarning in sklearn on every single document
 You may encounter warnings like this:
 
 .. code::
-    
+
     /usr/local/lib/python3.7/site-packages/sklearn/base.py:315:
     UserWarning: Trying to unpickle estimator CountVectorizer from version 0.23.2 when using version 0.24.0.
     This might lead to breaking code or invalid results. Use at your own risk.
@@ -101,22 +114,23 @@ You may experience these errors when using the optional TIKA integration:
 
 .. code::
 
-    requests.exceptions.HTTPError: 504 Server Error: Gateway Timeout for url: http://gotenberg:3000/convert/office
+    requests.exceptions.HTTPError: 504 Server Error: Gateway Timeout for url: http://gotenberg:3000/forms/libreoffice/convert
 
-Gotenberg is a server that converts Office documents into PDF documents and has a default timeout of 10 seconds.
+Gotenberg is a server that converts Office documents into PDF documents and has a default timeout of 30 seconds.
 When conversion takes longer, Gotenberg raises this error.
 
-You can increase the timeout by configuring an environment variable for gotenberg (see also `here <https://thecodingmachine.github.io/gotenberg/#environment_variables.default_wait_timeout>`__).
+You can increase the timeout by configuring a command flag for Gotenberg (see also `here <https://gotenberg.dev/docs/modules/api#properties>`__).
 If using docker-compose, this is achieved by the following configuration change in the ``docker-compose.yml`` file:
 
 .. code:: yaml
 
     gotenberg:
-        image: thecodingmachine/gotenberg
+        image: gotenberg/gotenberg:7
         restart: unless-stopped
-        environment:
-            DISABLE_GOOGLE_CHROME: 1
-            DEFAULT_WAIT_TIMEOUT: 30
+        command:
+            - "gotenberg"
+            - "--chromium-disable-routes=true"
+            - "--api-timeout=60"
 
 Permission denied errors in the consumption directory
 #####################################################
@@ -200,11 +214,24 @@ This might have multiple reasons.
         File "/usr/local/lib/python3.7/site-packages/gunicorn/http/wsgi.py", line 386, in sendfile
             sent += os.sendfile(sockno, fileno, offset + sent, count)
         OSError: [Errno 22] Invalid argument
-    
+
     To fix this issue, add
 
     .. code::
 
         SENDFILE=0
-    
+
     to your `docker-compose.env` file.
+
+Error while reading metadata
+############################
+
+You might find messages like these in your log files:
+
+.. code::
+
+    [WARNING] [paperless.parsing.tesseract] Error while reading metadata
+
+This indicates that paperless failed to read PDF metadata from one of your documents. This happens when you
+open the affected documents in paperless for editing. Paperless will continue to work, and will simply not
+show the invalid metadata.

docs/usage_overview.rst

@@ -24,7 +24,7 @@ Each document has a couple of fields that you can assign to them:
 * A *Document* is a piece of paper that sometimes contains valuable
   information.
 * The *correspondent* of a document is the person, institution or company that
-  a document either originates form, or is sent to.
+  a document either originates from, or is sent to.
 * A *tag* is a label that you can assign to documents. Think of labels as more
   powerful folders: Multiple documents can be grouped together with a single
   tag, however, a single document can also have multiple tags. This is not
@@ -71,7 +71,7 @@ your documents:
 
     This process can be configured to fit your needs. If you don't want paperless
     to create archived versions for digital documents, you can configure that by
-    configuring ``PAPERLESS_OCR_MODE=skip_noarchive``. Please read the 
+    configuring ``PAPERLESS_OCR_MODE=skip_noarchive``. Please read the
     :ref:`relevant section in the documentation <configuration-ocr>`.
 
 .. note::
@@ -86,10 +86,9 @@ The consumption directory
 =========================
 
 The primary method of getting documents into your database is by putting them in
-the consumption directory.  The consumer runs in an infinite
-loop looking for new additions to this directory and when it finds them, it goes
-about the process of parsing them with the OCR, indexing what it finds, and storing
-it in the media directory.
+the consumption directory.  The consumer runs in an infinite loop, looking for new
+additions to this directory. When it finds them, the consumer goes about the process
+of parsing them with the OCR, indexing what it finds, and storing it in the media directory.
 
 Getting stuff into this directory is up to you.  If you're running Paperless
 on your local computer, you might just want to drag and drop files there, but if
@@ -127,7 +126,7 @@ which not only has document upload, but also document browsing and download feat
 IMAP (Email)
 ============
 
-You can tell paperless-ng to consume documents from your email accounts.
+You can tell paperless-ngx to consume documents from your email accounts.
 This is a very flexible and powerful feature, if you regularly received documents
 via mail that you need to archive. The mail consumer can be configured by using the
 admin interface in the following manner:
@@ -255,6 +254,8 @@ Here are a couple examples of tags and types that you could use in your collecti
 * A tag ``missing_metadata`` when you still need to add some metadata to a document, but can't
   or don't want to do this right now.
 
+.. _basic-usage_searching:
+
 Searching
 #########
 
@@ -287,7 +288,7 @@ Matching specific tags, correspondents or types:
 Matching dates:
 
 .. code::
-  
+
   created:[2005 to 2009]
   added:yesterday
   modified:today
@@ -304,11 +305,11 @@ Matching inexact words:
   auto complete and query correction.
 
 All of these constructs can be combined as you see fit.
-If you want to learn more about the query language used by paperless, paperless uses Whoosh's default query language. 
+If you want to learn more about the query language used by paperless, paperless uses Whoosh's default query language.
 Head over to `Whoosh query language <https://whoosh.readthedocs.io/en/latest/querylang.html>`_.
 For details on what date parsing utilities are available, see
 `Date parsing <https://whoosh.readthedocs.io/en/latest/dates.html#parsing-date-queries>`_.
- 
+
 
 .. _usage-recommended_workflow:
 
@@ -383,7 +384,7 @@ Once you have scanned in a document, proceed in paperless as follows.
 6.  Remove inbox tags from the documents.
 
 .. hint::
-    
+
     You can setup manual matching rules for your correspondents and tags and
     paperless will assign them automatically. After consuming a couple documents,
     you can even ask paperless to *learn* when to assign tags and correspondents
@@ -394,7 +395,7 @@ Task management
 
 Some documents require attention and require you to act on the document. You
 may take two different approaches to handle these documents based on how
-regularly you intent to use paperless and scan documents.
+regularly you intend to scan documents and use paperless.
 
 * If you scan and process your documents in paperless regularly, assign a
   TODO tag to all scanned documents that you need to process. Create a saved

gunicorn.conf.py

@@ -1,36 +1,39 @@
 import os
 
-bind = '0.0.0.0:8000'
+bind = f'0.0.0.0:{os.getenv("PAPERLESS_PORT", 8000)}'
 workers = int(os.getenv("PAPERLESS_WEBSERVER_WORKERS", 2))
-worker_class = 'uvicorn.workers.UvicornWorker'
+worker_class = "paperless.workers.ConfigurableWorker"
 timeout = 120
 
+
 def pre_fork(server, worker):
     pass
 
+
 def pre_exec(server):
     server.log.info("Forked child, re-executing.")
 
+
 def when_ready(server):
     server.log.info("Server is ready. Spawning workers")
 
+
 def worker_int(worker):
     worker.log.info("worker received INT or QUIT signal")
 
     ## get traceback info
     import threading, sys, traceback
+
     id2name = dict([(th.ident, th.name) for th in threading.enumerate()])
     code = []
     for threadId, stack in sys._current_frames().items():
-        code.append("\n# Thread: %s(%d)" % (id2name.get(threadId,""),
-            threadId))
+        code.append("\n# Thread: %s(%d)" % (id2name.get(threadId, ""), threadId))
         for filename, lineno, name, line in traceback.extract_stack(stack):
-            code.append('File: "%s", line %d, in %s' % (filename,
-                lineno, name))
+            code.append('File: "%s", line %d, in %s' % (filename, lineno, name))
             if line:
                 code.append("  %s" % (line.strip()))
     worker.log.debug("\n".join(code))
 
+
 def worker_abort(worker):
     worker.log.info("worker received SIGABRT signal")
-

install-paperless-ngx.sh

@@ -1,20 +1,18 @@
 #!/bin/bash
 
-set -e
-
 ask() {
 	while true ; do
 		if [[ -z $3 ]] ; then
-			read -p "$1 [$2]: " result
+			read -r -p "$1 [$2]: " result
 		else
-			read -p "$1 ($3) [$2]: " result
+			read -r -p "$1 ($3) [$2]: " result
 		fi
 		if [[ -z $result ]]; then
 			ask_result=$2
 			return
 		fi
 		array=$3
-		if [[ -z $3 || " ${array[@]} " =~ " ${result} " ]]; then
+		if [[ -z $3 || " ${array[*]} " =~ ${result} ]]; then
 			ask_result=$result
 			return
 		else
@@ -26,7 +24,7 @@ ask() {
 ask_docker_folder() {
 	while true ; do
 
-		read -p "$1 [$2]: " result
+		read -r -p "$1 [$2]: " result
 
 		if [[ -z $result ]]; then
 			ask_result=$2
@@ -64,15 +62,93 @@ if [[ -z $(which docker-compose) ]] ; then
 	exit 1
 fi
 
-echo ""
-echo "############################################"
-echo "###   Paperless-ng docker installation   ###"
-echo "############################################"
-echo ""
-echo "This script will download, configure and start paperless-ng."
+# Check if user has permissions to run Docker by trying to get the status of Docker (docker status).
+# If this fails, the user probably does not have permissions for Docker.
+if [ ! "$(docker stats --no-stream 2>/dev/null 1>&2)" ] ; then
+	echo ""
+	echo "WARN: It look like the current user does not have Docker permissions."
+	echo "WARN: Use 'sudo usermod -aG docker $USER' to assign Docker permissions to the user."
+	echo ""
+	sleep 3
+fi
+
+default_time_zone=$(timedatectl show -p Timezone --value)
+
+set -e
 
 echo ""
-echo "1. Folder configuration"
+echo "#############################################"
+echo "###   paperless-ngx docker installation   ###"
+echo "#############################################"
+echo ""
+echo "This script will download, configure and start paperless-ngx."
+
+echo ""
+echo "1. Application configuration"
+echo "============================"
+
+echo ""
+echo "The port on which the paperless webserver will listen for incoming"
+echo "connections."
+echo ""
+
+ask "Port" "8000"
+PORT=$ask_result
+
+echo ""
+echo "Paperless requires you to configure the current time zone correctly."
+echo "Otherwise, the dates of your documents may appear off by one day,"
+echo "depending on where you are on earth."
+echo ""
+
+ask "Current time zone" "$default_time_zone"
+TIME_ZONE=$ask_result
+
+echo ""
+echo "Database backend: PostgreSQL and SQLite are available. Use PostgreSQL"
+echo "if unsure. If you're running on a low-power device such as Raspberry"
+echo "Pi, use SQLite to save resources."
+echo ""
+
+ask "Database backend" "postgres" "postgres sqlite"
+DATABASE_BACKEND=$ask_result
+
+echo ""
+echo "Paperless is able to use Apache Tika to support Office documents such as"
+echo "Word, Excel, Powerpoint, and Libreoffice equivalents. This feature"
+echo "requires more resources due to the required services."
+echo ""
+
+ask "Enable Apache Tika?" "no" "yes no"
+TIKA_ENABLED=$ask_result
+
+echo ""
+echo "Specify the default language that most of your documents are written in."
+echo "Use ISO 639-2, (T) variant language codes: "
+echo "https://www.loc.gov/standards/iso639-2/php/code_list.php"
+echo "Common values: eng (English) deu (German) nld (Dutch) fra (French)"
+echo "This can be a combination of multiple languages such as deu+eng"
+echo ""
+
+ask "OCR language" "eng"
+OCR_LANGUAGE=$ask_result
+
+echo ""
+echo "Specify the user id and group id you wish to run paperless as."
+echo "Paperless will also change ownership on the data, media and consume"
+echo "folder to the specified values, so it's a good idea to supply the user id"
+echo "and group id of your unix user account."
+echo "If unsure, leave default."
+echo ""
+
+ask "User ID" "$(id -u)"
+USERMAP_UID=$ask_result
+
+ask "Group ID" "$(id -g)"
+USERMAP_GID=$ask_result
+
+echo ""
+echo "2. Folder configuration"
 echo "======================="
 echo ""
 echo "The target folder is used to store the configuration files of "
@@ -81,11 +157,11 @@ echo "You will need this folder whenever you want to start, stop, update or "
 echo "maintain your paperless instance."
 echo ""
 
-ask "Target folder" "$(pwd)/paperless-ng"
+ask "Target folder" "$(pwd)/paperless-ngx"
 TARGET_FOLDER=$ask_result
 
 echo ""
-echo "The consume folder is where paperles will search for new documents."
+echo "The consume folder is where paperless will search for new documents."
 echo "Point this to a folder where your scanner is able to put your scanned"
 echo "documents."
 echo ""
@@ -112,7 +188,10 @@ MEDIA_FOLDER=$ask_result
 
 echo ""
 echo "The data folder is where paperless stores other data, such as your"
-echo "SQLite database (if used), the search index and other data."
+if [[ "$DATABASE_BACKEND" == "sqlite" ]] ; then
+	echo -n "SQLite database, the "
+fi
+echo "search index and other data."
 echo "As with the media folder, leave empty to have this managed by docker."
 echo ""
 echo "CAUTION: If specified, you must specify an absolute path starting with /"
@@ -122,59 +201,18 @@ echo ""
 ask_docker_folder "Data folder" ""
 DATA_FOLDER=$ask_result
 
-echo ""
-echo "2. Application configuration"
-echo "============================"
+if [[ "$DATABASE_BACKEND" == "postgres" ]] ; then
+	echo ""
+	echo "The database folder, where postgres stores its data."
+	echo "Leave empty to have this managed by docker."
+	echo ""
+	echo "CAUTION: If specified, you must specify an absolute path starting with /"
+	echo "or a relative path starting with ./ here."
+	echo ""
 
-echo ""
-echo "The port on which the paperless webserver will listen for incoming"
-echo "connections."
-echo ""
-
-ask "Port" "8000"
-PORT=$ask_result
-
-echo ""
-echo "Database backend: PostgreSQL and SQLite are available. Use PostgreSQL"
-echo "if unsure. If you're running on a low-power device such as Raspberry"
-echo "Pi, use SQLite to save resources."
-echo ""
-
-ask "Database backend" "postgres" "postgres sqlite"
-DATABASE_BACKEND=$ask_result
-
-echo ""
-echo "Paperless is able to use Apache Tika to support Office documents such as"
-echo "Word, Excel, Powerpoint, and Libreoffice equivalents. This feature"
-echo "requires more resources due to the required services."
-echo ""
-
-ask "Enable Apache Tika?" "no" "yes no"
-TIKA_ENABLED=$ask_result
-
-echo ""
-echo "Specify the default language that most of your documents are written in."
-echo "Use ISO 639-2, (T) variant language codes: "
-echo "https://www.loc.gov/standards/iso639-2/php/code_list.php"
-echo "Common values: eng (English) deu (German) nld (Dutch) fra (French)"
-echo ""
-
-ask "OCR language" "eng"
-OCR_LANGUAGE=$ask_result
-
-echo ""
-echo "Specify the user id and group id you wish to run paperless as."
-echo "Paperless will also change ownership on the data, media and consume"
-echo "folder to the specified values, so it's a good idea to supply the user id"
-echo "and group id of your unix user account."
-echo "If unsure, leave default."
-echo ""
-
-ask "User ID" "$(id -u)"
-USERMAP_UID=$ask_result
-
-ask "Group ID" "$(id -g)"
-USERMAP_GID=$ask_result
+	ask_docker_folder "Database folder" ""
+	POSTGRES_FOLDER=$ask_result
+fi
 
 echo ""
 echo "3. Login credentials"
@@ -189,7 +227,7 @@ ask "Paperless username" "$(whoami)"
 USERNAME=$ask_result
 
 while true; do
-	read -sp "Paperless password: " PASSWORD
+	read -r -sp "Paperless password: " PASSWORD
 	echo ""
 
 	if [[ -z $PASSWORD ]] ; then
@@ -197,7 +235,7 @@ while true; do
 		continue
 	fi
 
-	read -sp "Paperless password (again): " PASSWORD_REPEAT
+	read -r -sp "Paperless password (again): " PASSWORD_REPEAT
 	echo ""
 
 	if [[ ! "$PASSWORD" == "$PASSWORD_REPEAT" ]] ; then
@@ -227,6 +265,13 @@ if [[ -z $DATA_FOLDER ]] ; then
 else
 	echo "Data folder: $DATA_FOLDER"
 fi
+if [[ "$DATABASE_BACKEND" == "postgres" ]] ; then
+	if [[ -z $POSTGRES_FOLDER ]] ; then
+		echo "Database (postgres) folder: Managed by docker"
+	else
+		echo "Database (postgres) folder: $POSTGRES_FOLDER"
+	fi
+fi
 echo ""
 echo "Port: $PORT"
 echo "Database: $DATABASE_BACKEND"
@@ -239,7 +284,7 @@ echo "Paperless username: $USERNAME"
 echo "Paperless email: $EMAIL"
 
 echo ""
-read -p "Press any key to install."
+read -r -p "Press any key to install."
 
 echo ""
 echo "Installing paperless..."
@@ -255,10 +300,10 @@ if [[ $TIKA_ENABLED == "yes" ]] ; then
 	DOCKER_COMPOSE_VERSION="$DOCKER_COMPOSE_VERSION-tika"
 fi
 
-wget "https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/docker/compose/docker-compose.$DOCKER_COMPOSE_VERSION.yml" -O docker-compose.yml
-wget "https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/docker/compose/.env" -O .env
+wget "https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docker/compose/docker-compose.$DOCKER_COMPOSE_VERSION.yml" -O docker-compose.yml
+wget "https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docker/compose/.env" -O .env
 
-SECRET_KEY=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 64 | head -n 1)
+SECRET_KEY=$(tr -dc 'a-zA-Z0-9' < /dev/urandom | fold -w 64 | head -n 1)
 
 DEFAULT_LANGUAGES="deu eng fra ita spa"
 
@@ -269,9 +314,10 @@ DEFAULT_LANGUAGES="deu eng fra ita spa"
 	if [[ ! $USERMAP_GID == "1000" ]] ; then
 		echo "USERMAP_GID=$USERMAP_GID"
 	fi
+	echo "PAPERLESS_TIME_ZONE=$TIME_ZONE"
 	echo "PAPERLESS_OCR_LANGUAGE=$OCR_LANGUAGE"
 	echo "PAPERLESS_SECRET_KEY=$SECRET_KEY"
-	if [[ ! " ${DEFAULT_LANGUAGES[@]} " =~ " ${OCR_LANGUAGE} " ]] ; then
+	if [[ ! " ${DEFAULT_LANGUAGES[*]} " =~ ${OCR_LANGUAGE} ]] ; then
 		echo "PAPERLESS_OCR_LANGUAGES=$OCR_LANGUAGE"
 	fi
 } > docker-compose.env
@@ -282,12 +328,29 @@ sed -i "s#- \./consume:/usr/src/paperless/consume#- $CONSUME_FOLDER:/usr/src/pap
 
 if [[ -n $MEDIA_FOLDER ]] ; then
 	sed -i "s#- media:/usr/src/paperless/media#- $MEDIA_FOLDER:/usr/src/paperless/media#g" docker-compose.yml
+	sed -i "/^\s*media:/d" docker-compose.yml
 fi
 
 if [[ -n $DATA_FOLDER ]] ; then
 	sed -i "s#- data:/usr/src/paperless/data#- $DATA_FOLDER:/usr/src/paperless/data#g" docker-compose.yml
+	sed -i "/^\s*data:/d" docker-compose.yml
 fi
 
+if [[ -n $POSTGRES_FOLDER ]] ; then
+	sed -i "s#- pgdata:/var/lib/postgresql/data#- $POSTGRES_FOLDER:/var/lib/postgresql/data#g" docker-compose.yml
+	sed -i "/^\s*pgdata:/d" docker-compose.yml
+fi
+
+# remove trailing blank lines from end of file
+sed -i -e :a -e '/^\n*$/{$d;N;};/\n$/ba' docker-compose.yml
+# if last line in file contains "volumes:", remove that line since no more named volumes are left
+l1=$(grep -n '^volumes:' docker-compose.yml | cut -d : -f 1)  # get line number containing volume: at begin of line
+l2=$(wc -l < docker-compose.yml)  # get total number of lines
+if [ "$l1" -eq "$l2" ] ; then
+	sed -i "/^volumes:/d" docker-compose.yml
+fi
+
+
 docker-compose pull
 
 docker-compose run --rm -e DJANGO_SUPERUSER_PASSWORD="$PASSWORD" webserver createsuperuser --noinput --username "$USERNAME" --email "$EMAIL"

paperless.conf.example

@@ -1,5 +1,5 @@
 # Have a look at the docs for documentation.
-# https://paperless-ng.readthedocs.io/en/latest/configuration.html
+# https://paperless-ngx.readthedocs.io/en/latest/configuration.html
 
 # Debug. Only enable this for development.
 
@@ -19,6 +19,7 @@
 
 #PAPERLESS_CONSUMPTION_DIR=../consume
 #PAPERLESS_DATA_DIR=../data
+#PAPERLESS_TRASH_DIR=
 #PAPERLESS_MEDIA_ROOT=../media
 #PAPERLESS_STATICDIR=../static
 #PAPERLESS_FILENAME_FORMAT=
@@ -57,8 +58,10 @@
 #PAPERLESS_CONSUMER_POLLING=10
 #PAPERLESS_CONSUMER_DELETE_DUPLICATES=false
 #PAPERLESS_CONSUMER_RECURSIVE=false
+#PAPERLESS_CONSUMER_IGNORE_PATTERNS=[".DS_STORE/*", "._*", ".stfolder/*"]
 #PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS=false
 #PAPERLESS_OPTIMIZE_THUMBNAILS=true
+#PAPERLESS_PRE_CONSUME_SCRIPT=/path/to/an/arbitrary/script.sh
 #PAPERLESS_POST_CONSUME_SCRIPT=/path/to/an/arbitrary/script.sh
 #PAPERLESS_FILENAME_DATE_ORDER=YMD
 #PAPERLESS_FILENAME_PARSE_TRANSFORMS=[]

requirements.txt

@@ -8,94 +8,104 @@
 -i https://pypi.python.org/simple
 --extra-index-url https://www.piwheels.org/simple
 aioredis==1.3.1
-arrow==0.17.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-asgiref==3.3.1; python_version >= '3.5'
-async-timeout==3.0.1; python_full_version >= '3.5.3'
-attrs==20.3.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-autobahn==21.2.1; python_version >= '3.6'
+anyio==3.5.0; python_full_version >= '3.6.2'
+arrow==1.2.2; python_version >= '3.6'
+asgiref==3.5.0; python_version >= '3.7'
+async-timeout==4.0.2; python_version >= '3.6'
+attrs==21.4.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+autobahn==22.2.2; python_version >= '3.7'
 automat==20.2.0
-blessed==1.17.12
-certifi==2020.12.5
-cffi==1.14.5
-channels-redis==3.2.0
-channels==3.0.3
+backports.zoneinfo==0.2.1; python_version < '3.9'
+blessed==1.19.1; python_version >= '2.7'
+certifi==2021.10.8
+cffi==1.15.0
+channels-redis==3.4.0
+channels==3.0.4
 chardet==4.0.0; python_version >= '3.1'
-click==7.1.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-coloredlogs==15.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-concurrent-log-handler==0.9.19
+charset-normalizer==2.0.12; python_version >= '3'
+click==8.0.4; python_version >= '3.6'
+coloredlogs==15.0.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+concurrent-log-handler==0.9.20
 constantly==15.1.0
-cryptography==3.3.2
-daphne==3.0.1; python_version >= '3.6'
-dateparser==0.7.6
-django-cors-headers==3.7.0
-django-extensions==3.1.1
-django-filter==2.4.0
+cryptography==36.0.2; python_version >= '3.6'
+daphne==3.0.2; python_version >= '3.6'
+dateparser==1.1.1
+django-cors-headers==3.11.0
+django-extensions==3.1.5
+django-filter==21.1
 django-picklefield==3.0.1; python_version >= '3'
-django-q==1.3.4
-django==3.1.7
-djangorestframework==3.12.2
-filelock==3.0.12
+django-q==1.3.9
+django==4.0.3
+djangorestframework==3.13.1
+filelock==3.6.0
 fuzzywuzzy[speedup]==0.18.0
-gunicorn==20.0.4
-h11==0.12.0; python_version >= '3.6'
-hiredis==1.1.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-httptools==0.1.1
-humanfriendly==9.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+gunicorn==20.1.0
+h11==0.13.0; python_version >= '3.6'
+hiredis==2.0.0; python_version >= '3.6'
+httptools==0.4.0
+humanfriendly==10.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
 hyperlink==21.0.0
-idna==2.10; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-imap-tools==0.37.0
-img2pdf==0.4.0
-incremental==17.5.0
+idna==3.3; python_version >= '3.5'
+imap-tools==0.53.0
+img2pdf==0.4.3
+importlib-resources==5.6.0; python_version < '3.9'
+incremental==21.3.0
 inotify-simple==1.3.5; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
 inotifyrecursive==0.3.5
-joblib==1.0.1; python_version >= '3.6'
-langdetect==1.0.8
-lxml==4.6.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-msgpack==1.0.2
-numpy==1.19.5
-ocrmypdf==11.6.2
-pathvalidate==2.3.2
-pdfminer.six==20201018
-pikepdf==2.5.2
-pillow==8.1.0
-pluggy==0.13.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-portalocker==2.2.1; python_version >= '3'
-psycopg2-binary==2.8.6
+joblib==1.1.0; python_version >= '3.6'
+langdetect==1.0.9
+lxml==4.8.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+msgpack==1.0.3
+numpy==1.22.3; python_version >= '3.8'
+ocrmypdf==13.4.1
+packaging==21.3; python_version >= '3.6'
+pathvalidate==2.5.0
+pdfminer.six==20211012
+pikepdf==5.1.0
+pillow==9.0.1
+pluggy==1.0.0; python_version >= '3.6'
+portalocker==2.4.0; python_version >= '3'
+psycopg2==2.9.3
 pyasn1-modules==0.2.8
 pyasn1==0.4.8
-pycparser==2.20; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-pyhamcrest==2.0.2; python_version >= '3.5'
-pyopenssl==20.0.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-python-dateutil==2.8.1
-python-dotenv==0.15.0
-python-gnupg==0.4.6
+pycparser==2.21
+pyopenssl==22.0.0
+pyparsing==3.0.7; python_version >= '3.6'
+python-dateutil==2.8.2
+python-dotenv==0.20.0
+python-gnupg==0.4.8
 python-levenshtein==0.12.2
-python-magic==0.4.22
-pytz==2021.1
-pyyaml==5.4.1
+python-magic==0.4.25
+pytz-deprecation-shim==0.1.0.post0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'
+pytz==2022.1
+pyyaml==6.0
 redis==3.5.3
-regex==2020.11.13
-reportlab==3.5.59
-requests==2.25.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-scikit-learn==0.24.0
-scipy==1.5.4
-service-identity==18.1.0
-six==1.15.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-sortedcontainers==2.3.0
-sqlparse==0.4.1; python_version >= '3.5'
-threadpoolctl==2.1.0; python_version >= '3.5'
+regex==2022.3.2; python_version >= '3.6'
+reportlab==3.6.9; python_version >= '3.7' and python_version < '4'
+requests==2.27.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'
+scikit-learn==1.0.2
+scipy==1.8.0; python_version < '3.11' and python_version >= '3.8'
+service-identity==21.1.0
+setuptools==61.1.1; python_version >= '3.7'
+six==1.16.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+sniffio==1.2.0; python_version >= '3.5'
+sqlparse==0.4.2; python_version >= '3.5'
+threadpoolctl==3.1.0; python_version >= '3.6'
 tika==1.24
-tqdm==4.57.0
-twisted[tls]==20.3.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
-txaio==21.2.1; python_version >= '3.6'
-tzlocal==2.1
-urllib3==1.26.3; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'
-uvicorn[standard]==0.13.4
-uvloop==0.14.0
-watchdog==1.0.2
-watchgod==0.7
+tqdm==4.63.1
+twisted[tls]==22.2.0; python_full_version >= '3.6.7'
+txaio==22.2.1; python_version >= '3.6'
+typing-extensions==4.1.1; python_version >= '3.6'
+tzdata==2022.1; python_version >= '3.6'
+tzlocal==4.1; python_version >= '3.6'
+urllib3==1.26.9; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'
+uvicorn[standard]==0.17.6
+uvloop==0.16.0
+watchdog==2.1.7
+watchgod==0.8.1
 wcwidth==0.2.5
-websockets==8.1
-whitenoise==5.2.0
+websockets==10.2
+whitenoise==6.0.0
 whoosh==2.7.4
-zope.interface==5.2.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+zipp==3.7.0; python_version < '3.9'
+zope.interface==5.4.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'

resources/logo.txt

@@ -5,7 +5,7 @@
                SilN@@@@@@@
             *Q  *@@@@@@@@S        /= = = = = = = = = = = = = = = = = =\
           *@   B@@@@@@@@N        ||                                   ||
- N       R$  A@@@@@@@@@@         ||           PAPERLESS-NG            ||
+ N       R$  A@@@@@@@@@@         ||           PAPERLESS-NGX           ||
 x@@     $U  B@@@@@@@@@R          ||                                   ||
 N@@N^   @  N@@@@@@@@@*            \= = = = = = = = = = = = = = = = = =/
 |@@@u   @ E@@@@@@@@l

scripts/paperless-scheduler.service

@@ -1,5 +1,5 @@
 [Unit]
-Description=Paperless consumer
+Description=Paperless scheduler
 Requires=redis.service
 
 [Service]

scripts/paperless-webserver.service

@@ -3,6 +3,7 @@ Description=Paperless webserver
 After=network.target
 Wants=network.target
 Requires=redis.service
+#Requires=paperless-webserver.socket
 
 [Service]
 User=paperless

scripts/paperless-webserver.socket

@@ -0,0 +1,9 @@
+[Unit]
+Description=Paperless Webserver Socket
+
+[Socket]
+ListenStream=80
+NoDelay=true
+
+[Install]
+WantedBy=sockets.target

scripts/start_services.sh

@@ -1,4 +1,6 @@
-docker run -p 5432:5432 -v paperless_pgdata:/var/lib/postgresql/data -d postgres:13
+#!/usr/bin/env bash
+
+docker run -p 5432:5432 -e POSTGRES_PASSWORD=password -v paperless_pgdata:/var/lib/postgresql/data -d postgres:13
 docker run -d -p 6379:6379 redis:latest
-docker run -p 3000:3000 -d thecodingmachine/gotenberg
+docker run -p 3000:3000 -d gotenberg/gotenberg:7
 docker run -p 9998:9998 -d apache/tika

src-ui/.gitignore

@@ -32,6 +32,7 @@ speed-measure-plugin*.json
 .history/*
 
 # misc
+/.angular/cache
 /.sass-cache
 /connect.lock
 /coverage
@@ -44,3 +45,7 @@ testem.log
 # System Files
 .DS_Store
 Thumbs.db
+
+# Cypress
+cypress/videos/**/*
+cypress/screenshots/**/*

src-ui/angular.json

@@ -16,11 +16,26 @@
 			"i18n": {
 				"sourceLocale": "en-US",
 				"locales": {
-					"de": "src/locale/messages.de.xlf",
-					"nl-NL": "src/locale/messages.nl_NL.xlf",
-					"fr": "src/locale/messages.fr.xlf",
+					"be-BY": "src/locale/messages.be_BY.xlf",
+					"cs-CZ": "src/locale/messages.cs_CZ.xlf",
+					"da-DK": "src/locale/messages.da_DK.xlf",
+					"de-DE": "src/locale/messages.de_DE.xlf",
 					"en-GB": "src/locale/messages.en_GB.xlf",
-					"pt-BR": "src/locale/messages.pt_BR.xlf"
+					"es-ES": "src/locale/messages.es_ES.xlf",
+					"fr-FR": "src/locale/messages.fr_FR.xlf",
+					"it-IT": "src/locale/messages.it_IT.xlf",
+					"lb-LU": "src/locale/messages.lb_LU.xlf",
+					"nl-NL": "src/locale/messages.nl_NL.xlf",
+					"pl-PL": "src/locale/messages.pl_PL.xlf",
+					"pt-BR": "src/locale/messages.pt_BR.xlf",
+					"pt-PT": "src/locale/messages.pt_PT.xlf",
+					"ro-RO": "src/locale/messages.ro_RO.xlf",
+					"ru-RU": "src/locale/messages.ru_RU.xlf",
+					"sl-SI": "src/locale/messages.sl_SI.xlf",
+					"sr-CS": "src/locale/messages.sr_CS.xlf",
+					"sv-SE": "src/locale/messages.sv_SE.xlf",
+					"tr-TR": "src/locale/messages.tr_TR.xlf",
+					"zh-CN": "src/locale/messages.zh_CN.xlf"
 				}
 			},
 			"architect": {
@@ -34,7 +49,6 @@
 						"polyfills": "src/polyfills.ts",
 						"tsConfig": "tsconfig.app.json",
 						"localize": true,
-						"aot": true,
 						"assets": [
 							"src/favicon.ico",
 							"src/apple-touch-icon.png",
@@ -51,7 +65,13 @@
 						"scripts": [],
 						"allowedCommonJsDependencies": [
 							"ng2-pdf-viewer"
-						]
+						],
+						"vendorChunk": true,
+						"extractLicenses": false,
+						"buildOptimizer": false,
+						"sourceMap": true,
+						"optimization": false,
+						"namedChunks": true
 					},
 					"configurations": {
 						"production": {
@@ -65,7 +85,6 @@
 							"optimization": true,
 							"outputHashing": "none",
 							"sourceMap": false,
-							"extractCss": true,
 							"namedChunks": false,
 							"extractLicenses": true,
 							"vendorChunk": false,
@@ -86,7 +105,8 @@
 						"en-US": {
 							"localize": ["en-US"]
 						}
-					}
+					},
+					"defaultConfiguration": ""
 				},
 				"serve": {
 					"builder": "@angular-devkit/build-angular:dev-server",
@@ -106,12 +126,9 @@
 					}
 				},
 				"test": {
-					"builder": "@angular-devkit/build-angular:karma",
+					"builder": "@angular-builders/jest:run",
 					"options": {
-						"main": "src/test.ts",
-						"polyfills": "src/polyfills.ts",
 						"tsConfig": "tsconfig.spec.json",
-						"karmaConfig": "karma.conf.js",
 						"assets": [
 							"src/favicon.ico",
 							"src/apple-touch-icon.png",
@@ -124,23 +141,22 @@
 						"scripts": []
 					}
 				},
-				"lint": {
-					"builder": "@angular-devkit/build-angular:tslint",
+				"e2e": {
+					"builder": "@cypress/schematic:cypress",
 					"options": {
-						"tsConfig": [
-							"tsconfig.app.json",
-							"tsconfig.spec.json",
-							"e2e/tsconfig.json"
-						],
-						"exclude": [
-							"**/node_modules/**"
-						]
+						"devServerTarget": "paperless-ui:serve",
+						"watch": true,
+						"headless": false
+					},
+					"configurations": {
+						"production": {
+							"devServerTarget": "paperless-ui:serve:production"
+						}
 					}
 				},
-				"e2e": {
-					"builder": "@angular-devkit/build-angular:protractor",
+				"cypress-run": {
+					"builder": "@cypress/schematic:cypress",
 					"options": {
-						"protractorConfig": "e2e/protractor.conf.js",
 						"devServerTarget": "paperless-ui:serve"
 					},
 					"configurations": {
@@ -148,6 +164,13 @@
 							"devServerTarget": "paperless-ui:serve:production"
 						}
 					}
+				},
+				"cypress-open": {
+					"builder": "@cypress/schematic:cypress",
+					"options": {
+						"watch": true,
+						"headless": false
+					}
 				}
 			}
 		}

src-ui/cypress.json

@@ -0,0 +1,9 @@
+{
+  "integrationFolder": "cypress/integration",
+  "supportFile": "cypress/support/index.ts",
+  "videosFolder": "cypress/videos",
+  "screenshotsFolder": "cypress/screenshots",
+  "pluginsFile": "cypress/plugins/index.ts",
+  "fixturesFolder": "cypress/fixtures",
+  "baseUrl": "http://localhost:4200"
+}

src-ui/cypress/fixtures/correspondents/correspondents.json

@@ -0,0 +1 @@
+{"count":27,"next":"http://localhost:8000/api/correspondents/?page=2","previous":null,"results":[{"id":9,"slug":"abc-test-correspondent","name":"ABC Test Correspondent","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":13,"slug":"corresp-10","name":"Corresp 10","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":14,"slug":"corresp-11","name":"Corresp 11","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":15,"slug":"corresp-12","name":"Corresp 12","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":16,"slug":"corresp-13","name":"Corresp 13","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":18,"slug":"corresp-15","name":"Corresp 15","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":19,"slug":"corresp-16","name":"Corresp 16","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":20,"slug":"corresp-17","name":"Corresp 17","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":21,"slug":"corresp-18","name":"Corresp 18","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":22,"slug":"corresp-19","name":"Corresp 19","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":23,"slug":"corresp-20","name":"Corresp 20","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":24,"slug":"corresp-21","name":"Corresp 21","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":25,"slug":"corresp-22","name":"Corresp 22","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":26,"slug":"corresp-23","name":"Corresp 23","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":5,"slug":"corresp-3","name":"Corresp 3","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":6,"slug":"corresp-4","name":"Corresp 4","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":7,"slug":"corresp-5","name":"Corresp 5","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":8,"slug":"corresp-6","name":"Corresp 6","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":10,"slug":"corresp-7","name":"Corresp 7","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":11,"slug":"corresp-8","name":"Corresp 8","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":12,"slug":"corresp-9","name":"Corresp 9","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":17,"slug":"correspondent-14","name":"Correspondent 14","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0,"last_correspondence":null},{"id":2,"slug":"correspondent-2","name":"Correspondent 2","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":7,"last_correspondence":"2021-01-20T23:37:58.204614Z"},{"id":27,"slug":"michael-shamoon","name":"Michael Shamoon","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":1,"last_correspondence":"2022-03-16T03:48:50.089624Z"},{"id":4,"slug":"newest-correspondent","name":"Newest Correspondent","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":1,"last_correspondence":"2021-02-07T08:00:00Z"}]}

src-ui/cypress/fixtures/document_types/doctypes.json

@@ -0,0 +1 @@
+{"count":1,"next":null,"previous":null,"results":[{"id":1,"slug":"test","name":"Test Doc Type","match":"","matching_algorithm":1,"is_insensitive":true,"document_count":0}]}

src-ui/cypress/fixtures/documents/1/metadata.json

@@ -0,0 +1 @@
+{"original_checksum":"e959bc7d593245d92685213264e962ba","original_size":963754,"original_mime_type":"application/pdf","media_filename":"2022/lorem-ipsum.pdf","has_archive_version":true,"original_metadata":[],"archive_checksum":"5a1f46a9150bcade978c764b039ce4d0","archive_media_filename":"2022/lorem-ipsum.pdf","archive_size":351160,"archive_metadata":[{"namespace":"http://ns.adobe.com/pdf/1.3/","prefix":"pdf","key":"Producer","value":"pikepdf5.0.1"},{"namespace":"http://ns.adobe.com/xap/1.0/","prefix":"xmp","key":"ModifyDate","value":"2022-03-22T04:53:18+00:00"},{"namespace":"http://ns.adobe.com/xap/1.0/","prefix":"xmp","key":"CreateDate","value":"2022-03-22T18:05:43+00:00"},{"namespace":"http://ns.adobe.com/xap/1.0/","prefix":"xmp","key":"CreatorTool","value":"ocrmypdf13.4.0/TesseractOCR-PDF4.1.1"},{"namespace":"http://ns.adobe.com/xap/1.0/mm/","prefix":"xmpMM","key":"DocumentID","value":"uuid:df27edcf-e34a-11f7-0000-8fa6067a3c04"},{"namespace":"http://purl.org/dc/elements/1.1/","prefix":"dc","key":"format","value":"application/pdf"},{"namespace":"http://purl.org/dc/elements/1.1/","prefix":"dc","key":"title","value":"ScannedDocument"},{"namespace":"http://www.aiim.org/pdfa/ns/id/","prefix":"pdfaid","key":"part","value":"2"},{"namespace":"http://www.aiim.org/pdfa/ns/id/","prefix":"pdfaid","key":"conformance","value":"B"},{"namespace":"http://purl.org/dc/elements/1.1/","prefix":"dc","key":"creator","value":"None"},{"namespace":"http://ns.adobe.com/xap/1.0/","prefix":"xmp","key":"MetadataDate","value":"2022-03-22T21:53:18.882551-07:00"}]}

src-ui/cypress/fixtures/documents/1/suggestions.json

@@ -0,0 +1 @@
+{"correspondents":[],"tags":[3],"document_types":[1]}

src-ui/cypress/fixtures/saved_views/savedviews.json

@@ -0,0 +1 @@
+{"count":3,"next":null,"previous":null,"results":[{"id":1,"name":"Inbox","show_on_dashboard":true,"show_in_sidebar":true,"sort_field":"created","sort_reverse":true,"filter_rules":[{"rule_type":6,"value":"18"}]},{"id":2,"name":"Recently Added","show_on_dashboard":true,"show_in_sidebar":false,"sort_field":"created","sort_reverse":true,"filter_rules":[]},{"id":11,"name":"Taxes","show_on_dashboard":false,"show_in_sidebar":true,"sort_field":"created","sort_reverse":true,"filter_rules":[{"rule_type":6,"value":"39"}]}]}

src-ui/cypress/fixtures/tags/tags.json

@@ -0,0 +1 @@
+{"count":8,"next":null,"previous":null,"results":[{"id":4,"slug":"another-sample-tag","name":"Another Sample Tag","color":"#a6cee3","text_color":"#000000","match":"","matching_algorithm":6,"is_insensitive":true,"is_inbox_tag":false,"document_count":3},{"id":7,"slug":"newone","name":"NewOne","color":"#9e4ad1","text_color":"#ffffff","match":"","matching_algorithm":1,"is_insensitive":true,"is_inbox_tag":false,"document_count":2},{"id":6,"slug":"partial-tag","name":"Partial Tag","color":"#72dba7","text_color":"#000000","match":"","matching_algorithm":1,"is_insensitive":true,"is_inbox_tag":false,"document_count":1},{"id":2,"slug":"tag-2","name":"Tag 2","color":"#612db7","text_color":"#ffffff","match":"","matching_algorithm":1,"is_insensitive":true,"is_inbox_tag":false,"document_count":3},{"id":3,"slug":"tag-3","name":"Tag 3","color":"#b2df8a","text_color":"#000000","match":"","matching_algorithm":1,"is_insensitive":true,"is_inbox_tag":false,"document_count":4},{"id":5,"slug":"tagwithpartial","name":"TagWithPartial","color":"#3b2db4","text_color":"#ffffff","match":"","matching_algorithm":6,"is_insensitive":true,"is_inbox_tag":false,"document_count":2},{"id":8,"slug":"test-another","name":"Test Another","color":"#3ccea5","text_color":"#000000","match":"","matching_algorithm":4,"is_insensitive":true,"is_inbox_tag":false,"document_count":0},{"id":1,"slug":"test-tag","name":"Test Tag","color":"#fb9a99","text_color":"#000000","match":"","matching_algorithm":1,"is_insensitive":true,"is_inbox_tag":false,"document_count":4}]}

src-ui/cypress/integration/document-detail.spec.ts

@@ -0,0 +1,64 @@
+describe('document-detail', () => {
+  beforeEach(() => {
+    this.modifiedDocuments = []
+
+    cy.fixture('documents/documents.json').then((documentsJson) => {
+      cy.intercept('GET', 'http://localhost:8000/api/documents/1/', (req) => {
+        let response = { ...documentsJson }
+        response = response.results.find((d) => d.id == 1)
+        req.reply(response)
+      })
+    })
+
+    cy.intercept('PUT', 'http://localhost:8000/api/documents/1/', (req) => {
+      this.modifiedDocuments.push(req.body) // store this for later
+      req.reply({ result: 'OK' })
+    }).as('saveDoc')
+
+    cy.intercept('http://localhost:8000/api/documents/1/metadata/', {
+      fixture: 'documents/1/metadata.json',
+    })
+
+    cy.intercept('http://localhost:8000/api/documents/1/suggestions/', {
+      fixture: 'documents/1/suggestions.json',
+    })
+
+    cy.intercept('http://localhost:8000/api/saved_views/*', {
+      fixture: 'saved_views/savedviews.json',
+    })
+
+    cy.intercept('http://localhost:8000/api/tags/*', {
+      fixture: 'tags/tags.json',
+    })
+
+    cy.intercept('http://localhost:8000/api/correspondents/*', {
+      fixture: 'correspondents/correspondents.json',
+    })
+
+    cy.intercept('http://localhost:8000/api/document_types/*', {
+      fixture: 'document_types/doctypes.json',
+    })
+
+    cy.viewport(1024, 1024)
+    cy.visit('/documents/1/')
+  })
+
+  it('should activate / deactivate save button when changes are saved', () => {
+    cy.contains('button', 'Save').should('be.disabled')
+    cy.get('app-input-text[formcontrolname="title"]')
+      .type(' additional')
+      .wait(1500) // this delay is for frontend debounce
+    cy.contains('button', 'Save').should('not.be.disabled')
+  })
+
+  it('should warn on unsaved changes', () => {
+    cy.get('app-input-text[formcontrolname="title"]')
+      .type(' additional')
+      .wait(1500) // this delay is for frontend debounce
+    cy.get('button[title="Close"]').click()
+    cy.contains('You have unsaved changes')
+    cy.contains('button', 'Cancel').click().wait(150)
+    cy.contains('button', 'Save').click().wait('@saveDoc').wait(2000) // navigates away after saving
+    cy.contains('You have unsaved changes').should('not.exist')
+  })
+})