v1.7.0

[Beta] Paperless-ngx v1.7.0 Release Candidate 1

.dockerignore

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

.editorconfig

@@ -18,14 +18,20 @@ 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
 # the 79 character rule, but in the interests of clarity, tests often need to
 # violate it.
 [**/test_*.py]
 max_line_length = off
+
+[Dockerfile]
+indent_style = space

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,91 @@
+name: Bug report
+description: Something is not working
+title: "[BUG] Concise description of the issue"
+labels: ["bug", "unconfirmed"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Have a question? 👉 [Start a new discussion](https://github.com/paperless-ngx/paperless-ngx/discussions/new) or [ask in chat](https://matrix.to/#/#paperless:adnidor.de).
+        
+        Before opening an issue, please check [the documentation](https://paperless-ngx.readthedocs.io/en/latest/troubleshooting.html) and see if it helps you resolve your issue. Please also make sure that you followed the installation instructions.
+        
+        If you encounter issues while installing or configuring Paperless-ngx, please post in the ["Support" section of the discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/new?category=support). Remember that Paperless successfully runs on a variety of different systems. If Paperless-ngx does not start, it's likely an issue with your system, not an issue of Paperless-ngx.
+        
+        Finally, please search issues and discussions before opening a new bug report.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of what the bug is.
+      placeholder: Currently...
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+      placeholder: In this situation...
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to reproduce
+      description: Steps to reproduce the behavior
+      placeholder: "1. Go to '...', 2. Click on '....', 3. See error"
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Webserver logs
+      description: If available, post any logs from the web server related to your issue.
+      render: bash
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+  - type: input
+    id: version
+    attributes:
+      label: Paperless-ngx version
+      placeholder: e.g. 1.6.0
+    validations:
+      required: true
+  - type: input
+    id: host-os
+    attributes:
+      label: Host OS
+      description: Host OS of the machine running paperless-ngx
+      placeholder: e.g. Archlinux / Ubuntu 20.04
+    validations:
+      required: true
+  - type: dropdown
+    id: install-method
+    attributes:
+      label: Installation method
+      options:
+        - Docker
+        - Bare metal
+        - Other (please describe above)
+    validations:
+      required: true
+  - type: input
+    id: browser
+    attributes:
+      label: Browser
+      description: Which browser you are using, if relevant
+      placeholder: e.g. Chrome, Safari
+  - type: input
+    id: config-changes
+    attributes:
+      label: Configuration changes
+      description: Any configuration changes you made in `docker-compose.yml`, `docker-compose.env` or `paperless.conf`.
+  - type: input
+    id: other
+    attributes:
+      label: Other
+      description: Any other relevant details

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,48 +0,0 @@
----
-name: Bug report
-about: Something is not working
-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-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/paperless-ngx/paperless-ngx/discussions/categories/feature-requests
-
-=> 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.
--->
-
-**Describe the bug**
-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 '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-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`.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 🤔 Questions and Help
+    url: https://github.com/paperless-ngx/paperless-ngx/discussions
+    about: This issue tracker is not for support questions. Please refer to our Discussions.
+  - name: 💬 Chat
+    url: https://matrix.to/#/#paperless:adnidor.de
+    about: Want to discuss Paperless-ngx with others? Check out our chat.
+  - name: 🚀 Feature Request
+    url: https://github.com/paperless-ngx/paperless-ngx/discussions/new?category=feature-requests
+    about: Remember to search for existing feature requests and "up-vote" any you like

.github/ISSUE_TEMPLATE/other.md

@@ -1,20 +0,0 @@
----
-name: Other
-about: Anything that is not a feature request or bug.
-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/paperless-ngx/paperless-ngx/discussions/categories/feature-requests
-
-=> 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,32 @@
+<!--
+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 proposed change can be tested. Screenshots and / or videos can also be helpful if appropriate.
+-->
+
+Fixes # (issue)
+
+## 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

@@ -8,9 +8,12 @@ updates:
     target-branch: "dev"
     # Look for `package.json` and `lock` files in the `root` directory
     directory: "/src-ui"
-    # Check the npm registry for updates every week
+    # Check the npm registry for updates every month
     schedule:
-      interval: "weekly"
+      interval: "monthly"
+    # Add reviewers
+    reviewers:
+      - "paperless-ngx/frontend"
 
   # Enable version updates for Python
   - package-ecosystem: "pip"
@@ -20,3 +23,19 @@ updates:
     # 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/release-drafter.yml

@@ -0,0 +1,37 @@
+categories:
+  - title: 'Breaking Changes'
+    labels:
+      - 'breaking-change'
+  - title: 'Features'
+    labels:
+      - 'enhancement'
+  - title: 'Bug Fixes'
+    labels:
+      - 'bug'
+  - title: 'Documentation'
+    label: 'documentation'
+  - title: 'Maintenance'
+    labels:
+      - 'chore'
+      - 'deployment'
+      - 'translation'
+  - title: 'Dependencies'
+    collapse-after: 3
+    label: 'dependencies'
+include-labels:
+  - 'enhancement'
+  - 'bug'
+  - 'chore'
+  - 'deployment'
+  - 'translation'
+  - 'dependencies'
+replacers: # Changes "Feature: Update checker" to "Update checker"
+  - search: '/Feature:|Feat:|\[feature\]/gi'
+    replace: ''
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&#@'
+tag-prefix: "ngx-"
+template: |
+  # Changelog
+
+  $CHANGES

.github/stale.yml

@@ -2,11 +2,8 @@
 daysUntilStale: 30
 # Number of days of inactivity before a stale issue is closed
 daysUntilClose: 7
-# Issues with these labels will never be considered stale
+onlyLabels:
-exemptLabels:
+  - unconfirmed
-  - 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

.github/workflows/ci.yml

@@ -13,90 +13,100 @@ 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.9
-      -
+          cache: "pipenv"
-        name: Get pip cache dir
+          cache-dependency-path: 'Pipfile.lock'
-        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}
       -
         name: Install dependencies
         run: |
-          pip install --upgrade pipenv
+          pipenv sync --dev
-          pipenv install --system --dev --ignore-pipfile
       -
         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
+        name: Install checkers
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-      -
-        name: Get pip cache dir
-        id: pip-cache
         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
+        name: Run reorder-python-imports
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip${{ matrix.python-version }}
-      -
-        name: Install dependencies
         run: |
-          pip install --upgrade pipenv
+          find src/ -type f -name '*.py' ! -path "*/migrations/*" | xargs reorder-python-imports
-          pipenv install --system --dev --ignore-pipfile
       -
-        name: Codestyle
+        name: Run yesqa
         run: |
-          cd src/
+          find src/ -type f -name '*.py' ! -path "*/migrations/*" | xargs yesqa
-          pycodestyle --max-line-length=88 --ignore=E121,E123,E126,E226,E24,E704,W503,W504,E203
-  codeformatting:
-    runs-on: ubuntu-20.04
-    steps:
       -
-        name: Checkout
+        name: Run add-trailing-comma
-        uses: actions/checkout@v2
+        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.1.0"
+          version: "22.3.0"
+      -
+        name: Run flake8 checks
+        run: |
+          cd src/
+          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:
@@ -105,73 +115,94 @@ jobs:
     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
+        name: Install system dependencies
-        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
         run: |
           sudo apt-get update -qq
-          sudo apt-get install -qq --no-install-recommends unpaper tesseract-ocr imagemagick ghostscript optipng
+          sudo apt-get install -qq --no-install-recommends unpaper tesseract-ocr imagemagick ghostscript optipng libzbar0 poppler-utils
-          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.9'
+        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
+
+  tests-frontend:
+    needs: [code-checks-frontend]
+    name: "Frontend Tests"
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        node-version: [16.x]
+    steps:
+      - 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-latest
+    concurrency:
-    needs: [tests, codeformatting, codestyle]
+      group: ${{ github.workflow }}-build-docker-image-${{ github.ref }}
+      cancel-in-progress: true
+    runs-on: ubuntu-20.04
+    needs: [tests-backend, tests-frontend]
     steps:
       -
-        name: Prepare
+        name: Gather Docker metadata
-        id: prepare
+        id: docker-meta
-        run: |
+        uses: docker/metadata-action@v3
-          IMAGE_NAME=ghcr.io/${{ github.repository }}
+        with:
-          if [[ $GITHUB_REF == refs/tags/ngx-* ]]; then
+          images: ghcr.io/${{ github.repository }}
-            TAGS=${IMAGE_NAME}:${GITHUB_REF#refs/tags/ngx-},${IMAGE_NAME}:latest
+          tags: |
-            INSPECT_TAG=${IMAGE_NAME}:latest
+            type=ref,event=branch
-          elif [[ $GITHUB_REF == refs/tags/beta-* ]]; then
+            type=ref,event=tag
-            TAGS=${IMAGE_NAME}:beta
-            INSPECT_TAG=${TAGS}
-          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
+        uses: actions/checkout@v3
       -
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
@@ -192,36 +223,37 @@ jobs:
           context: .
           file: ./Dockerfile
           platforms: linux/amd64,linux/arm/v7,linux/arm64
-          push: true
+          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.prepare.outputs.tags }}
+          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 ${{ steps.prepare.outputs.inspect_tag }}
+          docker buildx imagetools inspect ${{ fromJSON(steps.docker-meta.outputs.json).tags[0] }}
       -
         name: Export frontend artifact from docker
         run: |
-          docker run -d --name frontend-extract ${{ steps.prepare.outputs.tags }}
+          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@v2
+        uses: actions/upload-artifact@v3
         with:
           name: frontend-compiled
           path: src/documents/static/frontend/
 
   build-release:
-    needs: [build-docker-image, documentation, tests, codeformatting, 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.9
       -
@@ -233,13 +265,13 @@ jobs:
           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/
@@ -274,19 +306,19 @@ jobs:
           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-ngx.tar.xz
 
   publish-release:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     needs: build-release
     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: ./
@@ -302,18 +334,17 @@ jobs:
             echo ::set-output name=prerelease::true
           fi
       -
-        name: Create release
+        name: Create Release and Changelog
-        id: create_release
+        id: create-release
-        uses: actions/create-release@v1
+        uses: release-drafter/release-drafter@v5
+        with:
+          name: Paperless-ngx ${{ steps.get_version.outputs.version }}
+          tag: ngx-${{ steps.get_version.outputs.version }}
+          version: ${{ steps.get_version.outputs.version }}
+          prerelease: ${{ steps.get_version.outputs.prerelease }}
+          publish: true # ensures release is not marked as draft
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ngx-${{ steps.get_version.outputs.version }}
-          release_name: Paperless-ngx ${{ steps.get_version.outputs.version }}
-          draft: false
-          prerelease: ${{ steps.get_version.outputs.prerelease }}
-          body: |
-            For a complete list of changes, see the changelog at https://paperless-ngx.readthedocs.io/en/latest/changelog.html.
       -
         name: Upload release archive
         id: upload-release-asset
@@ -321,7 +352,7 @@ jobs:
         env:
           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
+          upload_url: ${{ steps.create-release.outputs.upload_url }}
           asset_path: ./paperless-ngx.tar.xz
           asset_name: paperless-ngx-${{ steps.get_version.outputs.version }}.tar.xz
           asset_content_type: application/x-xz

.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.2.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.2"
+    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.2"
+    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

CODEOWNERS

@@ -0,0 +1,10 @@
+/.github/workflows/ @paperless-ngx/ci-cd
+/docker/ @paperless-ngx/ci-cd
+/scripts/ @paperless-ngx/ci-cd
+
+/src-ui/ @paperless-ngx/frontend
+
+/src/ @paperless-ngx/backend
+Pipfile* @paperless-ngx/backend
+*.py @paperless-ngx/backend
+requirements.txt @paperless-ngx/backend

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

@@ -4,10 +4,10 @@ If you feel like contributing to the project, please do! Bug fixes and improveme
 
 If you want to implement something big:
 
-* Please start a discussion about that in the issues! Maybe something similar is already in development and we can make it happen together.
+- 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.
+- 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.
+- 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.
+- Please see the [paperless-ngx merge process](#merging-prs) below.
 
 ## Python
 
@@ -15,7 +15,7 @@ Paperless supports python 3.8 and 3.9. We format Python code with [Black](https:
 
 ## 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.
 
@@ -27,6 +27,8 @@ Please format and test your code! I know it's a hassle, but it makes sure that y
 
 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-ngx.readthedocs.io/en/latest/extending.html
@@ -41,9 +43,9 @@ PRs deemed `non-trivial` will go through a stricter review process before being
 
 Examples of `non-trivial` PRs might include:
 
-* Additional features
+- Additional features
-* Large changes to many distinct files
+- Large changes to many distinct files
-* Breaking or depreciation of existing features
+- Breaking or depreciation of existing features
 
 Our community review process for `non-trivial` PRs is the following:
 
@@ -75,21 +77,56 @@ If a language has already been added, and you would like to contribute new trans
 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).
+- 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/
+- 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.
+- 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-ui/angular.json (under the _projects/paperless-ui/i18n/locales_ JSON key)
-* src/paperless/settings.py (in the _LANGUAGES_ array)
+- src/paperless/settings.py (in the _LANGUAGES_ array)
-* src-ui/src/app/services/settings.service.ts (inside the _getLanguageOptions_ method)
+- 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_)
+- 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

@@ -3,64 +3,16 @@ FROM node:16 AS compile-frontend
 COPY . /src
 
 WORKDIR /src/src-ui
-RUN npm update npm -g && npm install
+RUN npm update npm -g && npm ci --no-optional
 RUN ./node_modules/.bin/ng build --configuration production
 
+FROM ghcr.io/paperless-ngx/builder/ngx-base:1.7.0 as main-app
 
-FROM ubuntu:20.04 AS jbig2enc
+LABEL org.opencontainers.image.authors="paperless-ngx team <hello@paperless-ngx.com>"
-
+LABEL org.opencontainers.image.documentation="https://paperless-ngx.readthedocs.io/en/latest/"
-WORKDIR /usr/src/jbig2enc
+LABEL org.opencontainers.image.source="https://github.com/paperless-ngx/paperless-ngx"
-
+LABEL org.opencontainers.image.url="https://github.com/paperless-ngx/paperless-ngx"
-RUN apt-get update && apt-get install -y --no-install-recommends build-essential automake libtool libleptonica-dev zlib1g-dev git ca-certificates
+LABEL org.opencontainers.image.licenses="GPL-3.0-only"
-
-RUN git clone https://github.com/agl/jbig2enc .
-RUN ./autogen.sh
-RUN ./configure && make
-
-
-FROM python:3.9-slim-bullseye
-
-# Binary dependencies
-RUN apt-get update \
-	&& apt-get -y --no-install-recommends install \
-  	# Basic dependencies
-		curl \
-		gnupg \
-		imagemagick \
-		gettext \
-		tzdata \
-		gosu \
-		# fonts for text file thumbnail generation
-		fonts-liberation \
-		# for Numpy
-		libatlas-base-dev \
-		libxslt1-dev \
-		# thumbnail size reduction
-		optipng \
-		libxml2 \
-		pngquant \
-		unpaper \
-		zlib1g \
-		ghostscript \
-		icc-profiles-free \
-  	# Mime type detection
-		file \
-		libmagic-dev \
-		media-types \
-		# OCRmyPDF dependencies
-		liblept5 \
-		tesseract-ocr \
-		tesseract-ocr-eng \
-		tesseract-ocr-deu \
-		tesseract-ocr-fra \
-		tesseract-ocr-ita \
-		tesseract-ocr-spa \
-  && rm -rf /var/lib/apt/lists/*
-
-# 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/
 
 WORKDIR /usr/src/paperless/src/
 
@@ -68,30 +20,13 @@ 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 \
+    && python3 -m pip install --upgrade --no-cache-dir pip wheel \
-		git \
-		zlib1g-dev \
-		libjpeg62-turbo-dev \
-	&& if [ "$(uname -m)" = "armv7l" ] || [ "$(uname -m)" = "aarch64" ]; \
-	  then echo "Building qpdf" \
-	  && mkdir -p /usr/src/qpdf \
-	  && cd /usr/src/qpdf \
-	  && git clone https://github.com/qpdf/qpdf.git . \
-	  && git checkout --quiet release-qpdf-10.6.2 \
-	  && ./configure \
-	  && make \
-	  && make install \
-	  && cd /usr/src/paperless/src/ \
-	  && rm -rf /usr/src/qpdf; \
-	else \
-	  echo "Skipping qpdf build because pikepdf binary wheels are available."; \
-	fi \
-    && python3 -m pip install --upgrade 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 git zlib1g-dev libjpeg62-turbo-dev \
+  && apt-get -y purge build-essential \
   && apt-get -y autoremove --purge \
   && rm -rf /var/lib/apt/lists/*
 
@@ -103,12 +38,13 @@ RUN cd docker \
   && mkdir /var/log/supervisord /var/run/supervisord \
   && cp supervisord.conf /etc/supervisord.conf \
   && cp docker-entrypoint.sh /sbin/docker-entrypoint.sh \
-	&& cp docker-prepare.sh /sbin/docker-prepare.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 docker -rf
+  && rm -rf docker/
 
 COPY gunicorn.conf.py ../
 
@@ -122,13 +58,13 @@ RUN addgroup --gid 1000 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", \
-ENTRYPOINT ["/sbin/docker-entrypoint.sh"]
+        "/usr/src/paperless/media", \
-EXPOSE 8000
+        "/usr/src/paperless/consume", \
-CMD ["/usr/local/bin/supervisord", "-c", "/etc/supervisord.conf"]
+        "/usr/src/paperless/export"]
 
-LABEL org.opencontainers.image.authors="paperless-ngx team <hello@paperless-ngx.com>"
+ENTRYPOINT ["/sbin/docker-entrypoint.sh"]
-LABEL org.opencontainers.image.documentation="https://paperless-ngx.readthedocs.io/en/latest/"
+
-LABEL org.opencontainers.image.source="https://github.com/paperless-ngx/paperless-ngx"
+EXPOSE 8000
-LABEL org.opencontainers.image.url="https://github.com/paperless-ngx/paperless-ngx"
+
-LABEL org.opencontainers.image.licenses="GPL-3.0-only"
+CMD ["/usr/local/bin/supervisord", "-c", "/etc/supervisord.conf"]

Pipfile

@@ -9,35 +9,36 @@ verify_ssl = true
 name = "piwheels"
 
 [packages]
-dateparser = "~=1.1.0"
+dateparser = "~=1.1"
-django = "~=3.2"
+django = "~=4.0"
 django-cors-headers = "*"
 django-extensions = "*"
 django-filter = "~=21.1"
-django-q = "~=1.3.4"
+django-q = "~=1.3"
-djangorestframework = "~=3.13.1"
+djangorestframework = "~=3.13"
 filelock = "*"
 fuzzywuzzy = {extras = ["speedup"], version = "*"}
 gunicorn = "*"
 imap-tools = "*"
 langdetect = "*"
-numpy = "~=1.22.0"
 pathvalidate = "*"
-pillow = "~=9.0"
+pillow = "~=9.1"
-pikepdf = "~=5.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"
+scikit-learn="==1.0.2"
 whitenoise = "~=6.0.0"
 watchdog = "~=2.1.0"
 whoosh="~=2.7.4"
-inotifyrecursive = "~=0.3.4"
+inotifyrecursive = "~=0.3"
-ocrmypdf = "~=13.4.0"
+ocrmypdf = "~=13.4"
 tqdm = "*"
 tika = "*"
 # TODO: This will sadly also install daphne+dependencies,
@@ -46,11 +47,12 @@ channels = "~=3.0"
 channels-redis = "*"
 uvicorn = {extras = ["standard"], version = "*"}
 concurrent-log-handler = "*"
-# uvloop 0.15+ incompatible with python 3.6
-uvloop = "~=0.16"
-cryptography = "~=36.0.1"
 "pdfminer.six" = "*"
-"backports.zoneinfo" = "*"
+"backports.zoneinfo" = {version = "*", markers = "python_version < '3.9'"}
+"importlib-resources" = {version = "*", markers = "python_version < '3.9'"}
+zipp = {version = "*", markers = "python_version < '3.9'"}
+pyzbar = "*"
+pdf2image = "*"
 
 [dev-packages]
 coveralls = "*"
@@ -62,7 +64,8 @@ pytest-django = "*"
 pytest-env = "*"
 pytest-sugar = "*"
 pytest-xdist = "*"
-sphinx = "~=3.4.2"
+sphinx = "~=4.5.0"
 sphinx_rtd_theme = "*"
 tox = "*"
 black = "*"
+pre-commit = "*"

README.md

@@ -10,15 +10,15 @@
 </p>
 
 <!-- omit in toc -->
+
 # Paperless-ngx
 
-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 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](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).
 
-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.*
+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._
-
 
 - [Features](#features)
 - [Getting started](#getting-started)
@@ -35,28 +35,28 @@ A demo is available at [demo.paperless-ngx.com](https://demo.paperless-ngx.com)
 ![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)
 
-* Organize and index your scanned documents with tags, correspondents, types, and more.
+- 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.
+- 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).
+- 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))
+  - 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.
+- 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.
+- Single page application front end.
-	* Includes a dashboard that shows basic statistics and has document upload.
+  - Includes a dashboard that shows basic statistics and has document upload.
-	* Filtering by tags, correspondents, types, and more.
+  - Filtering by tags, correspondents, types, and more.
-	* Customizable views can be saved and displayed on the dashboard.
+  - Customizable views can be saved and displayed on the dashboard.
-* Full text search helps you find what you need.
+- Full text search helps you find what you need.
-	* Auto completion suggests relevant words from your documents.
+  - Auto completion suggests relevant words from your documents.
-	* Results are sorted by relevance to your search query.
+  - Results are sorted by relevance to your search query.
-	* Highlighting shows you which parts of the document matched the query.
+  - Highlighting shows you which parts of the document matched the query.
-	* Searching for similar documents ("More like this")
+  - Searching for similar documents ("More like this")
-* Email processing: Paperless adds documents from your email accounts.
+- Email processing: Paperless adds documents from your email accounts.
-	* Configure multiple accounts and filters for each account.
+  - 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.
+  - 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.
+- 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.
+  - 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.
+- 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.
+- 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).
+- [More screenshots are available in the documentation](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html).
 
 # Getting started
 
@@ -65,7 +65,7 @@ The easiest way to deploy paperless is docker-compose. The files in the [`/docke
 If you'd like to jump right in, you can configure a docker-compose environment with our install script:
 
 ```bash
-bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/install-paperless-ngx.sh)"
+bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
 ```
 
 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.
@@ -73,6 +73,7 @@ Alternatively, you can install the dependencies and setup apache and a database
 Migrating from Paperless-ng is easy, just drop in the new docker image! See the [documentation on migrating](https://paperless-ngx.readthedocs.io/en/latest/setup.html#migrating-from-paperless-ng) for more details.
 
 <!-- omit in toc -->
+
 ### Documentation
 
 The documentation for Paperless-ngx is available on [ReadTheDocs](https://paperless-ngx.readthedocs.io/).
@@ -101,17 +102,17 @@ For bugs please [open an issue](https://github.com/paperless-ngx/paperless-ngx/i
 
 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-ngx. Also works with the original Paperless and Paperless-ngx.
+- [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.
+- [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.
+- [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-ngx is unknown.
 
-* [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.
+- [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

docker/compose/docker-compose.env

@@ -22,6 +22,10 @@
 # Docker setup does not use the configuration file.
 # A few commonly adjusted settings are provided below.
 
+# This is required if you will be exposing Paperless-ngx on a public domain
+# (if doing so please consider security measures such as reverse proxy)
+#PAPERLESS_URL=https://paperless.example.com
+
 # 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

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:
 #
@@ -79,8 +80,9 @@ services:
   gotenberg:
     image: gotenberg/gotenberg:7
     restart: unless-stopped
-    environment:
+    command:
-      CHROMIUM_DISABLE_ROUTES: 1
+      - "gotenberg"
+      - "--chromium-disable-routes=true"
 
   tika:
     image: apache/tika

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

@@ -0,0 +1,85 @@
+# 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: gotenberg/gotenberg:7
+    restart: unless-stopped
+    command:
+      - "gotenberg"
+      - "--chromium-disable-routes=true"
+
+  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:
 #
@@ -68,8 +69,9 @@ services:
   gotenberg:
     image: gotenberg/gotenberg:7
     restart: unless-stopped
-    environment:
+    command:
-      CHROMIUM_DISABLE_ROUTES: 1
+      - "gotenberg"
+      - "--chromium-disable-routes=true"
 
   tika:
     image: apache/tika

docker/docker-entrypoint.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 set -e
 
@@ -10,7 +10,7 @@ map_uidgid() {
 	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
+		usermod -o -u "${USERMAP_NEW_UID}" paperless
 		groupmod -o -g "${USERMAP_NEW_GID}" paperless
 	fi
 }
@@ -56,12 +56,12 @@ install_languages() {
 		#    continue
 		#fi
 
-		if dpkg -s $pkg &>/dev/null; then
+		if dpkg -s "$pkg" &>/dev/null; then
 			echo "Package $pkg already installed!"
 			continue
 		fi
 
-		if ! apt-cache show $pkg &>/dev/null; then
+		if ! apt-cache show "$pkg" &>/dev/null; then
 			echo "Package $pkg not found! :("
 			continue
 		fi
@@ -77,7 +77,7 @@ install_languages() {
 echo "Paperless-ngx docker container starting..."
 
 # Install additional languages if specified
-if [[ ! -z "$PAPERLESS_OCR_LANGUAGES" ]]; then
+if [[ -n "$PAPERLESS_OCR_LANGUAGES" ]]; then
 	install_languages "$PAPERLESS_OCR_LANGUAGES"
 fi
 

docker/docker-prepare.sh

@@ -6,14 +6,11 @@ wait_for_postgres() {
 
 	echo "Waiting for PostgreSQL to start..."
 
-	host="${PAPERLESS_DBHOST}"
+	host="${PAPERLESS_DBHOST:=localhost}"
-	port="${PAPERLESS_DBPORT}"
+	port="${PAPERLESS_DBPORT:=5342}"
 
-	if [[ -z $port ]]; then
-		port="5432"
-	fi
 
-	while ! </dev/tcp/$host/$port; do
+	while [ ! "$(pg_isready -h $host -p $port)" ]; do
 
 		if [ $attempt_num -eq $max_attempts ]; then
 			echo "Unable to connect to database."
@@ -23,7 +20,7 @@ wait_for_postgres() {
 
 		fi
 
-		attempt_num=$(expr "$attempt_num" + 1)
+		attempt_num=$(("$attempt_num" + 1))
 		sleep 5
 	done
 }

docker/install_management_commands.sh

@@ -1,3 +1,5 @@
+#!/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..."

docker/management_script.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 set -e
 

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/_static/css/custom.css

@@ -0,0 +1,592 @@
+/* Variables */
+:root {
+  --color-text-body: #5c5962;
+  --color-text-body-light: #fcfcfc;
+  --color-text-anchor: #7253ed;
+  --color-text-alt: rgba(0, 0, 0, 0.3);
+  --color-text-title: #27262b;
+  --color-text-code-inline: #e74c3c;
+  --color-text-code-nt: #062873;
+  --color-text-selection: #b19eff;
+  --color-bg-body: #fcfcfc;
+  --color-bg-body-alt: #f3f6f6;
+  --color-bg-side-nav: #f5f6fa;
+  --color-bg-side-nav-hover: #ebedf5;
+  --color-bg-code-block: var(--color-bg-side-nav);
+  --color-border: #eeebee;
+  --color-btn-neutral-bg: #f3f6f6;
+  --color-btn-neutral-bg-hover: #e5ebeb;
+  --color-success-title: #1abc9c;
+  --color-success-body: #dbfaf4;
+  --color-warning-title: #f0b37e;
+  --color-warning-body: #ffedcc;
+  --color-danger-title: #f29f97;
+  --color-danger-body: #fdf3f2;
+  --color-info-title: #6ab0de;
+  --color-info-body: #e7f2fa;
+}
+
+.dark-mode {
+  --color-text-body: #abb2bf;
+  --color-text-body-light: #9499a2;
+  --color-text-alt: rgba(0255, 255, 255, 0.5);
+  --color-text-title: var(--color-text-anchor);
+  --color-text-code-inline: #abb2bf;
+  --color-text-code-nt: #2063f3;
+  --color-text-selection: #030303;
+  --color-bg-body: #1d1d20 !important;
+  --color-bg-body-alt: #131315;
+  --color-bg-side-nav: #18181a;
+  --color-bg-side-nav-hover: #101216;
+  --color-bg-code-block: #101216;
+  --color-border: #47494f;
+  --color-btn-neutral-bg: #242529;
+  --color-btn-neutral-bg-hover: #101216;
+  --color-success-title: #02120f;
+  --color-success-body: #041b17;
+  --color-warning-title: #1b0e03;
+  --color-warning-body: #371d06;
+  --color-danger-title: #120902;
+  --color-danger-body: #1b0503;
+  --color-info-title: #020608;
+  --color-info-body: #06141e;
+}
+
+* {
+  transition: background-color 0.3s ease, border-color 0.3s ease;
+}
+
+/* Typography */
+body {
+  font-family: system-ui,-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;
+  font-size: inherit;
+  line-height: 1.4;
+  color: var(--color-text-body);
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-family: inherit;
+}
+
+.rst-content .toctree-wrapper>p.caption, .rst-content h1, .rst-content h2, .rst-content h3, .rst-content h4, .rst-content h5, .rst-content h6 {
+  padding-top: .5em;
+}
+
+p, .main-content-wrap, .rst-content .section ul, .rst-content .toctree-wrapper ul, .rst-content section ul, .wy-plain-list-disc, article ul {
+  line-height: 1.6;
+}
+
+pre, .code, .rst-content .linenodiv pre, .rst-content div[class^=highlight] pre, .rst-content pre.literal-block {
+  font-family: "SFMono-Regular", Menlo,Consolas, Monospace;
+  font-size: 0.75em;
+  line-height: 1.8;
+}
+
+.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4 {
+  font-size: 1rem
+}
+
+.rst-versions {
+  font-family: inherit;
+  line-height: 1;
+}
+
+footer, footer p {
+  font-size: .8rem;
+}
+
+footer .rst-footer-buttons {
+  font-size: 1rem;
+}
+
+@media (max-width: 400px) {
+  /* break code lines on mobile */
+  pre, code {
+    word-break: break-word;
+  }
+}
+
+
+/* Layout */
+.wy-side-nav-search, .wy-menu-vertical {
+  width: auto;
+}
+
+.wy-nav-side {
+  z-index: 0;
+  display: flex;
+  flex-wrap: wrap;
+  background-color: var(--color-bg-side-nav);
+}
+
+.wy-side-scroll {
+  width: 100%;
+  overflow-y: auto;
+}
+
+@media (min-width: 66.5rem) {
+  .wy-side-scroll {
+      width:264px
+  }
+}
+
+@media (min-width: 50rem) {
+  .wy-nav-side {
+      flex-wrap: nowrap;
+      position: fixed;
+      width: 248px;
+      height: 100%;
+      flex-direction: column;
+      border-right: 1px solid var(--color-border);
+      align-items:flex-end
+  }
+}
+
+@media (min-width: 66.5rem) {
+  .wy-nav-side {
+      width: calc((100% - 1064px) / 2 + 264px);
+      min-width:264px
+  }
+}
+
+@media (min-width: 50rem) {
+  .wy-nav-content-wrap {
+      position: relative;
+      max-width: 800px;
+      margin-left:248px
+  }
+}
+
+@media (min-width: 66.5rem) {
+  .wy-nav-content-wrap {
+      margin-left:calc((100% - 1064px) / 2 + 264px)
+  }
+}
+
+
+/* Colors */
+body.wy-body-for-nav,
+.wy-nav-content {
+  background: var(--color-bg-body);
+}
+
+.wy-nav-side {
+  border-right: 1px solid var(--color-border);
+}
+
+.wy-side-nav-search, .wy-nav-top {
+  background: var(--color-bg-side-nav);
+  border-bottom: 1px solid var(--color-border);
+}
+
+.wy-nav-content-wrap {
+  background: inherit;
+}
+
+.wy-side-nav-search > a, .wy-nav-top a, .wy-nav-top i {
+  color: var(--color-text-title);
+}
+
+.wy-side-nav-search > a:hover, .wy-nav-top a:hover {
+  background: transparent;
+}
+
+.wy-side-nav-search > div.version {
+  color: var(--color-text-alt)
+}
+
+.wy-side-nav-search > div[role="search"] {
+  border-top: 1px solid var(--color-border);
+}
+
+.wy-menu-vertical li.toctree-l2.current>a, .wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,
+.wy-menu-vertical li.toctree-l3.current>a, .wy-menu-vertical li.toctree-l3.current li.toctree-l4>a {
+  background: var(--color-bg-side-nav);
+}
+
+.rst-content .highlighted {
+  background: #eedd85;
+  box-shadow: 0 0 0 2px #eedd85;
+  font-weight: 600;
+}
+
+.wy-side-nav-search input[type=text],
+html.writer-html5 .rst-content table.docutils th {
+  color: var(--color-text-body);
+}
+
+.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,
+.wy-table-backed,
+.wy-table-odd td,
+.wy-table-striped tr:nth-child(2n-1) td {
+  background-color: var(--color-bg-body-alt);
+}
+
+.rst-content table.docutils,
+.wy-table-bordered-all,
+html.writer-html5 .rst-content table.docutils th,
+.rst-content table.docutils td,
+.wy-table-bordered-all td,
+hr {
+  border-color: var(--color-border) !important;
+}
+
+::selection {
+  background: var(--color-text-selection);
+}
+
+/* Ridiculous rules are taken from sphinx_rtd */
+.rst-content .admonition-title,
+.wy-alert-title {
+  color: var(--color-text-body-light);
+}
+
+.rst-content .hint,
+.rst-content .important,
+.rst-content .tip,
+.rst-content .wy-alert-success,
+.wy-alert.wy-alert-success {
+  background: var(--color-success-body);
+}
+
+.rst-content .hint .admonition-title,
+.rst-content .hint .wy-alert-title,
+.rst-content .important .admonition-title,
+.rst-content .important .wy-alert-title,
+.rst-content .tip .admonition-title,
+.rst-content .tip .wy-alert-title,
+.rst-content .wy-alert-success .admonition-title,
+.rst-content .wy-alert-success .wy-alert-title,
+.wy-alert.wy-alert-success .rst-content .admonition-title,
+.wy-alert.wy-alert-success .wy-alert-title {
+  background-color: var(--color-success-title);
+}
+
+.rst-content .admonition-todo,
+.rst-content .attention,
+.rst-content .caution,
+.rst-content .warning,
+.rst-content .wy-alert-warning,
+.wy-alert.wy-alert-warning {
+  background: var(--color-warning-body);
+}
+
+.rst-content .admonition-todo .admonition-title,
+.rst-content .admonition-todo .wy-alert-title,
+.rst-content .attention .admonition-title,
+.rst-content .attention .wy-alert-title,
+.rst-content .caution .admonition-title,
+.rst-content .caution .wy-alert-title,
+.rst-content .warning .admonition-title,
+.rst-content .warning .wy-alert-title,
+.rst-content .wy-alert-warning .admonition-title,
+.rst-content .wy-alert-warning .wy-alert-title,
+.rst-content .wy-alert.wy-alert-warning .admonition-title,
+.wy-alert.wy-alert-warning .rst-content .admonition-title,
+.wy-alert.wy-alert-warning .wy-alert-title {
+  background: var(--color-warning-title);
+}
+
+.rst-content .danger,
+.rst-content .error,
+.rst-content .wy-alert-danger,
+.wy-alert.wy-alert-danger {
+  background: var(--color-danger-body);
+}
+
+.rst-content .danger .admonition-title,
+.rst-content .danger .wy-alert-title,
+.rst-content .error .admonition-title,
+.rst-content .error .wy-alert-title,
+.rst-content .wy-alert-danger .admonition-title,
+.rst-content .wy-alert-danger .wy-alert-title,
+.wy-alert.wy-alert-danger .rst-content .admonition-title,
+.wy-alert.wy-alert-danger .wy-alert-title {
+  background: var(--color-danger-title);
+}
+
+.rst-content .note,
+.rst-content .seealso,
+.rst-content .wy-alert-info,
+.wy-alert.wy-alert-info {
+  background: var(--color-info-body);
+}
+
+.rst-content .note .admonition-title,
+.rst-content .note .wy-alert-title,
+.rst-content .seealso .admonition-title,
+.rst-content .seealso .wy-alert-title,
+.rst-content .wy-alert-info .admonition-title,
+.rst-content .wy-alert-info .wy-alert-title,
+.wy-alert.wy-alert-info .rst-content .admonition-title,
+.wy-alert.wy-alert-info .wy-alert-title {
+  background: var(--color-info-title);
+}
+
+
+
+/* Links */
+a, a:visited,
+.wy-menu-vertical a,
+a.icon.icon-home,
+.wy-menu-vertical li.toctree-l1.current > a.current {
+  color: var(--color-text-anchor);
+  text-decoration: none;
+}
+
+a:hover, .wy-breadcrumbs-aside a {
+  color: var(--color-text-anchor); /* reset */
+}
+
+.rst-versions a, .rst-versions .rst-current-version {
+  color: #var(--color-text-anchor);
+}
+
+.wy-nav-content a.reference, .wy-nav-content a:not([class]) {
+  background-image: linear-gradient(var(--color-border) 0%, var(--color-border) 100%);
+  background-repeat: repeat-x;
+  background-position: 0 100%;
+  background-size: 1px 1px;
+}
+
+.wy-nav-content a.reference:hover, .wy-nav-content a:not([class]):hover {
+  background-image: linear-gradient(rgba(114,83,237,0.45) 0%, rgba(114,83,237,0.45) 100%);
+  background-size: 1px 1px;
+}
+
+.wy-menu-vertical a:hover,
+.wy-menu-vertical li.current a:hover,
+.wy-menu-vertical a:active {
+  background: var(--color-bg-side-nav-hover) !important;
+  color: var(--color-text-body);
+}
+
+.wy-menu-vertical li.toctree-l1.current>a,
+.wy-menu-vertical li.current>a,
+.wy-menu-vertical li.on a {
+  background-color: var(--color-bg-side-nav-hover);
+  border: none;
+  font-weight: normal;
+}
+
+.wy-menu-vertical li.current {
+  background-color: inherit;
+}
+
+.wy-menu-vertical li.current a {
+  border-right: none;
+}
+
+.wy-menu-vertical li.toctree-l2 a,
+.wy-menu-vertical li.toctree-l3 a,
+.wy-menu-vertical li.toctree-l4 a,
+.wy-menu-vertical li.toctree-l5 a,
+.wy-menu-vertical li.toctree-l6 a,
+.wy-menu-vertical li.toctree-l7 a,
+.wy-menu-vertical li.toctree-l8 a,
+.wy-menu-vertical li.toctree-l9 a,
+.wy-menu-vertical li.toctree-l10 a {
+  color: var(--color-text-body);
+}
+
+a.image-reference, a.image-reference:hover {
+  background: none !important;
+}
+
+a.image-reference img {
+  cursor: zoom-in;
+}
+
+
+/* Code blocks */
+.rst-content code, .rst-content tt, code {
+  padding: 0.25em;
+  font-weight: 400;
+  background-color: var(--color-bg-code-block);
+  border: 1px solid var(--color-border);
+  border-radius: 4px;
+}
+
+.rst-content div[class^=highlight], .rst-content pre.literal-block {
+  padding: 0.7rem;
+  margin-top: 0;
+  margin-bottom: 0.75rem;
+  overflow-x: auto;
+  background-color: var(--color-bg-side-nav);
+  border-color: var(--color-border);
+  border-radius: 4px;
+  box-shadow: none;
+}
+
+.rst-content .admonition-title,
+.rst-content div.admonition,
+.wy-alert-title {
+  padding: 10px 12px;
+  border-top-left-radius: 4px;
+  border-top-right-radius: 4px;
+}
+
+.highlight .go {
+  color: inherit;
+}
+
+.highlight .nt {
+  color: var(--color-text-code-nt);
+}
+
+.rst-content code.literal,
+.rst-content tt.literal {
+  border-color: var(--color-border);
+  background-color: var(--color-border);
+  color: var(--color-text-code-inline)
+}
+
+
+/* Search */
+.wy-side-nav-search input[type=text] {
+  border: none;
+  border-radius: 0;
+  background-color: transparent;
+  font-family: inherit;
+  font-size: .85rem;
+  box-shadow: none;
+  padding: .7rem 1rem .7rem 2.8rem;
+  margin: 0;
+}
+
+#rtd-search-form {
+  position: relative;
+}
+
+#rtd-search-form:before {
+  font: normal normal normal 14px/1 FontAwesome;
+  font-size: inherit;
+  text-rendering: auto;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  content: "\f002";
+  color: var(--color-text-alt);
+  position: absolute;
+  left: 1.5rem;
+  top: .7rem;
+}
+
+/* Side nav */
+.wy-side-nav-search {
+  padding: 1rem 0 0 0;
+}
+
+.wy-menu-vertical li a button.toctree-expand {
+  float: right;
+  margin-right: -1.5em;
+  padding: 0 .5em;
+}
+
+.wy-menu-vertical a,
+.wy-menu-vertical li.current>a,
+.wy-menu-vertical li.current li>a {
+  padding-right: 1.5em !important;
+}
+
+.wy-menu-vertical li.current li>a.current {
+  font-weight: 600;
+}
+
+/* Misc spacing */
+.rst-content .admonition-title, .wy-alert-title {
+  padding: 10px 12px;
+}
+
+/* Buttons */
+.btn {
+  display: inline-block;
+  box-sizing: border-box;
+  padding: 0.3em 1em;
+  margin: 0;
+  font-family: inherit;
+  font-size: inherit;
+  font-weight: 500;
+  line-height: 1.5;
+  color: #var(--color-text-anchor);
+  text-decoration: none;
+  vertical-align: baseline;
+  background-color: #f7f7f7;
+  border-width: 0;
+  border-radius: 4px;
+  box-shadow: 0 1px 2px rgba(0,0,0,0.12),0 3px 10px rgba(0,0,0,0.08);
+  appearance: none;
+}
+
+.btn:active {
+  padding: 0.3em 1em;
+}
+
+.rst-content .btn:focus {
+  outline: 1px solid #ccc;
+}
+
+.rst-content .btn-neutral, .rst-content .btn span.fa {
+  color: var(--color-text-body) !important;
+}
+
+.btn-neutral {
+  background-color: var(--color-btn-neutral-bg) !important;
+  color: var(--color-btn-neutral-text) !important;
+  border: 1px solid var(--color-btn-neutral-bg);
+}
+
+.btn:hover, .btn-neutral:hover {
+  background-color: var(--color-btn-neutral-bg-hover) !important;
+}
+
+
+/* Icon overrides */
+.wy-side-nav-search a.icon-home:before {
+  display: none;
+}
+
+.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before {
+  content: "\f106"; /* fa-angle-up */
+}
+
+.fa-plus-square-o:before, .wy-menu-vertical li button.toctree-expand:before {
+  content: "\f107"; /* fa-angle-down */
+}
+
+
+/* Misc */
+.wy-nav-top {
+  line-height: 36px;
+}
+
+.wy-nav-top > i {
+  font-size: 24px;
+  padding: 8px 0 0 2px;
+  color:#var(--color-text-anchor);
+}
+
+.rst-content table.docutils td,
+.rst-content table.docutils th,
+.rst-content table.field-list td,
+.rst-content table.field-list th,
+.wy-table td,
+.wy-table th {
+  padding: 8px 14px;
+}
+
+.dark-mode-toggle {
+  position: absolute;
+  top: 14px;
+  right: 12px;
+  height: 20px;
+  width: 24px;
+  z-index: 10;
+  border: none;
+  background-color: transparent;
+  color: inherit;
+  opacity: 0.7;
+}
+
+.wy-nav-content-wrap {
+  z-index: 20;
+}

docs/_static/custom.css

@@ -1,14 +0,0 @@
-/* override table width restrictions */
-@media screen and (min-width: 767px) {
-
-  .wy-table-responsive table td {
-    /* !important prevents the common CSS stylesheets from
-       overriding this as on RTD they are loaded after this stylesheet */
-    white-space: normal !important;
-  }
-
-  .wy-table-responsive {
-    overflow: visible !important;
-  }
-
-}

docs/_static/js/darkmode.js

@@ -0,0 +1,47 @@
+let toggleButton;
+let icon;
+
+function load() {
+	"use strict";
+
+	toggleButton = document.createElement("button");
+	toggleButton.setAttribute("title", "Toggle dark mode");
+	toggleButton.classList.add("dark-mode-toggle");
+	icon = document.createElement("i");
+	icon.classList.add("fa", darkModeState ? "fa-sun-o" : "fa-moon-o");
+	toggleButton.appendChild(icon);
+	document.body.prepend(toggleButton);
+
+	// Listen for changes in the OS settings
+	// addListener is used because older versions of Safari don't support addEventListener
+	// prefersDarkQuery set in <head>
+	if (prefersDarkQuery) {
+		prefersDarkQuery.addListener(function (evt) {
+			toggleDarkMode(evt.matches);
+		});
+	}
+
+	// Initial setting depending on the prefers-color-mode or localstorage
+	// darkModeState should be set in the document <head> to prevent flash
+	if (darkModeState == undefined) darkModeState = false;
+	toggleDarkMode(darkModeState);
+
+	// Toggles the "dark-mode" class on click and sets localStorage state
+	toggleButton.addEventListener("click", () => {
+		darkModeState = !darkModeState;
+
+		toggleDarkMode(darkModeState);
+		localStorage.setItem("dark-mode", darkModeState);
+	});
+}
+
+function toggleDarkMode(state) {
+	document.documentElement.classList.toggle("dark-mode", state);
+	document.documentElement.classList.toggle("light-mode", !state);
+	icon.classList.remove("fa-sun-o");
+	icon.classList.remove("fa-moon-o");
+	icon.classList.add(state ? "fa-sun-o" : "fa-moon-o");
+	darkModeState = state;
+}
+
+document.addEventListener("DOMContentLoaded", load);

docs/_templates/layout.html

@@ -0,0 +1,13 @@
+{% extends "!layout.html" %}
+{% block extrahead %}
+    <script>
+        // MediaQueryList object
+        const prefersDarkQuery = window.matchMedia("(prefers-color-scheme: dark)");
+        const lsDark = localStorage.getItem("dark-mode");
+        let darkModeState = lsDark !== null ? lsDark == "true" : prefersDarkQuery.matches;
+
+        document.documentElement.classList.toggle("dark-mode", darkModeState);
+        document.documentElement.classList.toggle("light-mode", !darkModeState);
+    </script>
+    {{ super() }}
+{% endblock %}

docs/administration.rst

@@ -379,7 +379,7 @@ the naming scheme.
 
 The command takes no arguments and processes all your documents at once.
 
-Learn how to use :ref:`Management Utilities<Management utilities>`.
+Learn how to use :ref:`Management Utilities<utilities-management-commands>`.
 
 
 .. _utilities-sanity-checker:

docs/advanced_usage.rst

@@ -179,6 +179,7 @@ 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:
     ...
@@ -199,7 +200,7 @@ Troubleshooting:
 - 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
+.. _post-consumption-example.sh: https://github.com/paperless-ngx/paperless-ngx/blob/main/scripts/post-consumption-example.sh
 
 .. _advanced-file_name_handling:
 
@@ -242,7 +243,7 @@ will create a directory structure as follows:
     last filename a document was stored as. If you do rename a file, paperless will
     report your files as missing and won't be able to find them.
 
-Paperless provides the following placeholders withing filenames:
+Paperless provides the following placeholders within filenames:
 
 * ``{asn}``: The archive serial number of the document, or "none".
 * ``{correspondent}``: The name of the correspondent, or "none".

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::

docs/changelog.rst

@@ -5,6 +5,87 @@
 Changelog
 *********
 
+paperless-ngx 1.7.0
+###################
+
+Breaking Changes
+
+* ``PAPERLESS_URL`` is now required when using a reverse proxy. See `#674`_.
+
+Features
+
+* Allow setting more than one tag in mail rules `@jonasc`_ (#270)
+* global drag'n'drop `@shamoon`_ (#283).
+* Fix: download buttons should disable while waiting `@shamoon`_ (#630).
+* Update checker `@shamoon`_ (#591).
+* Show prompt on password-protected pdfs `@shamoon`_ (#564).
+* Filtering query params aka browser navigation for filtering `@shamoon`_ (#540).
+* Clickable tags in dashboard widgets `@shamoon`_ (#515).
+* Add bottom pagination `@shamoon`_ (#372).
+* Feature barcode splitter `@gador`_ (#532).
+* App loading screen `@shamoon`_ (#298).
+* Use progress bar for delayed buttons `@shamoon`_ (#415).
+* Add minimum length for documents text filter `@shamoon`_ (#401).
+* Added nav buttons in the document detail view `@GruberViktor`_ (#273).
+* Improve date keyboard input `@shamoon`_ (#253).
+* Color theming `@shamoon`_ (#243).
+* Parse dates when entered without separators `@GruberViktor`_ (#250).
+
+Bug Fixes
+
+* add "localhost" to ALLOWED_HOSTS `@gador`_ (#700).
+* Fix: scanners table `@qcasey`_ (#690).
+* Adds wait for file before consuming `@stumpylog`_ (#483).
+* Fix: frontend document editing erases time data `@shamoon`_ (#654).
+* Increase length of SavedViewFilterRule `@stumpylog`_ (#612).
+* Fixes attachment filename matching during mail fetching `@stumpylog`_ (#680).
+* Add ``PAPERLESS_URL`` env variable & CSRF var `@shamoon`_ (#674).
+* Fix: download buttons should disable while waiting `@shamoon`_ (#630).
+* Fixes downloaded filename, add more consumer ignore settings `@stumpylog`_ (#599).
+* FIX BUG: case-sensitive matching was not possible `@danielBreitlauch`_ (#594).
+* uses shutil.move instead of rename `@gador`_ (#617).
+* Fix npm deps 01.02.22 2 `@shamoon`_ (#610).
+* Fix npm dependencies 01.02.22 `@shamoon`_ (#600).
+* fix issue 416: implement PAPERLESS_OCR_MAX_IMAGE_PIXELS `@hacker-h`_ (#441).
+* fix: exclude cypress from build in Dockerfile `@FrankStrieter`_ (#526).
+* Corrections to pass pre-commit hooks `@schnuffle`_ (#454).
+* Fix 311 unable to click checkboxes in document list `@shamoon`_ (#313).
+* Fix imap tools bug `@stumpylog`_ (#393).
+* Fix filterable dropdown buttons arent translated `@shamoon`_ (#366).
+* Fix 224: "Auto-detected date is day before receipt date" `@a17t`_ (#246).
+* Fix minor sphinx errors `@shamoon`_ (#322).
+* Fix page links hidden `@shamoon`_ (#314).
+* Fix: Include excluded items in dropdown count `@shamoon`_ (#263).
+
+Translation
+
+* `@miku323`_ contributed to Slovenian translation.
+* `@FaintGhost`_ contributed to Chinese Simplified translation.
+* `@DarkoBG79`_ contributed to Serbian translation.
+* `Kemal Secer`_ contributed to Turkish translation.
+* `@Prominence`_ contributed to Belarusian translation.
+
+Documentation
+
+* Fix: scanners table `@qcasey`_ (#690).
+* Add `PAPERLESS_URL` env variable & CSRF var `@shamoon`_ (#674).
+* Fixes downloaded filename, add more consumer ignore settings `@stumpylog`_ (#599).
+* fix issue 416: implement ``PAPERLESS_OCR_MAX_IMAGE_PIXELS`` `@hacker-h`_ (#441).
+* Fix minor sphinx errors `@shamoon`_ (#322).
+
+Maintenance
+
+* Add ``PAPERLESS_URL`` env variable & CSRF var `@shamoon`_ (#674).
+* Chore: Implement release-drafter action for Changelogs `@qcasey`_ (#669).
+* Chore: Add CODEOWNERS `@qcasey`_ (#667).
+* Support docker-compose v2 in install `@stumpylog`_ (#611).
+* Add Belarusian localization `@shamoon`_ (#588).
+* Add Turkish localization `@shamoon`_ (#536).
+* Add Serbian localization `@shamoon`_ (#504).
+* Create PULL_REQUEST_TEMPLATE.md `@shamoon`_ (#304).
+* Add Chinese localization `@shamoon`_ (#247).
+* Add Slovenian language for frontend `@shamoon`_ (#315).
+
 paperless-ngx 1.6.0
 ###################
 
@@ -23,6 +104,7 @@ Version 1.6.0 merges several pending PRs from jonaswinkler's repo and includes n
 * `@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``.
@@ -34,6 +116,10 @@ Version 1.6.0 merges several pending PRs from jonaswinkler's repo and includes n
 * `@shamoon`_ created a slick new logo (#165).
 * `@tim-vogel`_ fixed exports missing groups (#193).
 
+Known issues:
+
+* 1.6.0 included a malformed package-lock.json, as a result users who want to build the docker image themselves need to change line 6 of the ``Dockerfile`` to ``RUN npm update npm -g && npm install --legacy-peer-deps``.
+
 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`_
@@ -51,8 +137,11 @@ Another big thanks to the people who have contributed translations:
 * 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.
 
@@ -63,7 +152,7 @@ Support for Python 3.6 was dropped.
 * `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.
 
@@ -76,7 +165,7 @@ This is a maintenance release.
   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.
@@ -85,7 +174,7 @@ paperless-ng 1.4.4
 * Updated translations.
 
 paperless-ng 1.4.3
-##################
+==================
 
 * Additions and changes
 
@@ -102,12 +191,12 @@ paperless-ng 1.4.3
   * 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.
 
@@ -123,7 +212,7 @@ paperless-ng 1.4.1
   ``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.
 
@@ -136,7 +225,7 @@ paperless-ng 1.4.0
 
   * New URL pattern for accessing documents by ASN directly (http://<paperless>/asn/123)
 
-  * Added logging when executing pre- and post-consume scripts.
+  * Added logging when executing pre* and post-consume scripts.
 
   * Better error logging during document consumption.
 
@@ -156,7 +245,7 @@ paperless-ng 1.4.0
   (see :ref:`administration-index`).
 
 paperless-ng 1.3.2
-##################
+==================
 
 * Added translation into Portuguese.
 
@@ -171,7 +260,7 @@ paperless-ng 1.3.2
   * 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.
 
@@ -196,7 +285,7 @@ paperless-ng 1.3.1
   * 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.
 
@@ -222,7 +311,7 @@ This release contains new database migrations.
 
 
 paperless-ng 1.2.1
-##################
+==================
 
 * `Rodrigo Avelino <https://github.com/rodavelino>`_ translated Paperless into Portuguese (Brazil)!
 
@@ -235,7 +324,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
 
@@ -259,14 +348,14 @@ paperless-ng 1.2.0
 * Paperless no longer depends on ``libpoppler-cpp-dev``.
 
 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`.
@@ -276,7 +365,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.
 
@@ -292,7 +381,7 @@ paperless-ng 1.1.2
 * Some memory usage optimizations.
 
 paperless-ng 1.1.1
-##################
+==================
 
 This release contains new database migrations.
 
@@ -313,7 +402,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
 
@@ -373,7 +462,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.
 
@@ -396,7 +485,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.
@@ -444,13 +533,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
 
@@ -492,13 +581,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
 
@@ -531,7 +620,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!
 
@@ -565,7 +654,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.
 
@@ -574,7 +663,7 @@ This release addresses two severe issues with the previous release.
 
 
 paperless-ng 0.9.7
-##################
+==================
 
 
 * Front end
@@ -616,7 +705,7 @@ paperless-ng 0.9.7
 
 
 paperless-ng 0.9.6
-##################
+==================
 
 This release focusses primarily on many small issues with the UI.
 
@@ -657,7 +746,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.
@@ -707,7 +796,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:
 
@@ -735,7 +824,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.
@@ -753,7 +842,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)
@@ -783,7 +872,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
@@ -791,7 +880,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.
@@ -1572,6 +1661,16 @@ bulk of the work on this big change.
 .. _@azapater: https://github.com/azapater
 .. _@tim-vogel: https://github.com/tim-vogel
 .. _@jschpp: https://github.com/jschpp
+.. _@schnuffle: https://github.com/schnuffle
+.. _@GruberViktor: https://github.com/gruberviktor
+.. _@hacker-h: https://github.com/hacker-h
+.. _@danielBreitlauch: https://github.com/danielbreitlauch
+.. _@miku323: https://github.com/miku323
+.. _@FaintGhost: https://github.com/FaintGhost
+.. _@DarkoBG79: https://github.com/DarkoBG79
+.. _Kemal Secer: https://crowdin.com/profile/kemal.secer
+.. _@Prominence: https://github.com/Prominence
+.. _@jonasc: https://github.com/jonasc
 
 .. _#20: https://github.com/the-paperless-project/paperless/issues/20
 .. _#44: https://github.com/the-paperless-project/paperless/issues/44
@@ -1680,6 +1779,7 @@ bulk of the work on this big change.
 .. _#488: https://github.com/the-paperless-project/paperless/pull/488
 .. _#489: https://github.com/the-paperless-project/paperless/pull/489
 .. _#492: https://github.com/the-paperless-project/paperless/pull/492
+.. _#674: https://github.com/paperless-ngx/paperless-ngx/pull/674
 
 .. _a new home on Docker Hub: https://hub.docker.com/r/danielquinn/paperless/
 .. _optipng: http://optipng.sourceforge.net/

docs/conf.py

@@ -15,7 +15,7 @@ extensions = [
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-# templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
 source_suffix = ".rst"
@@ -119,6 +119,16 @@ html_theme_path = []
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+html_css_files = [
+    "css/custom.css",
+]
+
+html_js_files = [
+    "js/darkmode.js",
+]
+
 # 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.

docs/configuration.rst

@@ -130,6 +130,8 @@ PAPERLESS_LOGROTATE_MAX_BACKUPS=<num>
 
     Defaults to 20.
 
+.. _hosting-and-security:
+
 Hosting & Security
 ##################
 
@@ -142,7 +144,24 @@ PAPERLESS_SECRET_KEY=<key>
 
     Default is listed in the file ``src/paperless/settings.py``.
 
-PAPERLESS_ALLOWED_HOSTS<comma-separated-list>
+PAPERLESS_URL=<url>
+    This setting can be used to set the three options below (ALLOWED_HOSTS,
+    CORS_ALLOWED_HOSTS and CSRF_TRUSTED_ORIGINS). If the other options are
+    set the values will be combined with this one. Do not include a trailing
+    slash. E.g. https://paperless.domain.com
+
+    Defaults to empty string, leaving the other settings unaffected.
+
+PAPERLESS_CSRF_TRUSTED_ORIGINS=<comma-separated-list>
+    A list of trusted origins for unsafe requests (e.g. POST). As of Django 4.0
+    this is required to access the Django admin via the web.
+    See https://docs.djangoproject.com/en/4.0/ref/settings/#csrf-trusted-origins
+
+    Can also be set using PAPERLESS_URL (see above).
+
+    Defaults to empty string, which does not add any origins to the trusted list.
+
+PAPERLESS_ALLOWED_HOSTS=<comma-separated-list>
     If you're planning on putting Paperless on the open internet, then you
     really should set this value to the domain name you're using.  Failing to do
     so leaves you open to HTTP host header attacks:
@@ -151,12 +170,19 @@ PAPERLESS_ALLOWED_HOSTS<comma-separated-list>
     Just remember that this is a comma-separated list, so "example.com" is fine,
     as is "example.com,www.example.com", but NOT " example.com" or "example.com,"
 
+    Can also be set using PAPERLESS_URL (see above).
+
+    If manually set, please remember to include "localhost". Otherwise docker
+    healthcheck will fail.
+
     Defaults to "*", which is all hosts.
 
-PAPERLESS_CORS_ALLOWED_HOSTS<comma-separated-list>
+PAPERLESS_CORS_ALLOWED_HOSTS=<comma-separated-list>
     You need to add your servers to the list of allowed hosts that can do CORS
     calls. Set this to your public domain name.
 
+    Can also be set using PAPERLESS_URL (see above).
+
     Defaults to "http://localhost:8000".
 
 PAPERLESS_FORCE_SCRIPT_NAME=<path>
@@ -185,7 +211,7 @@ PAPERLESS_AUTO_LOGIN_USERNAME=<username>
 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
+    where you can not run the `createsuperuser` command separately, such as Kubernetes
     or AWS ECS.
 
     Requires `PAPERLESS_ADMIN_PASSWORD` to be set.
@@ -389,6 +415,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
@@ -462,8 +497,9 @@ requires are as follows:
         gotenberg:
             image: gotenberg/gotenberg:7
             restart: unless-stopped
-            environment:
+            command:
-                CHROMIUM_DISABLE_ROUTES: 1
+                - "gotenberg"
+                - "--chromium-disable-routes=true"
 
         tika:
             image: apache/tika
@@ -473,6 +509,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
 ###############
 
@@ -528,6 +566,10 @@ PAPERLESS_WORKER_TIMEOUT=<num>
     large documents within the default 1800 seconds. So extending this timeout
     may prove to be useful on weak hardware setups.
 
+PAPERLESS_WORKER_RETRY=<num>
+    If PAPERLESS_WORKER_TIMEOUT has been configured, the retry time for a task can
+    also be configured.  By default, this value will be set to 10s more than the
+    worker timeout.  This value should never be set less than the worker timeout.
 
 PAPERLESS_TIME_ZONE=<timezone>
     Set the time zone here.
@@ -576,6 +618,27 @@ PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS=<bool>
 
     Defaults to false.
 
+PAPERLESS_CONSUMER_ENABLE_BARCODES=<bool>
+    Enables the scanning and page separation based on detected barcodes.
+    This allows for scanning and adding multiple documents per uploaded
+    file, which are separated by one or multiple barcode pages.
+
+    For ease of use, it is suggested to use a standardized separation page,
+    e.g. `here <https://www.alliancegroup.co.uk/patch-codes.htm>`_.
+
+    If no barcodes are detected in the uploaded file, no page separation
+    will happen.
+
+    Defaults to false.
+
+
+PAPERLESS_CONSUMER_BARCODE_STRING=PATCHT
+  Defines the string to be detected as a separator barcode.
+  If paperless is used with the PATCH-T separator pages, users
+  shouldn't change this.
+
+  Defaults to "PATCHT"
+
 
 PAPERLESS_CONVERT_MEMORY_LIMIT=<num>
     On smaller systems, or even in the case of Very Large Documents, the consumer
@@ -659,7 +722,7 @@ PAPERLESS_CONSUMER_IGNORE_PATTERNS=<json>
 
     This can be adjusted by configuring a custom json array with patterns to exclude.
 
-    Defautls to ``[".DS_STORE/*", "._*", ".stfolder/*"]``.
+    Defaults to ``[".DS_STORE/*", "._*", ".stfolder/*", ".stversions/*", ".localized/*", "desktop.ini"]``.
 
 Binaries
 ########
@@ -752,3 +815,26 @@ PAPERLESS_OCR_LANGUAGES=<list>
         PAPERLESS_OCR_LANGUAGE=tur
 
     Defaults to none, which does not install any additional languages.
+
+
+.. _configuration-update-checking:
+
+Update Checking
+###############
+
+PAPERLESS_ENABLE_UPDATE_CHECK=<bool>
+    Enable (or disable) the automatic check for available updates. This feature is disabled
+    by default but if it is not explicitly set Paperless-ngx will show a message about this.
+
+    If enabled, the feature works by pinging the the Github API for the latest release e.g.
+    https://api.github.com/repos/paperless-ngx/paperless-ngx/releases/latest
+    to determine whether a new version is available.
+
+    Actual updating of the app must still be performed manually.
+
+    Note that for users of thirdy-party containers e.g. linuxserver.io this notification
+    may be 'ahead' of a new release from the third-party maintainers.
+
+    In either case, no tracking data is collected by the app in any way.
+
+    Defaults to none, which disables the feature.

docs/contributing.rst

@@ -1,145 +0,0 @@
-.. _contributing:
-
-Contributing to Paperless
-#########################
-
-.. warning::
-
-    This section is not updated to paperless-ngx 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,13 +1,13 @@
 .. _extending:
 
-Paperless development
+Paperless-ngx Development
-#####################
+#########################
 
 This section describes the steps you need to take to start development on paperless-ngx.
 
 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
+*   ``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
@@ -23,6 +23,33 @@ Apart from that, the folder structure is as follows:
 *   ``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
 =============================
 
@@ -37,13 +64,19 @@ To do the setup you need to perform the steps from the following chapters in a c
 
         $ npm install -g @angular/cli
 
-4.  Create ``consume`` and ``media`` folders in the cloned root folder.
+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
 
-5.  You can now either ...
+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
@@ -53,41 +86,42 @@ To do the setup you need to perform the steps from the following chapters in a c
 
             docker run -d -p 6379:6379 --restart unless-stopped redis:latest
 
-6.  Install the python dependencies by performing in the src/ directory.
+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.
 
-7.  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:
+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
 
-8.  Apply migrations and create a superuser for your dev instance:
+9.  Apply migrations and create a superuser for your dev instance:
 
     .. code:: shell-session
 
         python3 manage.py migrate
         python3 manage.py createsuperuser
 
-9.  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.
+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
 
-10. Login with the superuser credentials provided in step 8 at ``http://localhost:8000`` to create a session that enables you to use the backend.
+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.
 
 Configure the IDE to use the src/ folder as the base source folder. Configure the following
@@ -108,8 +142,9 @@ 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 ``black`` to format your code.
+*   Coding style is enforced by the Git pre-commit hooks.  These will ensure your code is formatted and do some
-*   Run ``pycodestyle`` to test your code for issues with the configured code style settings.
+    linting when you do a `git commit`.
+*   You can also run ``black`` manually to format your code
 
     .. note::
 
@@ -121,9 +156,8 @@ Testing and code style:
 Front end development
 =====================
 
-The front end is build using angular. I use the ``Code - OSS`` IDE for development.
+The front end is built using Angular. In order to get started, you need ``npm``.
-
+Install the Angular CLI interface with
-In order to get started, you need ``npm``. Install the Angular CLI interface with
 
 .. code:: shell-session
 
@@ -152,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
@@ -361,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

@@ -7,7 +7,7 @@ Frequently asked questions
 
 **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
+GitHub discussions and "up-voted" by the community but this is not a guarantee the feature
 will be implemented. This project will always be open to collaboration in the form of PRs,
 ideas etc.
 
@@ -81,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>`_,
+**A:** Paperless-ngx is available as `community app <https://unraid.net/community/apps?q=paperless-ngx>`_
-`Uli Fahrer <https://github.com/Tooa>`_ created a container template for that.
+in Unraid. `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.
 
 **Q:** *How do I run this on my toaster?*
 

docs/index.rst

@@ -70,7 +70,6 @@ Contents
    faq
    troubleshooting
    extending
-   contributing
    scanners
    screenshots
    changelog

docs/scanners.rst

@@ -13,43 +13,43 @@ that works right for you based on recommendations from other Paperless users.
 Physical scanners
 =================
 
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
 | Brand   | Model          | Supports                                 | Recommended By |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-|         |                | FTP | NFS | SMB | SMTP | API [1]_ |                |
+|         |                | FTP | SFTP | NFS | SMB | SMTP | API [1]_ |                |
-+=========+================+=====+=====+=====+======+==========+================+
++=========+================+=====+======+=====+=====+======+==========+================+
-| Brother | `ADS-1700W`_   | yes |     | yes | yes  |          |`holzhannes`_   |
+| Brother | `ADS-1700W`_   | yes |      |     | yes | yes  |          |`holzhannes`_   |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Brother | `ADS-1600W`_   | yes |     | yes | yes  |          |`holzhannes`_   |
+| Brother | `ADS-1600W`_   | yes |      |     | yes | yes  |          |`holzhannes`_   |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Brother | `ADS-1500W`_   | yes |     | yes | yes  |          |`danielquinn`_  |
+| Brother | `ADS-1500W`_   | yes |      |     | yes | yes  |          |`danielquinn`_  |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Brother | `ADS-1100W`_   | yes |     |     |      |          |`ytzelf`_       |
+| Brother | `ADS-1100W`_   | yes |      |     |     |      |          |`ytzelf`_       |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Brother | `ADS-2800W`_   | yes | yes |     | yes  | yes      |`philpagel`_    |
+| Brother | `ADS-2800W`_   | yes | yes  |     | yes | yes  |          |`philpagel`_    |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Brother | `MFC-J6930DW`_ | yes |     |     |      |          |`ayounggun`_    |
+| Brother | `MFC-J6930DW`_ | yes |      |     |     |      |          |`ayounggun`_    |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Brother | `MFC-L5850DW`_ | yes |     |     | yes  |          |`holzhannes`_   |
+| Brother | `MFC-L5850DW`_ | yes |      |     |     | yes  |          |`holzhannes`_   |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Brother | `MFC-L2750DW`_ | yes |     | yes | yes  |          |`muued`_        |
+| Brother | `MFC-L2750DW`_ | yes |      |     | yes | yes  |          |`muued`_        |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Brother | `MFC-J5910DW`_ | yes |     |     |      |          |`bmsleight`_    |
+| Brother | `MFC-J5910DW`_ | yes |      |     |     |      |          |`bmsleight`_    |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Brother | `MFC-8950DW`_  | yes |     |     | yes  | yes      |`philpagel`_    |
+| Brother | `MFC-8950DW`_  | yes |      |     | yes | yes  |          |`philpagel`_    |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Brother | `MFC-9142CDN`_ | yes |     | yes |      |          |`REOLDEV`_      |
+| Brother | `MFC-9142CDN`_ | yes |      |     | yes |      |          |`REOLDEV`_      |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Fujitsu | `ix500`_       | yes |     | yes |      |          |`eonist`_       |
+| Fujitsu | `ix500`_       | yes |      |     | yes |      |          |`eonist`_       |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Epson   | `ES-580W`_     | yes |     | yes | yes  |          |`fignew`_       |
+| Epson   | `ES-580W`_     | yes |      |     | yes | yes  |          |`fignew`_       |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Epson   | `WF-7710DWF`_  | yes |     | yes |      |          |`Skylinar`_     |
+| Epson   | `WF-7710DWF`_  | yes |      |     | yes |      |          |`Skylinar`_     |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Fujitsu | `S1300i`_      | yes |     | yes |      |          |`jonaswinkler`_ |
+| Fujitsu | `S1300i`_      | yes |      |     | yes |      |          |`jonaswinkler`_ |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
-| Doxie   | `Q2`_          |     |     |     |      | yes      |`Unkn0wnCat`_   |
+| Doxie   | `Q2`_          |     |      |     |     |      | yes      |`Unkn0wnCat`_   |
-+---------+----------------+-----+-----+-----+------+----------+----------------+
++---------+----------------+-----+------+-----+-----+------+----------+----------------+
 
 .. _MFC-L5850DW: https://www.brother-usa.com/products/mfcl5850dw
 .. _MFC-L2750DW: https://www.brother.de/drucker/laserdrucker/mfc-l2750dw
@@ -112,3 +112,22 @@ On Android, you can use these applications in combination with one of the :ref:`
 
 .. _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,42 +4,60 @@
 Screenshots
 ***********
 
-This is what paperless-ngx looks like. You shouldn't use paperless to index
+This is what Paperless-ngx looks like.
-research papers though, its a horrible tool for that job.
 
 The dashboard shows customizable views on your document and allows document uploads:
 
 .. image:: _static/screenshots/dashboard.png
+    :target: _static/screenshots/dashboard.png
 
 The document list provides three different styles to scroll through your documents:
 
 .. image:: _static/screenshots/documents-table.png
+    :target: _static/screenshots/documents-table.png
 .. image:: _static/screenshots/documents-smallcards.png
+    :target: _static/screenshots/documents-smallcards.png
 .. image:: _static/screenshots/documents-largecards.png
+    :target: _static/screenshots/documents-largecards.png
+
+Paperless-ngx also supports "dark mode":
+
+.. image:: _static/screenshots/documents-smallcards-dark.png
+    :target: _static/screenshots/documents-smallcards-dark.png
 
 Extensive filtering mechanisms:
 
 .. image:: _static/screenshots/documents-filter.png
+    :target: _static/screenshots/documents-filter.png
 
-Side-by-side editing of documents. Optimized for 1080p.
+Bulk editing of document tags, correspondents, etc.:
+
+.. image:: _static/screenshots/bulk-edit.png
+    :target: _static/screenshots/bulk-edit.png
+
+Side-by-side editing of documents:
 
 .. image:: _static/screenshots/editing.png
+    :target: _static/screenshots/editing.png
 
 Tag editing. This looks about the same for correspondents and document types.
 
 .. image:: _static/screenshots/new-tag.png
+    :target: _static/screenshots/new-tag.png
 
 Searching provides auto complete and highlights the results.
 
 .. image:: _static/screenshots/search-preview.png
+    :target: _static/screenshots/search-preview.png
 .. image:: _static/screenshots/search-results.png
+    :target: _static/screenshots/search-results.png
 
 Fancy mail filters!
 
 .. image:: _static/screenshots/mail-rules-edited.png
+    :target: _static/screenshots/mail-rules-edited.png
 
-Mobile support in the future? This kinda works, however some layouts are still
+Mobile devices are supported.
-too wide.
 
 .. image:: _static/screenshots/mobile.png
-
+    :target: _static/screenshots/mobile.png

docs/setup.rst

@@ -110,7 +110,7 @@ performs all the steps described in :ref:`setup-docker_hub` automatically.
 
     .. code:: shell-session
 
-        $ bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/install-paperless-ngx.sh)"
+        $ bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
 
 .. _setup-docker_hub:
 
@@ -291,12 +291,14 @@ writing. Windows is not and will never be supported.
     *   ``libpq-dev`` for PostgreSQL
     *   ``libmagic-dev`` for mime type detection
     *   ``mime-support`` for mime type detection
+    *   ``libzbar0`` for barcode detection
+    *   ``poppler-utils`` for barcode 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
+        python3 python3-pip python3-dev imagemagick fonts-liberation optipng gnupg libpq-dev libmagic-dev mime-support libzbar0 poppler-utils
 
     These dependencies are required for OCRmyPDF, which is used for text recognition.
 
@@ -345,6 +347,8 @@ writing. Windows is not and will never be supported.
         paperless stores its data. If you like, you can point both to the same directory.
     *   ``PAPERLESS_SECRET_KEY`` should be a random sequence of characters. It's used for authentication. Failure
         to do so allows third parties to forge authentication credentials.
+    *   ``PAPERLESS_URL`` if you are behind a reverse proxy. This should point to your domain. Please see 
+        :ref:`configuration` for more information.
 
     Many more adjustments can be made to paperless, especially the OCR part. The following options are recommended
     for everyone:
@@ -724,6 +728,8 @@ configuring some options in paperless can help improve performance immensely:
     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`.
 
@@ -782,4 +788,6 @@ the following configuration is required for paperless to operate:
         }
     }
 
+The ``PAPERLESS_URL`` configuration variable is also required when using a reverse proxy. Please refer to the :ref:`hosting-and-security` docs.
+
 Also read `this <https://channels.readthedocs.io/en/stable/deploying.html#nginx-supervisor-ubuntu>`__, towards the end of the section.

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
 ######################################
@@ -106,7 +119,7 @@ You may experience these errors when using the optional TIKA integration:
 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://gotenberg.dev/docs/modules/api#properties>`__).
+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
@@ -114,9 +127,10 @@ If using docker-compose, this is achieved by the following configuration change
     gotenberg:
         image: gotenberg/gotenberg:7
         restart: unless-stopped
-        environment:
+        command:
-            CHROMIUM_DISABLE_ROUTES: 1
+            - "gotenberg"
-            API_PROCESS_TIMEOUT: 60
+            - "--chromium-disable-routes=true"
+            - "--api-timeout=60"
 
 Permission denied errors in the consumption directory
 #####################################################

docs/usage_overview.rst

@@ -62,7 +62,7 @@ your documents:
 
 1.  OCR the document, if it has no text. Digital documents usually have text,
     and this step will be skipped for those documents.
-2.  Paperless will create an archiveable PDF/A document from your document.
+2.  Paperless will create an archivable PDF/A document from your document.
     If this document is coming from your scanner, it will have embedded selectable text.
 3.  Paperless performs automatic matching of tags, correspondents and types on the
     document before storing it in the database.
@@ -102,12 +102,14 @@ files from the scanner.  Typically, you're looking at an FTP server like
 
 .. TODO: hyperref to configuration of the location of this magic folder.
 
-Dashboard upload
+Web UI Upload
-================
+=============
 
 The dashboard has a file drop field to upload documents to paperless. Simply drag a file
 onto this field or select a file with the file dialog. Multiple files are supported.
 
+You can also upload documents on any other page of the web UI by dragging-and-dropping
+files into your browser window.
 
 .. _usage-mobile_upload:
 
@@ -178,6 +180,14 @@ These are as follows:
     automatically or manually and tell paperless to move them to yet another folder
     after consumption. It's up to you.
 
+.. note::
+
+    When defining a mail rule with a folder, you may need to try different characters to
+    define how the sub-folders are separated.  Common values include ".", "/" or "|", but
+    this varies by the mail server.  Unfortunately, this isn't a value we can determine
+    automatically.  Either check the documentation for your mail server, or check for
+    errors in the logs and try different folder separator values.
+
 .. note::
 
     Paperless will process the rules in the order defined in the admin page.

install-paperless-ngx.sh

@@ -3,16 +3,16 @@
 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
@@ -24,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
@@ -47,25 +47,29 @@ if [[ $(id -u) == "0" ]] ; then
 	exit 1
 fi
 
-if [[ -z $(which wget) ]] ; then
+if ! command -v wget &> /dev/null ; then
 	echo "wget executable not found. Is wget installed?"
 	exit 1
 fi
 
-if [[ -z $(which docker) ]] ; then
+if ! command -v docker &> /dev/null ; then
 	echo "docker executable not found. Is docker installed?"
 	exit 1
 fi
 
-if [[ -z $(which docker-compose) ]] ; then
+DOCKER_COMPOSE_CMD="docker-compose"
+if ! command -v ${DOCKER_COMPOSE_CMD} ; then
+	if docker compose version &> /dev/null ; then
+		DOCKER_COMPOSE_CMD="docker compose"
+	else
 		echo "docker-compose executable not found. Is docker-compose installed?"
 		exit 1
 	fi
+fi
 
 # 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.
-docker stats --no-stream 2>/dev/null 1>&2
+if ! docker stats --no-stream &> /dev/null ; then
-if [ $? -ne 0 ] ; 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."
@@ -88,6 +92,14 @@ echo ""
 echo "1. Application configuration"
 echo "============================"
 
+echo ""
+echo "The URL paperless will be available at. This is required if the"
+echo "installation will be accessible via the web, otherwise can be left blank."
+echo ""
+
+ask "URL" ""
+URL=$ask_result
+
 echo ""
 echo "The port on which the paperless webserver will listen for incoming"
 echo "connections."
@@ -162,7 +174,7 @@ 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 ""
@@ -228,7 +240,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
@@ -236,7 +248,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
@@ -274,6 +286,7 @@ if [[ "$DATABASE_BACKEND" == "postgres" ]] ; then
 	fi
 fi
 echo ""
+echo "URL: $URL"
 echo "Port: $PORT"
 echo "Database: $DATABASE_BACKEND"
 echo "Tika enabled: $TIKA_ENABLED"
@@ -285,7 +298,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..."
@@ -301,14 +314,17 @@ if [[ $TIKA_ENABLED == "yes" ]] ; then
 	DOCKER_COMPOSE_VERSION="$DOCKER_COMPOSE_VERSION-tika"
 fi
 
-wget "https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/docker/compose/docker-compose.$DOCKER_COMPOSE_VERSION.yml" -O docker-compose.yml
+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/master/docker/compose/.env" -O .env
+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"
 
 {
+	if [[ ! $URL == "" ]] ; then
+		echo "PAPERLESS_URL=$URL"
+	fi
 	if [[ ! $USERMAP_UID == "1000" ]] ; then
 		echo "USERMAP_UID=$USERMAP_UID"
 	fi
@@ -318,7 +334,7 @@ DEFAULT_LANGUAGES="deu eng fra ita spa"
 	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
@@ -329,18 +345,31 @@ 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
 
-docker-compose pull
+# 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 run --rm -e DJANGO_SUPERUSER_PASSWORD="$PASSWORD" webserver createsuperuser --noinput --username "$USERNAME" --email "$EMAIL"
 
-docker-compose up -d
+${DOCKER_COMPOSE_CMD} pull
+
+${DOCKER_COMPOSE_CMD} run --rm -e DJANGO_SUPERUSER_PASSWORD="$PASSWORD" webserver createsuperuser --noinput --username "$USERNAME" --email "$EMAIL"
+
+${DOCKER_COMPOSE_CMD} up -d

paperless.conf.example

@@ -27,8 +27,10 @@
 # Security and hosting
 
 #PAPERLESS_SECRET_KEY=change-me
-#PAPERLESS_ALLOWED_HOSTS=example.com,www.example.com
+#PAPERLESS_URL=https://example.com
-#PAPERLESS_CORS_ALLOWED_HOSTS=http://example.com,http://localhost:8000
+#PAPERLESS_CSRF_TRUSTED_ORIGINS=https://example.com # can be set using PAPERLESS_URL
+#PAPERLESS_ALLOWED_HOSTS=example.com,www.example.com # can be set using PAPERLESS_URL
+#PAPERLESS_CORS_ALLOWED_HOSTS=https://localhost:8080,https://example.com # can be set using PAPERLESS_URL
 #PAPERLESS_FORCE_SCRIPT_NAME=
 #PAPERLESS_STATIC_URL=/static/
 #PAPERLESS_AUTO_LOGIN_USERNAME=
@@ -58,8 +60,10 @@
 #PAPERLESS_CONSUMER_POLLING=10
 #PAPERLESS_CONSUMER_DELETE_DUPLICATES=false
 #PAPERLESS_CONSUMER_RECURSIVE=false
-#PAPERLESS_CONSUMER_IGNORE_PATTERNS=[".DS_STORE/*", "._*", ".stfolder/*"]
+#PAPERLESS_CONSUMER_IGNORE_PATTERNS=[".DS_STORE/*", "._*", ".stfolder/*", ".stversions/*", ".localized/*", "desktop.ini"]
 #PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS=false
+#PAPERLESS_CONSUMER_ENABLE_BARCODES=false
+#PAPERLESS_CONSUMER_ENABLE_BARCODES=PATCHT
 #PAPERLESS_OPTIMIZE_THUMBNAILS=true
 #PAPERLESS_PRE_CONSUME_SCRIPT=/path/to/an/arbitrary/script.sh
 #PAPERLESS_POST_CONSUME_SCRIPT=/path/to/an/arbitrary/script.sh
@@ -67,6 +71,7 @@
 #PAPERLESS_FILENAME_PARSE_TRANSFORMS=[]
 #PAPERLESS_THUMBNAIL_FONT_NAME=
 #PAPERLESS_IGNORE_DATES=
+#PAPERLESS_ENABLE_UPDATE_CHECK=
 
 # Tika settings
 

requirements.txt

@@ -5,49 +5,50 @@
 #    pipenv lock --requirements
 #
 
--i https://pypi.python.org/simple
+-i https://pypi.python.org/simple/
---extra-index-url https://www.piwheels.org/simple
+--extra-index-url https://www.piwheels.org/simple/
 aioredis==1.3.1
+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'
+autobahn==22.3.2; python_version >= '3.7'
 automat==20.2.0
-backports.zoneinfo==0.2.1
+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.3.1
+channels-redis==3.4.0
 channels==3.0.4
 chardet==4.0.0; python_version >= '3.1'
 charset-normalizer==2.0.12; python_version >= '3'
-click==8.0.4; python_version >= '3.6'
+click==8.1.2; python_version >= '3.7'
 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==36.0.1
+cryptography==36.0.2; python_version >= '3.6'
 daphne==3.0.2; python_version >= '3.6'
-dateparser==1.1.0
+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.9
-django==3.2.12
+django==4.0.4
 djangorestframework==3.13.1
 filelock==3.6.0
 fuzzywuzzy[speedup]==0.18.0
 gunicorn==20.1.0
 h11==0.13.0; python_version >= '3.6'
 hiredis==2.0.0; python_version >= '3.6'
-httptools==0.3.0
+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==3.3; python_version >= '3.5'
-imap-tools==0.51.1
+imap-tools==0.53.0
-img2pdf==0.4.3
+img2pdf==0.4.4
-importlib-resources==5.4.0; python_version < '3.9'
+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
@@ -55,55 +56,58 @@ 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.2
+numpy==1.22.3; python_version >= '3.8'
-ocrmypdf==13.4.0
+ocrmypdf==13.4.2
 packaging==21.3; python_version >= '3.6'
 pathvalidate==2.5.0
-pdfminer.six==20211012
+pdf2image==1.16.0
-pikepdf==5.0.1
+pdfminer.six==20220319
-pillow==9.0.1
+pikepdf==5.1.1
+pillow==9.1.0
 pluggy==1.0.0; python_version >= '3.6'
 portalocker==2.4.0; python_version >= '3'
-psycopg2-binary==2.9.3
+psycopg2==2.9.3
 pyasn1-modules==0.2.8
 pyasn1==0.4.8
-pycparser==2.21; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+pycparser==2.21
-pyopenssl==22.0.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+pyopenssl==22.0.0
-pyparsing==3.0.7; python_version >= '3.6'
+pyparsing==3.0.8; python_full_version >= '3.6.8'
 python-dateutil==2.8.2
-python-dotenv==0.19.2
+python-dotenv==0.20.0
 python-gnupg==0.4.8
 python-levenshtein==0.12.2
 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==2021.3
+pytz==2022.1
 pyyaml==6.0
+pyzbar==0.1.9
 redis==3.5.3
-regex==2022.1.18
+regex==2022.3.2; python_version >= '3.6'
-reportlab==3.6.7; python_version >= '3.6' and python_version < '4'
+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==0.24.0
+scikit-learn==1.0.2
 scipy==1.8.0; python_version < '3.11' and python_version >= '3.8'
 service-identity==21.1.0
-setuptools==60.9.3; python_version >= '3.7'
+setuptools==62.1.0; 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.62.3
+tqdm==4.64.0
-twisted[tls]==22.1.0; python_full_version >= '3.6.7'
+twisted[tls]==22.4.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==2021.5; python_version >= '3.6'
+tzdata==2022.1; python_version >= '3.6'
-tzlocal==4.1; python_version >= '3.6'
+tzlocal==4.2; python_version >= '3.6'
-urllib3==1.26.8; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'
+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.5
+uvicorn[standard]==0.17.6
 uvloop==0.16.0
-watchdog==2.1.6
+watchdog==2.1.7
-watchgod==0.7
+watchgod==0.8.2
 wcwidth==0.2.5
 websockets==10.2
 whitenoise==6.0.0
 whoosh==2.7.4
-zipp==3.7.0; python_version < '3.10'
+zipp==3.8.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'

scripts/start_services.sh

@@ -1,3 +1,5 @@
+#!/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 gotenberg/gotenberg:7

src-ui/.gitignore

@@ -45,3 +45,7 @@ testem.log
 # System Files
 .DS_Store
 Thumbs.db
+
+# Cypress
+cypress/videos/**/*
+cypress/screenshots/**/*

src-ui/angular.json

@@ -16,6 +16,7 @@
 			"i18n": {
 				"sourceLocale": "en-US",
 				"locales": {
+					"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",
@@ -30,7 +31,11 @@
 					"pt-PT": "src/locale/messages.pt_PT.xlf",
 					"ro-RO": "src/locale/messages.ro_RO.xlf",
 					"ru-RU": "src/locale/messages.ru_RU.xlf",
-					"sv-SE": "src/locale/messages.sv_SE.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": {
@@ -121,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",
@@ -140,9 +142,21 @@
 					}
 				},
 				"e2e": {
-					"builder": "@angular-devkit/build-angular:protractor",
+					"builder": "@cypress/schematic:cypress",
+					"options": {
+						"devServerTarget": "paperless-ui:serve",
+						"watch": true,
+						"headless": false
+					},
+					"configurations": {
+						"production": {
+							"devServerTarget": "paperless-ui:serve:production"
+						}
+					}
+				},
+				"cypress-run": {
+					"builder": "@cypress/schematic:cypress",
 					"options": {
-						"protractorConfig": "e2e/protractor.conf.js",
 						"devServerTarget": "paperless-ui:serve"
 					},
 					"configurations": {
@@ -150,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')
+  })
+})

src-ui/cypress/integration/documents-list.spec.ts

@@ -0,0 +1,143 @@
+describe('documents-list', () => {
+  beforeEach(() => {
+    this.bulkEdits = {}
+
+    // mock API methods
+    cy.fixture('documents/documents.json').then((documentsJson) => {
+      // bulk edit
+      cy.intercept(
+        'POST',
+        'http://localhost:8000/api/documents/bulk_edit/',
+        (req) => {
+          this.bulkEdits = req.body // store this for later
+          req.reply({ result: 'OK' })
+        }
+      )
+
+      cy.intercept('GET', 'http://localhost:8000/api/documents/*', (req) => {
+        let response = { ...documentsJson }
+
+        // bulkEdits was set earlier by bulk_edit intercept
+        if (this.bulkEdits.hasOwnProperty('documents')) {
+          response.results = response.results.map((d) => {
+            if ((this.bulkEdits['documents'] as Array<number>).includes(d.id)) {
+              switch (this.bulkEdits['method']) {
+                case 'modify_tags':
+                  d.tags = (d.tags as Array<number>).concat([
+                    this.bulkEdits['parameters']['add_tags'],
+                  ])
+                  break
+                case 'set_correspondent':
+                  d.correspondent =
+                    this.bulkEdits['parameters']['correspondent']
+                  break
+                case 'set_document_type':
+                  d.document_type =
+                    this.bulkEdits['parameters']['document_type']
+                  break
+              }
+            }
+
+            return d
+          })
+        } else if (req.query.hasOwnProperty('tags__id__all')) {
+          // filtering e.g. http://localhost:8000/api/documents/?page=1&page_size=50&ordering=-created&tags__id__all=2
+          const tag_id = +req.query['tags__id__all']
+          response.results = (documentsJson.results as Array<any>).filter((d) =>
+            (d.tags as Array<number>).includes(tag_id)
+          )
+          response.count = response.results.length
+        }
+
+        req.reply(response)
+      })
+    })
+
+    cy.intercept('http://localhost:8000/api/documents/1/thumb/', {
+      fixture: 'documents/lorem-ipsum.png',
+    })
+
+    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.visit('/documents')
+  })
+
+  it('should show a list of documents rendered as cards with thumbnails', () => {
+    cy.contains('3 documents')
+    cy.contains('lorem-ipsum')
+    cy.get('app-document-card-small:first-of-type img')
+      .invoke('attr', 'src')
+      .should('eq', 'http://localhost:8000/api/documents/1/thumb/')
+  })
+
+  it('should change to table "details" view', () => {
+    cy.get('div.btn-group-toggle input[value="details"]').parent().click()
+    cy.get('table')
+  })
+
+  it('should change to large cards view', () => {
+    cy.get('div.btn-group-toggle input[value="largeCards"]').parent().click()
+    cy.get('app-document-card-large')
+  })
+
+  it('should filter tags', () => {
+    cy.get('app-filter-editor app-filterable-dropdown[title="Tags"]').within(
+      () => {
+        cy.contains('button', 'Tags').click()
+        cy.contains('button', 'Tag 2').click()
+      }
+    )
+    cy.contains('One document')
+  })
+
+  it('should apply tags', () => {
+    cy.get('app-document-card-small:first-of-type').click()
+    cy.get('app-bulk-editor app-filterable-dropdown[title="Tags"]').within(
+      () => {
+        cy.contains('button', 'Tags').click()
+        cy.contains('button', 'Test Tag').click()
+        cy.contains('button', 'Apply').click()
+      }
+    )
+    cy.contains('button', 'Confirm').click()
+    cy.get('app-document-card-small:first-of-type').contains('Test Tag')
+  })
+
+  it('should apply correspondent', () => {
+    cy.get('app-document-card-small:first-of-type').click()
+    cy.get(
+      'app-bulk-editor app-filterable-dropdown[title="Correspondent"]'
+    ).within(() => {
+      cy.contains('button', 'Correspondent').click()
+      cy.contains('button', 'ABC Test Correspondent').click()
+      cy.contains('button', 'Apply').click()
+    })
+    cy.contains('button', 'Confirm').click()
+    cy.get('app-document-card-small:first-of-type').contains(
+      'ABC Test Correspondent'
+    )
+  })
+
+  it('should apply document type', () => {
+    cy.get('app-document-card-small:first-of-type').click()
+    cy.get(
+      'app-bulk-editor app-filterable-dropdown[title="Document type"]'
+    ).within(() => {
+      cy.contains('button', 'Document type').click()
+      cy.contains('button', 'Test Doc Type').click()
+      cy.contains('button', 'Apply').click()
+    })
+    cy.contains('button', 'Confirm').click()
+    cy.get('app-document-card-small:first-of-type').contains('Test Doc Type')
+  })
+})

src-ui/cypress/integration/manage.spec.ts

@@ -0,0 +1,32 @@
+describe('manage', () => {
+  beforeEach(() => {
+    cy.intercept('http://localhost:8000/api/correspondents/*', {
+      fixture: 'correspondents/correspondents.json',
+    })
+    cy.intercept('http://localhost:8000/api/tags/*', {
+      fixture: 'tags/tags.json',
+    })
+  })
+
+  it('should show a list of correspondents with bottom pagination as well', () => {
+    cy.visit('/correspondents')
+    cy.get('tbody').find('tr').its('length').should('eq', 25)
+    cy.get('ngb-pagination').its('length').should('eq', 2)
+  })
+
+  it('should show a list of tags without bottom pagination', () => {
+    cy.visit('/tags')
+    cy.get('tbody').find('tr').its('length').should('eq', 8)
+    cy.get('ngb-pagination').its('length').should('eq', 1)
+  })
+
+  it('should show a list of documents filtered by tag', () => {
+    cy.intercept('http://localhost:8000/api/documents/*', (req) => {
+      if (req.url.indexOf('tags__id__all=4'))
+        req.reply({ count: 3, next: null, previous: null, results: [] })
+    })
+    cy.visit('/tags')
+    cy.get('tbody').find('button').contains('Documents').first().click() // id = 4
+    cy.contains('3 documents')
+  })
+})

src-ui/cypress/integration/settings.spec.ts

@@ -0,0 +1,91 @@
+describe('settings', () => {
+  beforeEach(() => {
+    this.modifiedViews = []
+
+    // mock API methods
+    cy.fixture('saved_views/savedviews.json').then((savedViewsJson) => {
+      // saved views PATCH
+      cy.intercept(
+        'PATCH',
+        'http://localhost:8000/api/saved_views/*',
+        (req) => {
+          this.modifiedViews.push(req.body) // store this for later
+          req.reply({ result: 'OK' })
+        }
+      )
+
+      cy.intercept('GET', 'http://localhost:8000/api/saved_views/*', (req) => {
+        let response = { ...savedViewsJson }
+        if (this.modifiedViews.length) {
+          response.results = response.results.map((v) => {
+            if (this.modifiedViews.find((mv) => mv.id == v.id))
+              v = this.modifiedViews.find((mv) => mv.id == v.id)
+            return v
+          })
+        }
+
+        req.reply(response)
+      }).as('savedViews')
+    })
+
+    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('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.viewport(1024, 1024)
+    cy.visit('/settings')
+    cy.wait('@savedViews')
+  })
+
+  it('should activate / deactivate save button when settings change and are saved', () => {
+    cy.contains('button', 'Save').should('be.disabled')
+    cy.contains('Use system settings').click()
+    cy.contains('button', 'Save').should('not.be.disabled')
+    cy.contains('button', 'Save').click()
+    cy.contains('button', 'Save').should('be.disabled')
+  })
+
+  it('should warn on unsaved changes', () => {
+    cy.contains('Use system settings').click()
+    cy.contains('a', 'Dashboard').click()
+    cy.contains('You have unsaved changes')
+    cy.contains('button', 'Cancel').click()
+    cy.contains('button', 'Save').click().wait('@savedViews')
+    cy.contains('a', 'Dashboard').click()
+    cy.contains('You have unsaved changes').should('not.exist')
+  })
+
+  it('should apply appearance changes when set', () => {
+    cy.contains('Use system settings').click()
+    cy.get('body').should('not.have.class', 'color-scheme-system')
+    cy.contains('Enable dark mode').click()
+    cy.get('body').should('have.class', 'color-scheme-dark')
+  })
+
+  it('should remove saved view from sidebar when unset', () => {
+    cy.contains('a', 'Saved views').click()
+    cy.get('#show_in_sidebar_1').click()
+    cy.contains('button', 'Save').click().wait('@savedViews')
+    cy.contains('li', 'Inbox').should('not.exist')
+  })
+
+  it('should remove saved view from dashboard when unset', () => {
+    cy.contains('a', 'Saved views').click()
+    cy.get('#show_on_dashboard_1').click()
+    cy.contains('button', 'Save').click().wait('@savedViews')
+    cy.visit('/dashboard')
+    cy.get('app-saved-view-widget').contains('Inbox').should('not.exist')
+  })
+})

src-ui/cypress/plugins/index.ts

@@ -0,0 +1,3 @@
+// Plugins enable you to tap into, modify, or extend the internal behavior of Cypress
+// For more info, visit https://on.cypress.io/plugins-api
+module.exports = (on, config) => {}

src-ui/cypress/support/commands.ts

@@ -0,0 +1,43 @@
+// ***********************************************
+// This example namespace declaration will help
+// with Intellisense and code completion in your
+// IDE or Text Editor.
+// ***********************************************
+// declare namespace Cypress {
+//   interface Chainable<Subject = any> {
+//     customCommand(param: any): typeof customCommand;
+//   }
+// }
+//
+// function customCommand(param: any): void {
+//   console.warn(param);
+// }
+//
+// NOTE: You can use it like so:
+// Cypress.Commands.add('customCommand', customCommand);
+//
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add("login", (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

src-ui/cypress/support/index.ts

@@ -0,0 +1,17 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// When a command from ./commands is ready to use, import with `import './commands'` syntax
+// import './commands';

src-ui/cypress/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["**/*.ts"],
+  "compilerOptions": {
+    "sourceMap": false,
+    "types": ["cypress"]
+  }
+}

src-ui/e2e/protractor.conf.js

@@ -2,18 +2,16 @@
 // Protractor configuration file, see link for more information
 // https://github.com/angular/protractor/blob/master/lib/config.ts
 
-const { SpecReporter, StacktraceOption } = require('jasmine-spec-reporter');
+const { SpecReporter, StacktraceOption } = require('jasmine-spec-reporter')
 
 /**
  * @type { import("protractor").Config }
  */
 exports.config = {
   allScriptsTimeout: 11000,
-  specs: [
+  specs: ['./src/**/*.e2e-spec.ts'],
-    './src/**/*.e2e-spec.ts'
-  ],
   capabilities: {
-    browserName: 'chrome'
+    browserName: 'chrome',
   },
   directConnect: true,
   baseUrl: 'http://localhost:4200/',
@@ -21,16 +19,18 @@ exports.config = {
   jasmineNodeOpts: {
     showColors: true,
     defaultTimeoutInterval: 30000,
-    print: function() {}
+    print: function () {},
   },
   onPrepare() {
     require('ts-node').register({
-      project: require('path').join(__dirname, './tsconfig.json')
+      project: require('path').join(__dirname, './tsconfig.json'),
-    });
+    })
-    jasmine.getEnv().addReporter(new SpecReporter({
+    jasmine.getEnv().addReporter(
+      new SpecReporter({
         spec: {
-        displayStacktrace: StacktraceOption.PRETTY
+          displayStacktrace: StacktraceOption.PRETTY,
+        },
+      })
+    )
+  },
 }
-    }));
-  }
-};

src-ui/e2e/src/app.e2e-spec.ts

@@ -1,23 +1,25 @@
-import { AppPage } from './app.po';
+import { AppPage } from './app.po'
-import { browser, logging } from 'protractor';
+import { browser, logging } from 'protractor'
 
 describe('workspace-project App', () => {
-  let page: AppPage;
+  let page: AppPage
 
   beforeEach(() => {
-    page = new AppPage();
+    page = new AppPage()
-  });
+  })
 
   it('should display welcome message', () => {
-    page.navigateTo();
+    page.navigateTo()
-    expect(page.getTitleText()).toEqual('paperless-ui app is running!');
+    expect(page.getTitleText()).toEqual('paperless-ui app is running!')
-  });
+  })
 
   afterEach(async () => {
     // Assert that there are no errors emitted from the browser
-    const logs = await browser.manage().logs().get(logging.Type.BROWSER);
+    const logs = await browser.manage().logs().get(logging.Type.BROWSER)
-    expect(logs).not.toContain(jasmine.objectContaining({
+    expect(logs).not.toContain(
+      jasmine.objectContaining({
         level: logging.Level.SEVERE,
-    } as logging.Entry));
+      } as logging.Entry)
-  });
+    )
-});
+  })
+})

src-ui/e2e/src/app.po.ts

@@ -1,11 +1,13 @@
-import { browser, by, element } from 'protractor';
+import { browser, by, element } from 'protractor'
 
 export class AppPage {
   navigateTo(): Promise<unknown> {
-    return browser.get(browser.baseUrl) as Promise<unknown>;
+    return browser.get(browser.baseUrl) as Promise<unknown>
   }
 
   getTitleText(): Promise<string> {
-    return element(by.css('app-root .content span')).getText() as Promise<string>;
+    return element(
+      by.css('app-root .content span')
+    ).getText() as Promise<string>
   }
 }

src-ui/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  moduleNameMapper: {
+    '@core/(.*)': '<rootDir>/src/app/core/$1',
+  },
+  preset: 'jest-preset-angular',
+  setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
+  testPathIgnorePatterns: ['/node_modules/', '/cypress/'],
+}

src-ui/karma.conf.js

@@ -1,32 +0,0 @@
-// Karma configuration file, see link for more information
-// https://karma-runner.github.io/1.0/config/configuration-file.html
-
-module.exports = function (config) {
-  config.set({
-    basePath: '',
-    frameworks: ['jasmine', '@angular-devkit/build-angular'],
-    plugins: [
-      require('karma-jasmine'),
-      require('karma-chrome-launcher'),
-      require('karma-jasmine-html-reporter'),
-      require('karma-coverage-istanbul-reporter'),
-      require('@angular-devkit/build-angular/plugins/karma')
-    ],
-    client: {
-      clearContext: false // leave Jasmine Spec Runner output visible in browser
-    },
-    coverageIstanbulReporter: {
-      dir: require('path').join(__dirname, './coverage/paperless-ui'),
-      reports: ['html', 'lcovonly', 'text-summary'],
-      fixWebpackSourcePaths: true
-    },
-    reporters: ['progress', 'kjhtml'],
-    port: 9876,
-    colors: true,
-    logLevel: config.LOG_INFO,
-    autoWatch: true,
-    browsers: ['Chrome'],
-    singleRun: false,
-    restartOnFileChange: true
-  });
-};

src-ui/package.json

@@ -7,53 +7,52 @@
     "build": "ng build",
     "test": "ng test",
     "lint": "ng lint",
-    "e2e": "ng e2e"
+    "e2e": "ng e2e",
+    "cy:run": "cypress run",
+    "e2e:ci": "concurrently 'npm run start' 'wait-on http-get://localhost:4200 && npm run cy:run' --kill-others --success first"
   },
   "private": true,
   "dependencies": {
-    "@angular/animations": "~13.2.4",
+    "@angular/common": "~13.3.1",
-    "@angular/common": "~13.2.4",
+    "@angular/compiler": "~13.3.1",
-    "@angular/compiler": "~13.2.4",
+    "@angular/core": "~13.3.1",
-    "@angular/core": "~13.2.4",
+    "@angular/forms": "~13.3.1",
-    "@angular/forms": "~13.2.4",
+    "@angular/localize": "~13.3.1",
-    "@angular/localize": "~13.2.4",
+    "@angular/platform-browser": "~13.3.1",
-    "@angular/platform-browser": "~13.2.4",
+    "@angular/platform-browser-dynamic": "~13.3.1",
-    "@angular/platform-browser-dynamic": "~13.2.4",
+    "@angular/router": "~13.3.1",
-    "@angular/router": "~13.2.4",
+    "@ng-bootstrap/ng-bootstrap": "^12.0.1",
-    "@ng-bootstrap/ng-bootstrap": "^12.0.0",
     "@ng-select/ng-select": "^8.1.1",
-    "@ngneat/dirty-check-forms": "^1.1.0",
+    "@ngneat/dirty-check-forms": "^3.0.2",
-    "@popperjs/core": "^2.11.2",
+    "@popperjs/core": "^2.11.4",
     "bootstrap": "^5.1.3",
     "file-saver": "^2.0.5",
-    "ng2-pdf-viewer": "^8.0.1",
+    "ng2-pdf-viewer": "^9.0.0",
     "ngx-color": "^7.3.3",
     "ngx-cookie-service": "^13.1.2",
     "ngx-file-drop": "^13.0.0",
-    "ngx-infinite-scroll": "^10.0.1",
+    "rxjs": "~7.5.5",
-    "rxjs": "~6.6.7",
     "tslib": "^2.3.1",
     "uuid": "^8.3.1",
     "zone.js": "~0.11.4"
   },
   "devDependencies": {
-    "@angular-devkit/build-angular": "~13.2.5",
+    "@angular-builders/jest": "13.0.3",
-    "@angular/cli": "~13.2.5",
+    "@angular-devkit/build-angular": "~13.3.1",
-    "@angular/compiler-cli": "~13.2.4",
+    "@angular/cli": "~13.3.1",
-    "@types/jasmine": "~3.10.3",
+    "@angular/compiler-cli": "~13.3.1",
-    "@types/jasminewd2": "~2.0.10",
+    "@types/jest": "27.4.1",
-    "@types/node": "^17.0.21",
+    "@types/node": "^17.0.23",
     "codelyzer": "^6.0.2",
-    "jasmine-core": "~4.0.1",
+    "concurrently": "7.0.0",
-    "jasmine-spec-reporter": "~7.0.0",
+    "jest": "27.5.1",
-    "karma": "~6.3.16",
+    "ts-node": "~10.7.0",
-    "karma-chrome-launcher": "~3.1.0",
-    "karma-coverage-istanbul-reporter": "~3.0.3",
-    "karma-jasmine": "~4.0.1",
-    "karma-jasmine-html-reporter": "^1.7.0",
-    "protractor": "~7.0.0",
-    "ts-node": "~10.5.0",
     "tslint": "~6.1.3",
-    "typescript": "~4.5.5"
+    "typescript": "~4.6.3",
+    "wait-on": "~6.0.1"
+  },
+  "optionalDependencies": {
+    "cypress": "~9.5.3",
+    "@cypress/schematic": "^1.6.0"
   }
 }

src-ui/setup-jest.ts

@@ -0,0 +1,30 @@
+import 'jest-preset-angular/setup-jest'
+
+/* global mocks for jsdom */
+const mock = () => {
+  let storage: { [key: string]: string } = {}
+  return {
+    getItem: (key: string) => (key in storage ? storage[key] : null),
+    setItem: (key: string, value: string) => (storage[key] = value || ''),
+    removeItem: (key: string) => delete storage[key],
+    clear: () => (storage = {}),
+  }
+}
+
+Object.defineProperty(window, 'localStorage', { value: mock() })
+Object.defineProperty(window, 'sessionStorage', { value: mock() })
+Object.defineProperty(window, 'getComputedStyle', {
+  value: () => ['-webkit-appearance'],
+})
+
+Object.defineProperty(document.body.style, 'transform', {
+  value: () => {
+    return {
+      enumerable: true,
+      configurable: true,
+    }
+  },
+})
+
+/* output shorter and more meaningful Zone error stack traces */
+// Error.stackTraceLimit = 2

src-ui/src/app/app-routing.module.ts

@@ -1,21 +1,24 @@
-import { NgModule } from '@angular/core';
+import { NgModule } from '@angular/core'
-import { Routes, RouterModule } from '@angular/router';
+import { Routes, RouterModule } from '@angular/router'
-import { AppFrameComponent } from './components/app-frame/app-frame.component';
+import { AppFrameComponent } from './components/app-frame/app-frame.component'
-import { DashboardComponent } from './components/dashboard/dashboard.component';
+import { DashboardComponent } from './components/dashboard/dashboard.component'
-import { DocumentDetailComponent } from './components/document-detail/document-detail.component';
+import { DocumentDetailComponent } from './components/document-detail/document-detail.component'
-import { DocumentListComponent } from './components/document-list/document-list.component';
+import { DocumentListComponent } from './components/document-list/document-list.component'
-import { CorrespondentListComponent } from './components/manage/correspondent-list/correspondent-list.component';
+import { CorrespondentListComponent } from './components/manage/correspondent-list/correspondent-list.component'
-import { DocumentTypeListComponent } from './components/manage/document-type-list/document-type-list.component';
+import { DocumentTypeListComponent } from './components/manage/document-type-list/document-type-list.component'
-import { LogsComponent } from './components/manage/logs/logs.component';
+import { LogsComponent } from './components/manage/logs/logs.component'
-import { SettingsComponent } from './components/manage/settings/settings.component';
+import { SettingsComponent } from './components/manage/settings/settings.component'
-import { TagListComponent } from './components/manage/tag-list/tag-list.component';
+import { TagListComponent } from './components/manage/tag-list/tag-list.component'
-import { NotFoundComponent } from './components/not-found/not-found.component';
+import { NotFoundComponent } from './components/not-found/not-found.component'
-import {DocumentAsnComponent} from "./components/document-asn/document-asn.component";
+import { DocumentAsnComponent } from './components/document-asn/document-asn.component'
-import { DirtyFormGuard } from './guards/dirty-form.guard';
+import { DirtyFormGuard } from './guards/dirty-form.guard'
 
 const routes: Routes = [
   { path: '', redirectTo: 'dashboard', pathMatch: 'full' },
-  {path: '', component: AppFrameComponent, children: [
+  {
+    path: '',
+    component: AppFrameComponent,
+    children: [
       { path: 'dashboard', component: DashboardComponent },
       { path: 'documents', component: DocumentListComponent },
       { path: 'view/:id', component: DocumentListComponent },
@@ -25,15 +28,20 @@ const routes: Routes = [
       { path: 'documenttypes', component: DocumentTypeListComponent },
       { path: 'correspondents', component: CorrespondentListComponent },
       { path: 'logs', component: LogsComponent },
-    {path: 'settings', component: SettingsComponent, canDeactivate: [DirtyFormGuard] },
+      {
-  ]},
+        path: 'settings',
+        component: SettingsComponent,
+        canDeactivate: [DirtyFormGuard],
+      },
+    ],
+  },
 
   { path: '404', component: NotFoundComponent },
-  {path: '**', redirectTo: '/404', pathMatch: 'full'}
+  { path: '**', redirectTo: '/404', pathMatch: 'full' },
-];
+]
 
 @NgModule({
   imports: [RouterModule.forRoot(routes, { relativeLinkResolution: 'legacy' })],
-  exports: [RouterModule]
+  exports: [RouterModule],
 })
 export class AppRoutingModule {}

src-ui/src/app/app.component.html

@@ -1,3 +1,13 @@
 <app-toasts></app-toasts>
 
+<ngx-file-drop dropZoneClassName="main-dropzone" contentClassName="main-content" [disabled]="!dragDropEnabled"
+(onFileDrop)="dropped($event)" (onFileOver)="fileOver()" (onFileLeave)="fileLeave()">
+    <ng-template ngx-file-drop-content-tmp>
+        <div class="global-dropzone-overlay fade" [class.show]="fileIsOver" [class.hide]="hidden">
+            <h2 i18n>Drop files to begin upload</h2>
+        </div>
+        <div [class.inert]="fileIsOver">
             <router-outlet></router-outlet>
+        </div>
+    </ng-template>
+</ngx-file-drop>

src-ui/src/app/app.component.spec.ts

@@ -1,35 +0,0 @@
-import { TestBed } from '@angular/core/testing';
-import { RouterTestingModule } from '@angular/router/testing';
-import { AppComponent } from './app.component';
-
-describe('AppComponent', () => {
-  beforeEach(async () => {
-    await TestBed.configureTestingModule({
-      imports: [
-        RouterTestingModule
-      ],
-      declarations: [
-        AppComponent
-      ],
-    }).compileComponents();
-  });
-
-  it('should create the app', () => {
-    const fixture = TestBed.createComponent(AppComponent);
-    const app = fixture.componentInstance;
-    expect(app).toBeTruthy();
-  });
-
-  it(`should have as title 'paperless-ui'`, () => {
-    const fixture = TestBed.createComponent(AppComponent);
-    const app = fixture.componentInstance;
-    expect(app.title).toEqual('paperless-ui');
-  });
-
-  it('should render title', () => {
-    const fixture = TestBed.createComponent(AppComponent);
-    fixture.detectChanges();
-    const compiled = fixture.nativeElement;
-    expect(compiled.querySelector('.content span').textContent).toContain('paperless-ui app is running!');
-  });
-});

src-ui/src/app/app.component.ts

@@ -1,25 +1,36 @@
-import { SettingsService, SETTINGS_KEYS } from './services/settings.service';
+import { SettingsService, SETTINGS_KEYS } from './services/settings.service'
-import { Component, OnDestroy, OnInit } from '@angular/core';
+import { Component, OnDestroy, OnInit } from '@angular/core'
-import { Router } from '@angular/router';
+import { Router } from '@angular/router'
-import { Subscription } from 'rxjs';
+import { Subscription } from 'rxjs'
-import { ConsumerStatusService } from './services/consumer-status.service';
+import { ConsumerStatusService } from './services/consumer-status.service'
-import { ToastService } from './services/toast.service';
+import { ToastService } from './services/toast.service'
+import { NgxFileDropEntry } from 'ngx-file-drop'
+import { UploadDocumentsService } from './services/upload-documents.service'
 
 @Component({
   selector: 'app-root',
   templateUrl: './app.component.html',
-  styleUrls: ['./app.component.scss']
+  styleUrls: ['./app.component.scss'],
 })
 export class AppComponent implements OnInit, OnDestroy {
+  newDocumentSubscription: Subscription
+  successSubscription: Subscription
+  failedSubscription: Subscription
 
-  newDocumentSubscription: Subscription;
+  private fileLeaveTimeoutID: any
-  successSubscription: Subscription;
+  fileIsOver: boolean = false
-  failedSubscription: Subscription;
+  hidden: boolean = true
 
-  constructor (private settings: SettingsService, private consumerStatusService: ConsumerStatusService, private toastService: ToastService, private router: Router) {
+  constructor(
-    let anyWindow = (window as any)
+    private settings: SettingsService,
-    anyWindow.pdfWorkerSrc = 'assets/js/pdf.worker.min.js';
+    private consumerStatusService: ConsumerStatusService,
-    this.settings.updateDarkModeSettings()
+    private toastService: ToastService,
+    private router: Router,
+    private uploadDocumentsService: UploadDocumentsService
+  ) {
+    let anyWindow = window as any
+    anyWindow.pdfWorkerSrc = 'assets/js/pdf.worker.min.js'
+    this.settings.updateAppearanceSettings()
   }
 
   ngOnDestroy(): void {
@@ -36,7 +47,12 @@ export class AppComponent implements OnInit, OnDestroy {
   }
 
   private showNotification(key) {
-    if (this.router.url == '/dashboard' && this.settings.get(SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD)) {
+    if (
+      this.router.url == '/dashboard' &&
+      this.settings.get(
+        SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD
+      )
+    ) {
       return false
     }
     return this.settings.get(key)
@@ -45,26 +61,82 @@ export class AppComponent implements OnInit, OnDestroy {
   ngOnInit(): void {
     this.consumerStatusService.connect()
 
-
+    this.successSubscription = this.consumerStatusService
-    this.successSubscription = this.consumerStatusService.onDocumentConsumptionFinished().subscribe(status => {
+      .onDocumentConsumptionFinished()
-      if (this.showNotification(SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUCCESS)) {
+      .subscribe((status) => {
-        this.toastService.show({title: $localize`Document added`, delay: 10000, content: $localize`Document ${status.filename} was added to paperless.`, actionName: $localize`Open document`, action: () => {
+        if (
+          this.showNotification(SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUCCESS)
+        ) {
+          this.toastService.show({
+            title: $localize`Document added`,
+            delay: 10000,
+            content: $localize`Document ${status.filename} was added to paperless.`,
+            actionName: $localize`Open document`,
+            action: () => {
               this.router.navigate(['documents', status.documentId])
-        }})
+            },
+          })
         }
       })
 
-    this.failedSubscription = this.consumerStatusService.onDocumentConsumptionFailed().subscribe(status => {
+    this.failedSubscription = this.consumerStatusService
-      if (this.showNotification(SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_FAILED)) {
+      .onDocumentConsumptionFailed()
-        this.toastService.showError($localize`Could not add ${status.filename}\: ${status.message}`)
+      .subscribe((status) => {
+        if (
+          this.showNotification(SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_FAILED)
+        ) {
+          this.toastService.showError(
+            $localize`Could not add ${status.filename}\: ${status.message}`
+          )
         }
       })
 
-    this.newDocumentSubscription = this.consumerStatusService.onDocumentDetected().subscribe(status => {
+    this.newDocumentSubscription = this.consumerStatusService
-      if (this.showNotification(SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_NEW_DOCUMENT)) {
+      .onDocumentDetected()
-        this.toastService.show({title: $localize`New document detected`, delay: 5000, content: $localize`Document ${status.filename} is being processed by paperless.`})
+      .subscribe((status) => {
+        if (
+          this.showNotification(
+            SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_NEW_DOCUMENT
+          )
+        ) {
+          this.toastService.show({
+            title: $localize`New document detected`,
+            delay: 5000,
+            content: $localize`Document ${status.filename} is being processed by paperless.`,
+          })
         }
       })
   }
 
+  public get dragDropEnabled(): boolean {
+    return !this.router.url.includes('dashboard')
+  }
+
+  public fileOver() {
+    // allows transition
+    setTimeout(() => {
+      this.fileIsOver = true
+    }, 1)
+    this.hidden = false
+    // stop fileLeave timeout
+    clearTimeout(this.fileLeaveTimeoutID)
+  }
+
+  public fileLeave(immediate: boolean = false) {
+    const ms = immediate ? 0 : 500
+
+    this.fileLeaveTimeoutID = setTimeout(() => {
+      this.fileIsOver = false
+      // await transition completed
+      setTimeout(() => {
+        this.hidden = true
+      }, 150)
+    }, ms)
+  }
+
+  public dropped(files: NgxFileDropEntry[]) {
+    this.fileLeave(true)
+    this.uploadDocumentsService.uploadFiles(files)
+    this.toastService.showInfo($localize`Initiating upload...`, 3000)
+  }
 }