2.0.0-beta.rc1

* Fix notes count in tab button wrapping

* Fix position of custom fields dropdown on mobile

* Limit list view title width

* Update messages.xlf

.codecov.yml

@@ -1,3 +1,15 @@
+codecov:
+  require_ci_to_pass: true
+# https://docs.codecov.com/docs/flags#recommended-automatic-flag-management
+# Require each flag to have 1 upload before notification
+flag_management:
+  individual_flags:
+    - name: backend
+      paths:
+        - src/
+    - name: frontend
+      paths:
+        - src-ui/
 # https://docs.codecov.com/docs/pull-request-comments
 # codecov will only comment if coverage changes
 comment:
@@ -8,12 +20,9 @@ coverage:
       default:
         # https://docs.codecov.com/docs/commit-status#threshold
         threshold: 1%
-        # https://docs.codecov.com/docs/commit-status#only_pulls
-        only_pulls: true
     patch:
       default:
         # For the changed lines only, target 75% covered, but
         # allow as low as 50%
         target: 75%
         threshold: 25%
-        only_pulls: true

.dockerignore

@@ -1,21 +1,28 @@
+# Tool caches
 **/__pycache__
-/src-ui/.vscode
+**/.ruff_cache/
-/src-ui/node_modules
+**/.mypy_cache/
-/src-ui/dist
+# Virtual environment & similar
+.venv/
+./src-ui/node_modules
+./src-ui/dist
+# IDE folders
+.idea/
+.vscode/
+./src-ui/.vscode
+# VCS
 .git
-/export
+# Test related
-/consume
+**/.pytest_cache
-/media
-/data
-/docs
-.pytest_cache
-/dist
-/scripts
-/resources
 **/tests
 **/*.spec.ts
 **/htmlcov
-/src/.pytest_cache
+# Local folders
-.idea
+./export
-.venv/
+./consume
-.vscode/
+./media
+./data
+./docs
+./dist
+./scripts
+./resources

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -6,14 +6,21 @@ 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/#/#paperlessngx:matrix.org).
+        ### ⚠️ Please remember: issues are for *bugs*
+        That is, something you believe affects every single user of Paperless-ngx, not just you. If you're not sure, start with one of the other options below.
 
-        Before opening an issue, please double check:
+        Also, note that **Paperless-ngx does not perform OCR itself**, that is handled by other tools. Problems with OCR of specific files should likely be raised 'upstream', see https://github.com/ocrmypdf/OCRmyPDF/issues or https://github.com/tesseract-ocr/tesseract/issues
+  - 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/#/#paperlessngx:matrix.org).
+
+        #### Before opening an issue, please double check:
 
         - [The troubleshooting documentation](https://docs.paperless-ngx.com/troubleshooting/).
         - [The installation instructions](https://docs.paperless-ngx.com/setup/#installation).
         - [Existing issues and discussions](https://github.com/paperless-ngx/paperless-ngx/search?q=&type=issues).
-        - Disable any customer container initialization scripts, if using any
+        - Disable any customer container initialization scripts, if using
 
         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).
   - type: textarea

.github/PULL_REQUEST_TEMPLATE.md

@@ -20,11 +20,16 @@ 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)
+- [ ] Other (please explain):
 
 ## Checklist:
 
+<!--
+NOTE: PRs that do not address the following will not be merged, please do not skip any relevant items.
+-->
+
 - [ ] I have read & agree with the [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md).
+- [ ] If applicable, I have included testing coverage for new code in this PR, for [backend](https://docs.paperless-ngx.com/development/#testing) and / or [front-end](https://docs.paperless-ngx.com/development/#testing-and-code-style) changes.
 - [ ] 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://docs.paperless-ngx.com/development/#back-end-development).
 - [ ] I have run all `pre-commit` hooks, see [documentation](https://docs.paperless-ngx.com/development/#code-formatting-with-pre-commit-hooks).

.github/dependabot.yml

@@ -8,7 +8,7 @@ updates:
     target-branch: "dev"
     # Look for `package.json` and `lock` files in the `/src-ui` directory
     directory: "/src-ui"
-    # Check the npm registry for updates every month
+    open-pull-requests-limit: 10
     schedule:
       interval: "monthly"
     labels:
@@ -17,6 +17,21 @@ updates:
     # Add reviewers
     reviewers:
       - "paperless-ngx/frontend"
+    groups:
+      frontend-angular-dependencies:
+        patterns:
+          - "@angular*"
+          - "@ng-*"
+          - "ngx-*"
+          - "ng2-pdf-viewer"
+      frontend-jest-dependencies:
+        patterns:
+          - "@types/jest"
+          - "jest*"
+      frontend-eslint-dependencies:
+        patterns:
+          - "@typescript-eslint*"
+          - "eslint"
 
   # Enable version updates for Python
   - package-ecosystem: "pip"
@@ -32,8 +47,25 @@ updates:
     # Add reviewers
     reviewers:
       - "paperless-ngx/backend"
+    groups:
+      development:
+        patterns:
+          - "*pytest*"
+          - "black"
+          - "ruff"
+          - "mkdocs-material"
+      django:
+        patterns:
+          - "*django*"
+      major-versions:
+        update-types:
+          - "major"
+      small-changes:
+        update-types:
+          - "minor"
+          - "patch"
 
-  # Enable updates for Github Actions
+  # Enable updates for GitHub Actions
   - package-ecosystem: "github-actions"
     target-branch: "dev"
     directory: "/"
@@ -46,3 +78,9 @@ updates:
     # Add reviewers
     reviewers:
       - "paperless-ngx/ci-cd"
+    groups:
+      actions:
+        update-types:
+          - "major"
+          - "minor"
+          - "patch"

.github/stale.yml

@@ -1,23 +0,0 @@
-# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 30
-
-# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 7
-
-# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
-onlyLabels: [cant-reproduce]
-
-# Label to use when marking an issue as stale
-staleLabel: stale
-
-# Comment to post when marking an issue as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-
-# Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: false
-
-# See https://github.com/marketplace/stale for more info on the app
-# and https://github.com/probot/stale for the configuration docs

.github/workflows/ci.yml

@@ -16,19 +16,25 @@ on:
 env:
   # This is the version of pipenv all the steps will use
   # If changing this, change Dockerfile
-  DEFAULT_PIP_ENV_VERSION: "2023.4.20"
+  DEFAULT_PIP_ENV_VERSION: "2023.10.24"
-  # This is the default version of Python to use in most steps
+  # This is the default version of Python to use in most steps which aren't specific
-  # If changing this, change Dockerfile
+  DEFAULT_PYTHON_VERSION: "3.10"
-  DEFAULT_PYTHON_VERSION: "3.9"
 
 jobs:
   pre-commit:
+    # We want to run on external PRs, but not on our own internal PRs as they'll be run
+    # by the push to the branch. Without this if check, checks are duplicated since
+    # internal PRs match both the push and pull_request events.
+    if:
+      github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
+      github.repository
+
     name: Linting Checks
     runs-on: ubuntu-22.04
     steps:
       -
         name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Install python
         uses: actions/setup-python@v4
@@ -46,7 +52,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Python
         id: setup-python
@@ -58,7 +64,7 @@ jobs:
       -
         name: Install pipenv
         run: |
-          pip install --user pipenv==${DEFAULT_PIP_ENV_VERSION}
+          pip install --user pipenv==${{ env.DEFAULT_PIP_ENV_VERSION }}
       -
         name: Install dependencies
         run: |
@@ -77,6 +83,7 @@ jobs:
         with:
           name: documentation
           path: site/
+          retention-days: 7
 
   documentation-deploy:
     name: "Deploy Documentation"
@@ -87,7 +94,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Deploy docs
         uses: mhausenblas/mkdocs-deploy-gh-pages@master
@@ -98,27 +105,18 @@ jobs:
           EXTRA_PACKAGES: build-base
 
   tests-backend:
-    name: "Tests (${{ matrix.python-version }})"
+    name: "Backend Tests (Python ${{ matrix.python-version }})"
     runs-on: ubuntu-22.04
     needs:
       - pre-commit
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11']
       fail-fast: false
-    env:
-      # Enable Tika end to end testing
-      TIKA_LIVE: 1
-      # Enable paperless_mail testing against real server
-      PAPERLESS_MAIL_TEST_HOST: ${{ secrets.TEST_MAIL_HOST }}
-      PAPERLESS_MAIL_TEST_USER: ${{ secrets.TEST_MAIL_USER }}
-      PAPERLESS_MAIL_TEST_PASSWD: ${{ secrets.TEST_MAIL_PASSWD }}
-      # Enable Gotenberg end to end testing
-      GOTENBERG_LIVE: 1
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Start containers
         run: |
@@ -135,7 +133,7 @@ jobs:
       -
         name: Install pipenv
         run: |
-          pip install --user pipenv==${DEFAULT_PIP_ENV_VERSION}
+          pip install --user pipenv==${{ env.DEFAULT_PIP_ENV_VERSION }}
       -
         name: Install system dependencies
         run: |
@@ -156,18 +154,24 @@ jobs:
           pipenv --python ${{ steps.setup-python.outputs.python-version }} run pip list
       -
         name: Tests
+        env:
+          PAPERLESS_CI_TEST: 1
+          # Enable paperless_mail testing against real server
+          PAPERLESS_MAIL_TEST_HOST: ${{ secrets.TEST_MAIL_HOST }}
+          PAPERLESS_MAIL_TEST_USER: ${{ secrets.TEST_MAIL_USER }}
+          PAPERLESS_MAIL_TEST_PASSWD: ${{ secrets.TEST_MAIL_PASSWD }}
         run: |
           cd src/
           pipenv --python ${{ steps.setup-python.outputs.python-version }} run pytest -ra
       -
-        name: Upload coverage to Codecov
+        name: Upload coverage
-        if: ${{ matrix.python-version == env.DEFAULT_PYTHON_VERSION && github.event_name == 'pull_request'}}
+        if: ${{ matrix.python-version == env.DEFAULT_PYTHON_VERSION }}
-        uses: codecov/codecov-action@v3
+        uses: actions/upload-artifact@v3
         with:
-          # not required for public repos, but intermittently fails otherwise
+          name: backend-coverage-report
-          token: ${{ secrets.CODECOV_TOKEN }}
+          path: src/coverage.xml
-          # future expansion
+          retention-days: 7
-          flags: backend
+          if-no-files-found: warn
       -
         name: Stop containers
         if: always()
@@ -175,27 +179,136 @@ jobs:
           docker compose --file ${GITHUB_WORKSPACE}/docker/compose/docker-compose.ci-test.yml logs
           docker compose --file ${GITHUB_WORKSPACE}/docker/compose/docker-compose.ci-test.yml down
 
-  tests-frontend:
+  install-frontend-depedendencies:
-    name: "Tests Frontend"
+    name: "Install Frontend Dependendencies"
     runs-on: ubuntu-22.04
     needs:
       - pre-commit
-    strategy:
-      matrix:
-        node-version: [16.x]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       -
-        name: Use Node.js ${{ matrix.node-version }}
+        name: Use Node.js 20
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: 20.x
           cache: 'npm'
           cache-dependency-path: 'src-ui/package-lock.json'
-      - run: cd src-ui && npm ci
+      - name: Cache frontend depdendencies
-      - run: cd src-ui && npm run lint
+        id: cache-frontend-deps
-      - run: cd src-ui && npm run test
+        uses: actions/cache@v3
-      - run: cd src-ui && npm run e2e:ci
+        with:
+          path: |
+            ~/.npm
+            ~/.cache
+          key: ${{ runner.os }}-frontenddeps-${{ hashFiles('src-ui/package-lock.json') }}
+      -
+        name: Install dependencies
+        if: steps.cache-frontend-deps.outputs.cache-hit != 'true'
+        run: cd src-ui && npm ci
+      -
+        name: Install Playwright
+        if: steps.cache-frontend-deps.outputs.cache-hit != 'true'
+        run: cd src-ui && npx playwright install --with-deps
+
+  tests-frontend:
+    name: "Frontend Tests (Node ${{ matrix.node-version }} - ${{ matrix.shard-index }}/${{ matrix.shard-count }})"
+    runs-on: ubuntu-22.04
+    needs:
+      - install-frontend-depedendencies
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [20.x]
+        shard-index: [1, 2, 3, 4]
+        shard-count: [4]
+    steps:
+      - uses: actions/checkout@v4
+      -
+        name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: 'npm'
+          cache-dependency-path: 'src-ui/package-lock.json'
+      - name: Cache frontend depdendencies
+        id: cache-frontend-deps
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.npm
+            ~/.cache
+          key: ${{ runner.os }}-frontenddeps-${{ hashFiles('src-ui/package-lock.json') }}
+      - name: Re-link Angular cli
+        run: cd src-ui && npm link @angular/cli
+      -
+        name: Linting checks
+        run: cd src-ui && npm run lint
+      -
+        name: Run Jest unit tests
+        run: cd src-ui && npm run test -- --max-workers=2 --shard=${{ matrix.shard-index }}/${{ matrix.shard-count }}
+      -
+        name: Upload Jest coverage
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: jest-coverage-report-${{ matrix.shard-index }}
+          path: |
+            src-ui/coverage/coverage-final.json
+            src-ui/coverage/lcov.info
+            src-ui/coverage/clover.xml
+          retention-days: 7
+          if-no-files-found: warn
+      -
+        name: Run Playwright e2e tests
+        run: cd src-ui && npx playwright test --shard ${{ matrix.shard-index }}/${{ matrix.shard-count }}
+      -
+        name: Upload Playwright test results
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: playwright-report
+          path: src-ui/playwright-report
+          retention-days: 7
+
+  tests-coverage-upload:
+    name: "Upload Coverage"
+    runs-on: ubuntu-22.04
+    needs:
+      - tests-backend
+      - tests-frontend
+    steps:
+      -
+        uses: actions/checkout@v4
+      -
+        name: Download frontend coverage
+        uses: actions/download-artifact@v3
+        with:
+          path: src-ui/coverage/
+      -
+        name: Upload frontend coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          # not required for public repos, but intermittently fails otherwise
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: frontend
+          directory: src-ui/coverage/
+          # dont include backend coverage files here
+          files: '!coverage.xml'
+      -
+        name: Download backend coverage
+        uses: actions/download-artifact@v3
+        with:
+          name: backend-coverage-report
+          path: src/
+      -
+        name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          # not required for public repos, but intermittently fails otherwise
+          token: ${{ secrets.CODECOV_TOKEN }}
+          # future expansion
+          flags: backend
+          directory: src/
 
   build-docker-image:
     name: Build Docker image for ${{ github.ref_name }}
@@ -218,7 +331,7 @@ jobs:
         #  a tag
         # Otherwise forks would require a Docker Hub account and secrets setup
         run: |
-          if [[ ${{ github.repository_owner }} == "paperless-ngx" && ( ${{ github.ref_name }} == "main" || ${{ github.ref_name }} == "dev" || ${{ github.ref_name }} == "beta" || ${{ startsWith(github.ref, 'refs/tags/v') }} == "true" ) ]] ; then
+          if [[ ${{ github.repository_owner }} == "paperless-ngx" && ( ${{ github.ref_name }} == "dev" || ${{ github.ref_name }} == "beta" || ${{ startsWith(github.ref, 'refs/tags/v') }} == "true" ) ]] ; then
             echo "Enabling DockerHub image push"
             echo "enable=true" >> $GITHUB_OUTPUT
           else
@@ -235,7 +348,7 @@ jobs:
       -
         name: Gather Docker metadata
         id: docker-meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: |
             ghcr.io/${{ steps.set-ghcr-repository.outputs.ghcr-repository }}
@@ -250,26 +363,28 @@ jobs:
             type=semver,pattern={{major}}.{{minor}}
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       # If https://github.com/docker/buildx/issues/1044 is resolved,
       # the append input with a native arm64 arch could be used to
       # significantly speed up building
       -
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       -
         name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
+        with:
+          platforms: arm64
       -
-        name: Login to Github Container Registry
+        name: Login to GitHub Container Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
       -
         name: Login to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         # Don't attempt to login is not pushing to Docker Hub
         if: steps.push-other-places.outputs.enable == 'true'
         with:
@@ -277,7 +392,7 @@ jobs:
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       -
         name: Login to Quay.io
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         # Don't attempt to login is not pushing to Quay.io
         if: steps.push-other-places.outputs.enable == 'true'
         with:
@@ -286,15 +401,15 @@ jobs:
           password: ${{ secrets.QUAY_ROBOT_TOKEN }}
       -
         name: Build and push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./Dockerfile
-          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.docker-meta.outputs.tags }}
           labels: ${{ steps.docker-meta.outputs.labels }}
-          # Get cache layers from this branch, then dev, then main
+          # Get cache layers from this branch, then dev
           # This allows new branches to get at least some cache benefits, generally from dev
           cache-from: |
             type=registry,ref=ghcr.io/${{ steps.set-ghcr-repository.outputs.ghcr-repository }}/builder/cache/app:${{ github.ref_name }}
@@ -316,15 +431,17 @@ jobs:
         with:
           name: frontend-compiled
           path: src/documents/static/frontend/
+          retention-days: 7
 
   build-release:
+    name: "Build Release"
     needs:
       - build-docker-image
     runs-on: ubuntu-22.04
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Python
         id: setup-python
@@ -336,11 +453,17 @@ jobs:
       -
         name: Install pipenv + tools
         run: |
-          pip install --upgrade --user pipenv==${DEFAULT_PIP_ENV_VERSION} setuptools wheel
+          pip install --upgrade --user pipenv==${{ env.DEFAULT_PIP_ENV_VERSION }} setuptools wheel
       -
         name: Install Python dependencies
         run: |
           pipenv --python ${{ steps.setup-python.outputs.python-version }} sync --dev
+      -
+        name: Patch whitenoise
+        run: |
+          curl --fail --silent --show-error --location --output 484.patch https://github.com/evansd/whitenoise/pull/484.patch
+          patch -d $(pipenv --venv)/lib/python3.10/site-packages --verbose -p2 < 484.patch
+          rm 484.patch
       -
         name: Install system dependencies
         run: |
@@ -424,8 +547,10 @@ jobs:
         with:
           name: release
           path: dist/paperless-ngx.tar.xz
+          retention-days: 7
 
   publish-release:
+    name: "Publish Release"
     runs-on: ubuntu-22.04
     outputs:
       prerelease: ${{ steps.get_version.outputs.prerelease }}
@@ -475,6 +600,7 @@ jobs:
           asset_content_type: application/x-xz
 
   append-changelog:
+    name: "Append Changelog"
     runs-on: ubuntu-22.04
     needs:
       - publish-release
@@ -482,7 +608,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: main
       -
@@ -495,7 +621,7 @@ jobs:
       -
         name: Install pipenv + tools
         run: |
-          pip install --upgrade --user pipenv==${DEFAULT_PIP_ENV_VERSION} setuptools wheel
+          pip install --upgrade --user pipenv==${{ env.DEFAULT_PIP_ENV_VERSION }} setuptools wheel
       -
         name: Append Changelog to docs
         id: append-Changelog

.github/workflows/cleanup-tags.yml

@@ -29,7 +29,7 @@ jobs:
       -
         name: Clean temporary images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/ephemeral@v0.1.0
+        uses: stumpylog/image-cleaner-action/ephemeral@v0.3.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "${{ github.repository_owner }}"
@@ -38,6 +38,7 @@ jobs:
           scheme: "branch"
           repo_name: "paperless-ngx"
           match_regex: "feature-"
+          do_delete: "true"
 
   cleanup-untagged-images:
     name: Cleanup Untagged Images Tags for ${{ matrix.primary-name }}
@@ -51,14 +52,6 @@ jobs:
         include:
           - primary-name: "paperless-ngx"
           - primary-name: "paperless-ngx/builder/cache/app"
-          - primary-name: "paperless-ngx/builder/qpdf"
-          - primary-name: "paperless-ngx/builder/cache/qpdf"
-          - primary-name: "paperless-ngx/builder/pikepdf"
-          - primary-name: "paperless-ngx/builder/cache/pikepdf"
-          - primary-name: "paperless-ngx/builder/jbig2enc"
-          - primary-name: "paperless-ngx/builder/cache/jbig2enc"
-          - primary-name: "paperless-ngx/builder/psycopg2"
-          - primary-name: "paperless-ngx/builder/cache/psycopg2"
           # TODO: Remove the above and replace with the below
           # - primary-name: "builder/qpdf"
           # - primary-name: "builder/cache/qpdf"
@@ -75,9 +68,10 @@ jobs:
       -
         name: Clean untagged images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/untagged@v0.1.0
+        uses: stumpylog/image-cleaner-action/untagged@v0.3.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "${{ github.repository_owner }}"
           is_org: "true"
           package_name: "${{ matrix.primary-name }}"
+          do_delete: "true"

.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/project-actions.yml

@@ -28,7 +28,7 @@ jobs:
     if: github.event_name == 'issues' && (github.event.action == 'opened' || github.event.action == 'reopened')
     steps:
       - name: Add issue to project and set status to ${{ env.todo }}
-        uses: leonsteinhaeuser/project-beta-automations@v2.1.0
+        uses: leonsteinhaeuser/project-beta-automations@v2.2.1
         with:
           gh_token: ${{ secrets.GH_TOKEN }}
           organization: paperless-ngx
@@ -44,7 +44,7 @@ jobs:
     if: github.event_name == 'pull_request_target' && (github.event.action == 'opened' || github.event.action == 'reopened') && github.event.pull_request.user.login != 'dependabot'
     steps:
       - name: Add PR to project and set status to "Needs Review"
-        uses: leonsteinhaeuser/project-beta-automations@v2.1.0
+        uses: leonsteinhaeuser/project-beta-automations@v2.2.1
         with:
           gh_token: ${{ secrets.GH_TOKEN }}
           organization: paperless-ngx

.github/workflows/repo-maintenance.yml

@@ -8,6 +8,7 @@ on:
 permissions:
   issues: write
   pull-requests: write
+  discussions: write
 
 concurrency:
   group: lock
@@ -19,9 +20,9 @@ jobs:
     steps:
       - uses: actions/stale@v8
         with:
-          days-before-stale: 30
+          days-before-stale: 7
-          days-before-close: 7
+          days-before-close: 14
-          only-labels: 'cant-reproduce'
+          any-of-labels: 'cant-reproduce,not a bug'
           stale-issue-label: stale
           stale-pr-label: stale
           stale-issue-message: >
@@ -45,3 +46,54 @@ jobs:
             This pull request has been automatically locked since there
             has not been any recent activity after it was closed.
             Please open a new discussion or issue for related concerns.
+  close-answered-discussions:
+    name: 'Close Answered Discussions'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github-script@v6
+        with:
+          script: |
+            const query = `query($owner:String!, $name:String!) {
+              repository(owner:$owner, name:$name){
+                discussions(first:100, answered:true, states:[OPEN]) {
+                  nodes {
+                    id,
+                    number
+                  }
+                }
+              }
+            }`;
+            const variables = {
+              owner: context.repo.owner,
+              name: context.repo.repo,
+            }
+            const result = await github.graphql(query, variables)
+
+            console.log(`Found ${result.repository.discussions.nodes.length} open answered discussions`)
+
+            for (const discussion of result.repository.discussions.nodes) {
+              console.log(`Closing dicussion #${discussion.number} (${discussion.id})`)
+
+              const addCommentMutation = `mutation($discussion:ID!, $body:String!) {
+                addDiscussionComment(input:{discussionId:$discussion, body:$body}) {
+                  clientMutationId
+                }
+              }`;
+              const commentVariables = {
+                discussion: discussion.id,
+                body: 'This discussion has been automatically closed because it was marked as answered.',
+              }
+              await github.graphql(addCommentMutation, commentVariables)
+
+              const closeDiscussionMutation = `mutation($discussion:ID!, $reason:DiscussionCloseReason!) {
+                closeDiscussion(input:{discussionId:$discussion, reason:$reason}) {
+                  clientMutationId
+                }
+              }`;
+              const closeVariables = {
+                discussion: discussion.id,
+                reason: "RESOLVED",
+              }
+              await github.graphql(closeDiscussionMutation, closeVariables)
+
+            }

.pre-commit-config.yaml

@@ -5,7 +5,7 @@
 repos:
   # General hooks
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-docstring-first
       - id: check-json
@@ -27,7 +27,7 @@ repos:
       - id: check-case-conflict
       - id: detect-private-key
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: 'v2.7.1'
+    rev: 'v3.1.0'
     hooks:
       - id: prettier
         types_or:
@@ -36,17 +36,17 @@ repos:
           - markdown
         exclude: "(^Pipfile\\.lock$)"
   # Python hooks
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
+  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.0.265'
+    rev: 'v0.1.5'
     hooks:
       - id: ruff
-  - repo: https://github.com/psf/black
+  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.3.0
+    rev: 23.11.0
     hooks:
       - id: black
   # Dockerfile hooks
   - repo: https://github.com/AleksaC/hadolint-py
-    rev: v2.12.0.2
+    rev: v2.12.0.3
     hooks:
       - id: hadolint
   # Shell script hooks
@@ -57,6 +57,6 @@ repos:
         args:
           - "--tab"
   - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: "v0.9.0.2"
+    rev: "v0.9.0.6"
     hooks:
       - id: shellcheck

.prettierrc

@@ -1,4 +1,16 @@
+{
     # https://prettier.io/docs/en/options.html#semicolons
-semi: false
+    "semi": false,
     # https://prettier.io/docs/en/options.html#quotes
-singleQuote: true
+    "singleQuote": true,
+    # https://prettier.io/docs/en/options.html#trailing-commas
+    "trailingComma": "es5",
+    "overrides": [
+        {
+            "files": "index.md",
+            "options": {
+                "tabWidth": 4
+            }
+        }
+    ]
+}

.python-version

@@ -1 +1 @@
-3.8.16
+3.9.18

.ruff.toml

@@ -2,13 +2,13 @@
 # https://beta.ruff.rs/docs/rules/
 extend-select = ["I", "W", "UP", "COM", "DJ", "EXE", "ISC", "ICN", "G201", "INP", "PIE", "RSE", "SIM", "TID", "PLC", "PLE", "RUF"]
 # TODO PTH
-ignore = ["DJ001", "SIM105"]
+ignore = ["DJ001", "SIM105", "RUF012"]
 fix = true
 line-length = 88
 respect-gitignore = true
 src = ["src"]
-target-version = "py38"
+target-version = "py39"
-format = "grouped"
+output-format = "grouped"
 show-fixes = true
 
 [per-file-ignores]

CONTRIBUTING.md

@@ -11,7 +11,7 @@ If you want to implement something big:
 
 ## Python
 
-Paperless supports python 3.8 and 3.9. We format Python code with [Black](https://github.com/psf/black).
+Paperless supports python 3.9 - 3.11. We format Python code with [Black](https://github.com/psf/black).
 
 ## Branches
 
@@ -45,7 +45,7 @@ Examples of `non-trivial` PRs might include:
 
 - Additional features
 - Large changes to many distinct files
-- Breaking or depreciation of existing features
+- Breaking or deprecation of existing features
 
 Our community review process for `non-trivial` PRs is the following:
 
@@ -58,6 +58,13 @@ Our community review process for `non-trivial` PRs is the following:
 
 This process might be slow as community members have different schedules and time to dedicate to the Paperless project. However it ensures community code reviews are as brilliantly thorough as they once were with @jonaswinkler.
 
+# AI-Generated Code
+
+This project does not specifically prohibit the use of AI-generated code _during the process_ of creating a PR, however:
+
+1. Any code present in the final PR that was generated using AI sources should be clearly attributed as such and must not violate copyright protections.
+2. We will not accept PRs that are entirely or mostly AI-derived.
+
 # Translating Paperless-ngx
 
 Some notes about translation:

Dockerfile

@@ -1,11 +1,11 @@
-# syntax=docker/dockerfile:1.4
+# syntax=docker/dockerfile:1
 # https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/reference.md
 
 # Stage: compile-frontend
 # Purpose: Compiles the frontend
 # Notes:
 #  - Does NPM stuff with Typescript and such
-FROM --platform=$BUILDPLATFORM node:16-bullseye-slim AS compile-frontend
+FROM --platform=$BUILDPLATFORM docker.io/node:20-bookworm-slim AS compile-frontend
 
 COPY ./src-ui /src/src-ui
 
@@ -21,7 +21,7 @@ RUN set -eux \
 # Comments:
 #  - pipenv dependencies are not left in the final image
 #  - pipenv can't touch the final image somehow
-FROM --platform=$BUILDPLATFORM python:3.9-alpine as pipenv-base
+FROM --platform=$BUILDPLATFORM docker.io/python:3.11-alpine as pipenv-base
 
 WORKDIR /usr/src/pipenv
 
@@ -29,7 +29,7 @@ COPY Pipfile* ./
 
 RUN set -eux \
   && echo "Installing pipenv" \
-    && python3 -m pip install --no-cache-dir --upgrade pipenv==2023.4.20 \
+    && python3 -m pip install --no-cache-dir --upgrade pipenv==2023.10.24 \
   && echo "Generating requirement.txt" \
     && pipenv requirements > requirements.txt
 
@@ -37,7 +37,7 @@ RUN set -eux \
 # Purpose: The final image
 # Comments:
 #  - Don't leave anything extra in here
-FROM python:3.9-slim-bullseye as main-app
+FROM docker.io/python:3.11-slim-bookworm as main-app
 
 LABEL org.opencontainers.image.authors="paperless-ngx team <hello@paperless-ngx.com>"
 LABEL org.opencontainers.image.documentation="https://docs.paperless-ngx.com/"
@@ -47,6 +47,14 @@ LABEL org.opencontainers.image.licenses="GPL-3.0-only"
 
 ARG DEBIAN_FRONTEND=noninteractive
 
+# Buildx provided, must be defined to use though
+ARG TARGETARCH
+
+# Can be workflow provided, defaults set for manual building
+ARG JBIG2ENC_VERSION=0.29
+ARG QPDF_VERSION=11.6.3
+ARG GS_VERSION=10.02.0
+
 #
 # Begin installation and configuration
 # Order the steps below from least often changed to most
@@ -67,23 +75,11 @@ ARG RUNTIME_PACKAGES="\
   gnupg \
   icc-profiles-free \
   imagemagick \
-  # Image processing
-  liblept5 \
-  liblcms2-2 \
-  libtiff5 \
-  libfreetype6 \
-  libwebp6 \
-  libopenjp2-7 \
-  libimagequant0 \
-  libraqm0 \
-  libjpeg62-turbo \
   # PostgreSQL
   libpq5 \
   postgresql-client \
   # MySQL / MariaDB
   mariadb-client \
-  # For Numpy
-  libatlas3-base \
   # OCRmyPDF dependencies
   tesseract-ocr \
   tesseract-ocr-eng \
@@ -93,11 +89,12 @@ ARG RUNTIME_PACKAGES="\
   tesseract-ocr-spa \
   unpaper \
   pngquant \
-  # pikepdf / qpdf
   jbig2dec \
+  # lxml
   libxml2 \
   libxslt1.1 \
-  libgnutls30 \
+  # itself
+  qpdf \
   # Mime type detection
   file \
   libmagic1 \
@@ -105,9 +102,7 @@ ARG RUNTIME_PACKAGES="\
   zlib1g \
   # Barcode splitter
   libzbar0 \
-  poppler-utils \
+  poppler-utils"
-  # RapidFuzz on armv7
-  libatomic1"
 
 # Install basic runtime packages.
 # These change very infrequently
@@ -115,7 +110,37 @@ RUN set -eux \
   echo "Installing system packages" \
     && apt-get update \
     && apt-get install --yes --quiet --no-install-recommends ${RUNTIME_PACKAGES} \
-    && rm -rf /var/lib/apt/lists/* \
+    && echo "Installing pre-built updates" \
+      && echo "Installing qpdf ${QPDF_VERSION}" \
+        && curl --fail --silent --show-error --location \
+          --output libqpdf29_${QPDF_VERSION}-1_${TARGETARCH}.deb \
+          https://github.com/paperless-ngx/builder/releases/download/qpdf-${QPDF_VERSION}/libqpdf29_${QPDF_VERSION}-1_${TARGETARCH}.deb \
+        && curl --fail --silent --show-error --location \
+          --output qpdf_${QPDF_VERSION}-1_${TARGETARCH}.deb \
+          https://github.com/paperless-ngx/builder/releases/download/qpdf-${QPDF_VERSION}/qpdf_${QPDF_VERSION}-1_${TARGETARCH}.deb \
+        && dpkg --install ./libqpdf29_${QPDF_VERSION}-1_${TARGETARCH}.deb \
+        && dpkg --install ./qpdf_${QPDF_VERSION}-1_${TARGETARCH}.deb \
+      && echo "Installing Ghostscript ${GS_VERSION}" \
+        && curl --fail --silent --show-error --location \
+          --output libgs10_${GS_VERSION}.dfsg-2_${TARGETARCH}.deb \
+          https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/libgs10_${GS_VERSION}.dfsg-2_${TARGETARCH}.deb \
+        && curl --fail --silent --show-error --location \
+          --output ghostscript_${GS_VERSION}.dfsg-2_${TARGETARCH}.deb \
+          https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/ghostscript_${GS_VERSION}.dfsg-2_${TARGETARCH}.deb \
+        && curl --fail --silent --show-error --location \
+          --output libgs10-common_${GS_VERSION}.dfsg-2_all.deb \
+          https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/libgs10-common_${GS_VERSION}.dfsg-2_all.deb \
+        && dpkg --install ./libgs10-common_${GS_VERSION}.dfsg-2_all.deb \
+        && dpkg --install ./libgs10_${GS_VERSION}.dfsg-2_${TARGETARCH}.deb \
+        && dpkg --install ./ghostscript_${GS_VERSION}.dfsg-2_${TARGETARCH}.deb \
+      && echo "Installing jbig2enc" \
+        && curl --fail --silent --show-error --location \
+          --output jbig2enc_${JBIG2ENC_VERSION}-1_${TARGETARCH}.deb \
+          https://github.com/paperless-ngx/builder/releases/download/jbig2enc-${JBIG2ENC_VERSION}/jbig2enc_${JBIG2ENC_VERSION}-1_${TARGETARCH}.deb \
+        && dpkg --install ./jbig2enc_${JBIG2ENC_VERSION}-1_${TARGETARCH}.deb \
+      && echo "Cleaning up image layer" \
+        && rm --force --verbose *.deb \
+    && rm --recursive --force --verbose /var/lib/apt/lists/* \
   && echo "Installing supervisor" \
     && python3 -m pip install --default-timeout=1000 --upgrade --no-cache-dir supervisor==4.2.5
 
@@ -166,43 +191,6 @@ RUN set -eux \
     && chmod +x install_management_commands.sh \
     && ./install_management_commands.sh
 
-# Buildx provided, must be defined to use though
-ARG TARGETARCH
-ARG TARGETVARIANT
-
-# Can be workflow provided, defaults set for manual building
-ARG JBIG2ENC_VERSION=0.29
-ARG QPDF_VERSION=11.3.0
-ARG PIKEPDF_VERSION=7.2.0
-ARG PSYCOPG2_VERSION=2.9.6
-
-# Install the built packages from the installer library images
-# These change sometimes
-RUN set -eux \
-  && echo "Getting binaries" \
-    && mkdir paperless-ngx \
-    && curl --fail --silent --show-error --output paperless-ngx.tar.gz --location https://github.com/paperless-ngx/builder/archive/3d6574e2dbaa8b8cdced864a256b0de59015f605.tar.gz \
-    && tar -xf paperless-ngx.tar.gz --directory paperless-ngx --strip-components=1 \
-    && cd paperless-ngx \
-    # Setting a specific revision ensures we know what this installed
-    # and ensures cache breaking on changes
-  && echo "Installing jbig2enc" \
-    && cp ./jbig2enc/${JBIG2ENC_VERSION}/${TARGETARCH}${TARGETVARIANT}/jbig2 /usr/local/bin/ \
-    && cp ./jbig2enc/${JBIG2ENC_VERSION}/${TARGETARCH}${TARGETVARIANT}/libjbig2enc* /usr/local/lib/ \
-  && echo "Installing qpdf" \
-    && apt-get install --yes --no-install-recommends ./qpdf/${QPDF_VERSION}/${TARGETARCH}${TARGETVARIANT}/libqpdf29_*.deb \
-    && apt-get install --yes --no-install-recommends ./qpdf/${QPDF_VERSION}/${TARGETARCH}${TARGETVARIANT}/qpdf_*.deb \
-  && echo "Installing pikepdf and dependencies" \
-    && python3 -m pip install --no-cache-dir ./pikepdf/${PIKEPDF_VERSION}/${TARGETARCH}${TARGETVARIANT}/*.whl \
-    && python3 -m pip list \
-  && echo "Installing psycopg2" \
-    && python3 -m pip install --no-cache-dir ./psycopg2/${PSYCOPG2_VERSION}/${TARGETARCH}${TARGETVARIANT}/psycopg2*.whl \
-    && python3 -m pip list \
-  && echo "Cleaning up image layer" \
-    && cd ../ \
-    && rm -rf paperless-ngx \
-    && rm paperless-ngx.tar.gz
-
 WORKDIR /usr/src/paperless/src/
 
 # Python dependencies
@@ -214,42 +202,59 @@ COPY --from=pipenv-base /usr/src/pipenv/requirements.txt ./
 ARG BUILD_PACKAGES="\
   build-essential \
   git \
+  # https://www.psycopg.org/docs/install.html#prerequisites
+  libpq-dev \
+  # https://github.com/PyMySQL/mysqlclient#linux
   default-libmysqlclient-dev \
-  python3-dev"
+  pkg-config"
 
-RUN set -eux \
+# hadolint ignore=DL3042
+RUN --mount=type=cache,target=/root/.cache/pip/,id=pip-cache \
+  set -eux \
   && echo "Installing build system packages" \
     && apt-get update \
     && apt-get install --yes --quiet --no-install-recommends ${BUILD_PACKAGES} \
     && python3 -m pip install --no-cache-dir --upgrade wheel \
   && echo "Installing Python requirements" \
-    && python3 -m pip install --default-timeout=1000 --no-cache-dir --requirement requirements.txt \
+    && python3 -m pip install --default-timeout=1000 --requirement requirements.txt \
+  && echo "Patching whitenoise for compression speedup" \
+    && curl --fail --silent --show-error --location --output 484.patch https://github.com/evansd/whitenoise/pull/484.patch \
+    && patch -d /usr/local/lib/python3.11/site-packages --verbose -p2 < 484.patch \
+    && rm 484.patch \
   && echo "Installing NLTK data" \
     && python3 -W ignore::RuntimeWarning -m nltk.downloader -d "/usr/share/nltk_data" snowball_data \
     && python3 -W ignore::RuntimeWarning -m nltk.downloader -d "/usr/share/nltk_data" stopwords \
     && python3 -W ignore::RuntimeWarning -m nltk.downloader -d "/usr/share/nltk_data" punkt \
   && echo "Cleaning up image" \
-    && apt-get -y purge ${BUILD_PACKAGES} \
+    && apt-get --yes purge ${BUILD_PACKAGES} \
-    && apt-get -y autoremove --purge \
+    && apt-get --yes autoremove --purge \
     && apt-get clean --yes \
-    && rm -rf /var/lib/apt/lists/* \
+    && rm --recursive --force --verbose /var/lib/apt/lists/* \
-    && rm -rf /tmp/* \
+    && rm --recursive --force --verbose /tmp/* \
-    && rm -rf /var/tmp/* \
+    && rm --recursive --force --verbose /var/tmp/* \
-    && rm -rf /var/cache/apt/archives/* \
+    && rm --recursive --force --verbose /var/cache/apt/archives/* \
-    && truncate -s 0 /var/log/*log
+    && truncate --size 0 /var/log/*log
 
 # copy backend
-COPY ./src ./
+COPY --chown=1000:1000 ./src ./
 
 # copy frontend
-COPY --from=compile-frontend /src/src/documents/static/frontend/ ./documents/static/frontend/
+COPY --from=compile-frontend --chown=1000:1000 /src/src/documents/static/frontend/ ./documents/static/frontend/
 
 # add users, setup scripts
 # Mount the compiled frontend to expected location
 RUN set -eux \
+  && echo "Setting up user/group" \
     && addgroup --gid 1000 paperless \
     && useradd --uid 1000 --gid paperless --home-dir /usr/src/paperless paperless \
-  && chown -R paperless:paperless /usr/src/paperless \
+  && echo "Creating volume directories" \
+    && mkdir --parents --verbose /usr/src/paperless/data \
+    && mkdir --parents --verbose /usr/src/paperless/media \
+    && mkdir --parents --verbose /usr/src/paperless/consume \
+    && mkdir --parents --verbose /usr/src/paperless/export \
+  && echo "Adjusting all permissions" \
+    && chown --from root:root --changes --recursive paperless:paperless /usr/src/paperless \
+  && echo "Collecting static files" \
     && gosu paperless python3 manage.py collectstatic --clear --no-input --link \
     && gosu paperless python3 manage.py compilemessages
 

Pipfile

@@ -3,68 +3,57 @@ url = "https://pypi.python.org/simple"
 verify_ssl = true
 name = "pypi"
 
-[[source]]
-url = "https://www.piwheels.org/simple"
-verify_ssl = true
-name = "piwheels"
-
 [packages]
 dateparser = "~=1.1"
 # WARNING: django does not use semver.
 #          Only patch versions are guaranteed to not introduce breaking changes.
-django = "~=4.1.9"
+django = "~=4.2.7"
-django-cors-headers = "*"
+django-auditlog = "*"
 django-celery-results = "*"
 django-compression-middleware = "*"
-django-guardian = "*"
+django-cors-headers = "*"
 django-extensions = "*"
-django-filter = "~=22.1"
+django-filter = "~=23.3"
+django-guardian = "*"
+django-multiselectfield = "*"
 djangorestframework = "~=3.14"
 djangorestframework-guardian = "*"
-filelock = "*"
+drf-writable-nested = "*"
-gunicorn = "*"
+bleach = "*"
-imap-tools = "*"
+celery = "*"
-langdetect = "*"
-pathvalidate = "*"
-pillow = "*"
-pikepdf = "*"
-python-gnupg = "*"
-python-dotenv = "*"
-python-dateutil = "*"
-python-magic = "*"
-python-ipware = "*"
-psycopg2 = "*"
-rapidfuzz = "*"
-redis = {extras = ["hiredis"], version = "*"}
-scikit-learn = "~=1.2"
-numpy = "*"
-whitenoise = "~=6.3"
-watchdog = "~=2.2"
-whoosh="~=2.7"
-inotifyrecursive = "~=0.3"
-ocrmypdf = "~=14.0"
-tqdm = "*"
-tika = "*"
 channels = "~=4.0"
 channels-redis = "*"
-uvicorn = {extras = ["standard"], version = "*"}
 concurrent-log-handler = "*"
-pyzbar = "*"
+filelock = "*"
-mysqlclient = "*"
-celery = {extras = ["redis"], version = "*"}
-setproctitle = "*"
-nltk = "*"
-pdf2image = "*"
 flower = "*"
-bleach = "*"
+gotenberg-client = "*"
+gunicorn = "*"
+imap-tools = "*"
+inotifyrecursive = "~=0.3"
+langdetect = "*"
+mysqlclient = "*"
+nltk = "*"
+ocrmypdf = "~=15.0"
+pathvalidate = "*"
+pdf2image = "*"
+psycopg2 = "*"
+python-dateutil = "*"
+python-dotenv = "*"
+python-gnupg = "*"
+python-ipware = "*"
+python-magic = "*"
+pyzbar = "*"
+rapidfuzz = "*"
+redis = {extras = ["hiredis"], version = "*"}
+scikit-learn = "~=1.3"
+setproctitle = "*"
+tika-client = "*"
+tqdm = "*"
+uvicorn = {extras = ["standard"], version = "*"}
+watchdog = "~=3.0"
+whitenoise = "~=6.6"
+whoosh="~=2.7"
 zxing-cpp = {version = "*", platform_machine = "== 'x86_64'"}
-#
-# Packages locked due to issues (try to check if these are fixed in a release every so often)
-#
-# Pin this until piwheels is building 1.9 (see https://www.piwheels.org/project/scipy/)
-scipy = "==1.8.1"
-# v4 brings in extra dependencies for features not used here
-reportlab = "==3.6.12"
 
 [dev-packages]
 # Linting
@@ -76,14 +65,16 @@ factory-boy = "*"
 pytest = "*"
 pytest-cov = "*"
 pytest-django = "*"
+pytest-httpx = "*"
 pytest-env = "*"
 pytest-sugar = "*"
 pytest-xdist = "*"
-"pdfminer.six" = "*"
+pytest-rerunfailures = "*"
 imagehash = "*"
 daphne = "*"
 # Documentation
 mkdocs-material = "*"
+mkdocs-glightbox = "*"
 
 [typing-dev]
 mypy = "*"
@@ -95,12 +86,10 @@ celery-types = "*"
 django-stubs = {extras= ["compatible-mypy"], version="*"}
 types-dateparser = "*"
 types-bleach = "*"
-types-humanfriendly = "*"
 types-redis = "*"
 types-tqdm = "*"
 types-Markdown = "*"
 types-Pygments = "*"
-types-backports = "*"
 types-colorama = "*"
 types-psycopg2 = "*"
 types-setuptools = "*"

README.md

@@ -16,8 +16,7 @@
 
 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
+Paperless-ngx is the official successor to the original [Paperless](https://github.com/the-paperless-project/paperless) & [Paperless-ng](https://github.com/jonaswinkler/paperless-ng) projects and is designed to distribute the responsibility of advancing and supporting the project among a team of people. [Consider joining us!](#community-support)
-[#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._
 
@@ -36,32 +35,11 @@ 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/assets/screenshots/documents-smallcards.png#gh-light-mode-only)
 ![Dashboard](https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docs/assets/screenshots/documents-smallcards-dark.png#gh-dark-mode-only)
 
-- Organize and index your scanned documents with tags, correspondents, types, and more.
+A full list of [features](https://docs.paperless-ngx.com/#features) and [screenshots](https://docs.paperless-ngx.com/#screenshots) are available in the [documentation](https://docs.paperless-ngx.com/).
-- Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents.
-- Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents).
-  - Office document support is optional and provided by Apache Tika (see [configuration](https://docs.paperless-ngx.com/configuration/#tika))
-- Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely.
-- Single page application front end.
-  - Includes a dashboard that shows basic statistics and has document upload.
-  - Filtering by tags, correspondents, types, and more.
-  - Customizable views can be saved and displayed on the dashboard.
-- Full text search helps you find what you need.
-  - Auto completion suggests relevant words from your documents.
-  - Results are sorted by relevance to your search query.
-  - Highlighting shows you which parts of the document matched the query.
-  - Searching for similar documents ("More like this")
-- Email processing: Paperless adds documents from your email accounts.
-  - Configure multiple accounts and filters for each account.
-  - When adding documents from mail, paperless can move these mail to a new folder, mark them as read, flag them as important or delete them.
-- Machine learning powered document matching.
-  - Paperless-ngx learns from your documents and will be able to automatically assign tags, correspondents and types to documents once you've stored a few documents in paperless.
-- Optimized for multi core systems: Paperless-ngx consumes multiple documents in parallel.
-- The integrated sanity checker makes sure that your document archive is in good health.
-- [More screenshots are available in the documentation](https://docs.paperless-ngx.com/#screenshots).
 
 # Getting started
 
-The easiest way to deploy paperless is docker-compose. The files in the [`/docker/compose` directory](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose) are configured to pull the image from Github Packages.
+The easiest way to deploy paperless is docker-compose. The files in the [`/docker/compose` directory](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose) are configured to pull the image from GitHub Packages.
 
 If you'd like to jump right in, you can configure a docker-compose environment with our install script:
 
@@ -85,7 +63,7 @@ If you feel like contributing to the project, please do! Bug fixes, enhancements
 
 ## Community Support
 
-People interested in continuing the work on paperless-ngx are encouraged to reach out here on github and in the [Matrix Room](https://matrix.to/#/#paperless:adnidor.de). If you would like to contribute to the project on an ongoing basis there are multiple [teams](https://github.com/orgs/paperless-ngx/people) (frontend, ci/cd, etc) that could use your help so please reach out!
+People interested in continuing the work on paperless-ngx are encouraged to reach out here on github and in the [Matrix Room](https://matrix.to/#/#paperless:matrix.org). If you would like to contribute to the project on an ongoing basis there are multiple [teams](https://github.com/orgs/paperless-ngx/people) (frontend, ci/cd, etc) that could use your help so please reach out!
 
 ## Translation
 
@@ -101,14 +79,7 @@ For bugs please [open an issue](https://github.com/paperless-ngx/paperless-ngx/i
 
 # Affiliated Projects
 
-Paperless has been around for a while now, and people have built tools that interact with it. If you're one of them, please reach out and we can add your project to the list. Current projects include:
+Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Affiliated-Projects) for a user-maintained list of affiliated projects and software that is compatible with Paperless-ngx.
-
-- **Mobile**
-  - [Paperless App](https://github.com/bauerj/paperless_app): An Android/iOS application for Paperless-ngx.
-  - [Paperless Mobile](https://github.com/astubenbord/paperless-mobile): A modern, feature rich Android app for Paperless-ngx.
-  - [Paperless Share](https://github.com/qcasey/paperless_share): Share any files from your Android application with Paperless-ngx. Very simple, but works with all mobile scanning apps that allow you to share scanned documents.
-- **Desktop**
-  - [Scan to Paperless](https://github.com/sbrunner/scan-to-paperless): Scan and prepare (crop, deskew, OCR, ...) your documents for use in Paperless-ngx.
 
 # Important Note
 

crowdin.yml

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

docker/compose/docker-compose.portainer.yml

@@ -37,7 +37,7 @@ services:
       - redisdata:/data
 
   db:
-    image: docker.io/library/postgres:13
+    image: docker.io/library/postgres:15
     restart: unless-stopped
     volumes:
       - pgdata:/var/lib/postgresql/data

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

@@ -39,7 +39,7 @@ services:
       - redisdata:/data
 
   db:
-    image: docker.io/library/postgres:13
+    image: docker.io/library/postgres:15
     restart: unless-stopped
     volumes:
       - pgdata:/var/lib/postgresql/data

docker/compose/docker-compose.postgres.yml

@@ -35,7 +35,7 @@ services:
       - redisdata:/data
 
   db:
-    image: docker.io/library/postgres:13
+    image: docker.io/library/postgres:15
     restart: unless-stopped
     volumes:
       - pgdata:/var/lib/postgresql/data

docker/docker-prepare.sh

@@ -80,7 +80,7 @@ django_checks() {
 
 search_index() {
 
-	local -r index_version=5
+	local -r index_version=7
 	local -r index_version_file=${DATA_DIR}/.index_version
 
 	if [[ (! -f "${index_version_file}") || $(<"${index_version_file}") != "$index_version" ]]; then

docker/install_management_commands.sh

@@ -13,6 +13,7 @@ for command in decrypt_documents \
 	document_retagger \
 	document_thumbnails \
 	document_sanity_checker \
+	document_fuzzy_match \
 	manage_superuser;
 do
 	echo "installing $command..."

docker/supervisord.conf

@@ -15,6 +15,7 @@ stdout_logfile=/dev/stdout
 stdout_logfile_maxbytes=0
 stderr_logfile=/dev/stderr
 stderr_logfile_maxbytes=0
+environment = HOME="/usr/src/paperless",USER="paperless"
 
 [program:consumer]
 command=python3 manage.py document_consumer
@@ -25,6 +26,7 @@ stdout_logfile=/dev/stdout
 stdout_logfile_maxbytes=0
 stderr_logfile=/dev/stderr
 stderr_logfile_maxbytes=0
+environment = HOME="/usr/src/paperless",USER="paperless"
 
 [program:celery]
 
@@ -37,6 +39,7 @@ stdout_logfile=/dev/stdout
 stdout_logfile_maxbytes=0
 stderr_logfile=/dev/stderr
 stderr_logfile_maxbytes=0
+environment = HOME="/usr/src/paperless",USER="paperless"
 
 [program:celery-beat]
 
@@ -48,6 +51,7 @@ stdout_logfile=/dev/stdout
 stdout_logfile_maxbytes=0
 stderr_logfile=/dev/stderr
 stderr_logfile_maxbytes=0
+environment = HOME="/usr/src/paperless",USER="paperless"
 
 [program:celery-flower]
 command = /usr/local/bin/flower-conditional.sh
@@ -58,3 +62,4 @@ stdout_logfile=/dev/stdout
 stdout_logfile_maxbytes=0
 stderr_logfile=/dev/stderr
 stderr_logfile_maxbytes=0
+environment = HOME="/usr/src/paperless",USER="paperless"

docker/wait-for-redis.py

@@ -28,7 +28,7 @@ if __name__ == "__main__":
             except Exception as e:
                 print(
                     f"Redis ping #{attempt} failed.\n"
-                    f"Error: {str(e)}.\n"
+                    f"Error: {e!s}.\n"
                     f"Waiting {RETRY_SLEEP_SECONDS}s",
                     flush=True,
                 )

docs/administration.md

@@ -10,8 +10,8 @@ Before making backups, make sure that paperless is not running.
 Options available to any installation of paperless:
 
 - Use the [document exporter](#exporter). The document exporter exports all your documents,
-  thumbnails and metadata to a specific folder. You may import your
+  thumbnails, metadata, and database contents to a specific folder. You may import your
-  documents into a fresh instance of paperless again or store your
+  documents and settings into a fresh instance of paperless again or store your
   documents in another DMS with this export.
 - The document exporter is also able to update an already existing
   export. Therefore, incremental backups with `rsync` are entirely
@@ -78,7 +78,7 @@ After that, [make a backup](#backup).
     The docker-compose files refer to the `latest` version, which is
     always the latest stable release.
 
-2. If you built the image yourself, do the following:
+1.  If you built the image yourself, do the following:
 
     ```shell-session
     $ git pull
@@ -139,7 +139,7 @@ following:
 1.  Update dependencies. New paperless version may require additional
     dependencies. The dependencies required are listed in the section
     about
-    [bare metal installations](/setup#bare_metal).
+    [bare metal installations](setup.md#bare_metal).
 
 2.  Update python requirements. Keep in mind to activate your virtual
     environment before that, if you use one.
@@ -148,6 +148,13 @@ following:
     $ pip install -r requirements.txt
     ```
 
+    !!! note
+
+        At times, some dependencies will be removed from requirements.txt.
+        Comparing the versions and removing no longer needed dependencies
+        will keep your system or virtual environment clean and prevent
+        possible conflicts.
+
 3.  Migrate the database.
 
     ```shell-session
@@ -160,6 +167,16 @@ following:
     This might not actually do anything. Not every new paperless version
     comes with new database migrations.
 
+### Database Upgrades
+
+In general, paperless does not require a specific version of PostgreSQL or MariaDB and it is
+safe to update them to newer versions. However, you should always take a backup and follow
+the instructions from your database's documentation for how to upgrade between major versions.
+
+For PostgreSQL, refer to [Upgrading a PostgreSQL Cluster](https://www.postgresql.org/docs/current/upgrading.html).
+
+For MariaDB, refer to [Upgrading MariaDB](https://mariadb.com/kb/en/upgrading/)
+
 ## Downgrading Paperless {#downgrade-paperless}
 
 Downgrades are possible. However, some updates also contain database
@@ -222,8 +239,9 @@ with the argument `--help`.
 
 ### Document exporter {#exporter}
 
-The document exporter exports all your data from paperless into a folder
+The document exporter exports all your data (including your settings
-for backup or migration to another DMS.
+and database contents) from paperless into a folder for backup or
+migration to another DMS.
 
 If you use the document exporter within a cronjob to backup your data
 you might use the `-T` flag behind exec to suppress "The input device
@@ -241,7 +259,8 @@ optional arguments:
 -nt, --no-thumbnail
 -p,  --use-folder-prefix
 -sm, --split-manifest
--z  --zip
+-z,  --zip
+-zn, --zip-name
 ```
 
 `target` is a folder to which the data gets written. This includes
@@ -269,7 +288,7 @@ other files.
 
 The filenames generated by this command follow the format
 `[date created] [correspondent] [title].[extension]`. If you want
-paperless to use `PAPERLESS_FILENAME_FORMAT` for exported filenames
+paperless to use [`PAPERLESS_FILENAME_FORMAT`](configuration.md#PAPERLESS_FILENAME_FORMAT) for exported filenames
 instead, specify `-f` or `--use-filename-format`.
 
 If `-na` or `--no-archive` is provided, no archive files will be exported,
@@ -297,7 +316,8 @@ manifest.json will still contain application wide information (e.g. tags, corres
 documenttype, etc)
 
 If `-z` or `--zip` is provided, the export will be a zip file
-in the target directory, named according to the current date.
+in the target directory, named according to the current local date or the
+value set in `-zn` or `--zip-name`.
 
 !!! warning
 
@@ -334,7 +354,7 @@ currently-imported docs. This problem is common enough that there are
 tools for it.
 
 ```
-document_retagger [-h] [-c] [-T] [-t] [-i] [--use-first] [-f]
+document_retagger [-h] [-c] [-T] [-t] [-i] [--id-range] [--use-first] [-f]
 
 optional arguments:
 -c, --correspondent
@@ -342,6 +362,7 @@ optional arguments:
 -t, --document_type
 -s, --storage_path
 -i, --inbox-only
+--id-range
 --use-first
 -f, --overwrite
 ```
@@ -358,6 +379,11 @@ Specify `-i` to have the document retagger work on documents tagged with
 inbox tags only. This is useful when you don't want to mess with your
 already processed documents.
 
+Specify `--id-range 1 100` to have the document retagger work only on a
+specific range of document id´s. This can be useful if you have a lot of
+documents and want to test the matching rules only on a subset of
+documents.
+
 When multiple document types or correspondents match a single document,
 the retagger won't assign these to the document. Specify `--use-first`
 to override this behavior and just use the first correspondent or type
@@ -389,6 +415,9 @@ This command takes no arguments.
 
 Use this command to re-create document thumbnails. Optionally include the ` --document {id}` option to generate thumbnails for a specific document only.
 
+You may also specify `--processes` to control the number of processes used to generate new thumbnails. The default is to utilize
+a quarter of the available processors.
+
 ```
 document_thumbnails
 ```
@@ -416,7 +445,7 @@ task scheduler.
 ### Managing filenames {#renamer}
 
 If you use paperless' feature to
-[assign custom filenames to your documents](/advanced_usage#file-name-handling), you can use this command to move all your files after
+[assign custom filenames to your documents](advanced_usage.md#file-name-handling), you can use this command to move all your files after
 changing the naming scheme.
 
 !!! warning
@@ -453,7 +482,7 @@ The issues detected by the sanity checker are as follows:
 - Inaccessible thumbnails due to improper permissions.
 - Documents without any content (warning).
 - Orphaned files in the media directory (warning). These are files
-  that are not referenced by any document im paperless.
+  that are not referenced by any document in paperless.
 
 ```
 document_sanity_checker
@@ -522,7 +551,7 @@ Documents can be stored in Paperless using GnuPG encryption.
 
 !!! warning
 
-    Encryption is deprecated since [paperless-ng 0.9](/changelog#paperless-ng-090) and doesn't really
+    Encryption is deprecated since [paperless-ng 0.9](changelog.md#paperless-ng-090) and doesn't really
     provide any additional security, since you have to store the passphrase
     in a configuration file on the same system as the encrypted documents
     for paperless to work. Furthermore, the entire text content of the
@@ -543,9 +572,30 @@ Enabling encryption is no longer supported.
 
 Basic usage to disable encryption of your document store:
 
-(Note: If `PAPERLESS_PASSPHRASE` isn't set already, you need to specify
+(Note: If [`PAPERLESS_PASSPHRASE`](configuration.md#PAPERLESS_PASSPHRASE) isn't set already, you need to specify
 it here)
 
 ```
 decrypt_documents [--passphrase SECR3TP4SSPHRA$E]
 ```
+
+### Detecting duplicates {#fuzzy_duplicate}
+
+Paperless already catches and prevents upload of exactly matching documents,
+however a new scan of an existing document may not produce an exact bit for bit
+duplicate. But the content should be exact or close, allowing detection.
+
+This tool does a fuzzy match over document content, looking for
+those which look close according to a given ratio.
+
+At this time, other metadata (such as correspondent or type) is not
+take into account by the detection.
+
+```
+document_fuzzy_match [--ratio] [--processes N]
+```
+
+| Option      | Required | Default             | Description                                                                                                                    |
+| ----------- | -------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| --ratio     | No       | 85.0                | a number between 0 and 100, setting how similar a document must be for it to be reported. Higher numbers mean more similarity. |
+| --processes | No       | 1/4 of system cores | Number of processes to use for matching. Setting 1 disables multiple processes                                                 |

docs/advanced_usage.md

@@ -1,6 +1,6 @@
 # Advanced Topics
 
-Paperless offers a couple features that automate certain tasks and make
+Paperless offers a couple of features that automate certain tasks and make
 your life easier.
 
 ## Matching tags, correspondents, document types, and storage paths {#matching}
@@ -35,9 +35,10 @@ The following algorithms are available:
   (i.e. preserve ordering) in the PDF.
 - **Regular expression:** Parses the match as a regular expression and
   tries to find a match within the document.
-- **Fuzzy match:** I don't know. Look at the source.
+- **Fuzzy match:** Uses a partial matching based on locating the tag text
+  inside the document, using a [partial ratio](https://maxbachmann.github.io/RapidFuzz/Usage/fuzz.html#partial-ratio)
 - **Auto:** Tries to automatically match new documents. This does not
-  require you to set a match. See the notes below.
+  require you to set a match. See the [notes below](#automatic-matching).
 
 When using the _any_ or _all_ matching algorithms, you can search for
 terms that consist of multiple words by enclosing them in double quotes.
@@ -92,7 +93,7 @@ when using this feature:
   decide when not to assign a certain tag, correspondent, document
   type, or storage path. This will usually be the case as you start
   filling up paperless with documents. Example: If all your documents
-  are either from "Webshop" and "Bank", paperless will assign one
+  are either from "Webshop" or "Bank", paperless will assign one
   of these correspondents to ANY new document, if both are set to
   automatic matching.
 
@@ -101,12 +102,12 @@ when using this feature:
 Sometimes you may want to do something arbitrary whenever a document is
 consumed. Rather than try to predict what you may want to do, Paperless
 lets you execute scripts of your own choosing just before or after a
-document is consumed using a couple simple hooks.
+document is consumed using a couple of simple hooks.
 
 Just write a script, put it somewhere that Paperless can read & execute,
 and then put the path to that script in `paperless.conf` or
 `docker-compose.env` with the variable name of either
-`PAPERLESS_PRE_CONSUME_SCRIPT` or `PAPERLESS_POST_CONSUME_SCRIPT`.
+[`PAPERLESS_PRE_CONSUME_SCRIPT`](configuration.md#PAPERLESS_PRE_CONSUME_SCRIPT) or [`PAPERLESS_POST_CONSUME_SCRIPT`](configuration.md#PAPERLESS_POST_CONSUME_SCRIPT).
 
 !!! info
 
@@ -126,6 +127,7 @@ script can access the following relevant environment variables set:
 | ----------------------- | ------------------------------------------------------------ |
 | `DOCUMENT_SOURCE_PATH`  | Original path of the consumed document                       |
 | `DOCUMENT_WORKING_PATH` | Path to a copy of the original that consumption will work on |
+| `TASK_ID`               | UUID of the task used to process the new document (if any)   |
 
 !!! note
 
@@ -169,7 +171,7 @@ has moved it into paperless. It receives the following environment
 variables:
 
 | Environment Variable         | Description                                    |
-| ---------------------------- | --------------------------------------------- |
+| ---------------------------- | ---------------------------------------------- |
 | `DOCUMENT_ID`                | Database primary key of the document           |
 | `DOCUMENT_FILE_NAME`         | Formatted filename, not including paths        |
 | `DOCUMENT_CREATED`           | Date & time when document created              |
@@ -183,6 +185,7 @@ variables:
 | `DOCUMENT_CORRESPONDENT`     | Assigned correspondent (if any)                |
 | `DOCUMENT_TAGS`              | Comma separated list of tags applied (if any)  |
 | `DOCUMENT_ORIGINAL_FILENAME` | Filename of original document                  |
+| `TASK_ID`                    | Task UUID used to import the document (if any) |
 
 The script can be in any language, A simple shell script example:
 
@@ -197,7 +200,7 @@ The script can be in any language, A simple shell script example:
 !!! warning
 
     The post consumption script should not modify the document files
-    directly
+    directly.
 
 The script's stdout and stderr will be logged line by line to the
 webserver log, along with the exit code of the script.
@@ -248,7 +251,7 @@ document. You will end up getting files like `0000123.pdf` in your media
 directory. This isn't necessarily a bad thing, because you normally
 don't have to access these files manually. However, if you wish to name
 your files differently, you can do that by adjusting the
-`PAPERLESS_FILENAME_FORMAT` configuration option. Paperless adds the
+[`PAPERLESS_FILENAME_FORMAT`](configuration.md#PAPERLESS_FILENAME_FORMAT) configuration option. Paperless adds the
 correct file extension e.g. `.pdf`, `.jpg` automatically.
 
 This variable allows you to configure the filename (folders are allowed)
@@ -311,6 +314,7 @@ Paperless provides the following placeholders within filenames:
 - `{added_day}`: Day added only (number 01-31).
 - `{owner_username}`: Username of document owner, if any, or "none"
 - `{original_name}`: Document original filename, minus the extension, if any, or "none"
+- `{doc_pk}`: The paperless identifier (primary key) for the document.
 
 Paperless will try to conserve the information from your database as
 much as possible. However, some characters that you can use in document
@@ -340,7 +344,7 @@ value.
     Paperless checks the filename of a document whenever it is saved.
     Therefore, you need to update the filenames of your documents and move
     them after altering this setting by invoking the
-    [`document renamer`](/administration#renamer).
+    [`document renamer`](administration.md#renamer).
 
 !!! warning
 
@@ -375,7 +379,7 @@ When a single storage layout is not sufficient for your use case,
 storage paths come to the rescue. Storage paths allow you to configure
 more precisely where each document is stored in the file system.
 
-- Each storage path is a `PAPERLESS_FILENAME_FORMAT` and
+- Each storage path is a [`PAPERLESS_FILENAME_FORMAT`](configuration.md#PAPERLESS_FILENAME_FORMAT) and
   follows the rules described above
 - Each document is assigned a storage path using the matching
   algorithms described above, but can be overwritten at any time
@@ -415,7 +419,7 @@ Insurances/                             # Insurances
 !!! tip
 
     Defining a storage path is optional. If no storage path is defined for a
-    document, the global `PAPERLESS_FILENAME_FORMAT` is applied.
+    document, the global [`PAPERLESS_FILENAME_FORMAT`](configuration.md#PAPERLESS_FILENAME_FORMAT) is applied.
 
 ## Celery Monitoring {#celery-monitoring}
 
@@ -488,7 +492,7 @@ database to be case sensitive. This would prevent a user from creating a
 tag `Name` and `NAME` as they are considered the same.
 
 Per Django documentation, to enable this requires manual intervention.
-To enable case sensetive tables, you can execute the following command
+To enable case sensitive tables, you can execute the following command
 against each table:
 
 `ALTER TABLE <table_name> CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;`
@@ -508,7 +512,7 @@ existing tables) with:
 
 Paperless is able to utilize barcodes for automatically preforming some tasks.
 
-At this time, the library utilized for detection of bacodes supports the following types:
+At this time, the library utilized for detection of barcodes supports the following types:
 
 - AN-13/UPC-A
 - UPC-E
@@ -524,11 +528,11 @@ At this time, the library utilized for detection of bacodes supports the followi
 You may check for updates on the [zbar library homepage](https://github.com/mchehab/zbar).
 For usage in Paperless, the type of barcode does not matter, only the contents of it.
 
-For how to enable barcode usage, see [the configuration](/configuration#barcodes).
+For how to enable barcode usage, see [the configuration](configuration.md#barcodes).
 The two settings may be enabled independently, but do have interactions as explained
 below.
 
-### Document Splitting
+### Document Splitting {#document-splitting}
 
 When enabled, Paperless will look for a barcode with the configured value and create a new document
 starting from the next page. The page with the barcode on it will _not_ be retained. It
@@ -543,3 +547,75 @@ If document splitting via barcode is also enabled, documents will be split when
 barcode is located. However, differing from the splitting, the page with the
 barcode _will_ be retained. This allows application of a barcode to any page, including
 one which holds data to keep in the document.
+
+## Automatic collation of double-sided documents {#collate}
+
+!!! note
+
+    If your scanner supports double-sided scanning natively, you do not need this feature.
+
+This feature is turned off by default, see [configuration](configuration.md#collate) on how to turn it on.
+
+### Summary
+
+If you have a scanner with an automatic document feeder (ADF) that only scans a single side,
+this feature makes scanning double-sided documents much more convenient by automatically
+collating two separate scans into one document, reordering the pages as necessary.
+
+### Usage example
+
+Suppose you have a double-sided document with 6 pages (3 sheets of paper). First,
+put the stack into your ADF as normal, ensuring that page 1 is scanned first. Your ADF
+will now scan pages 1, 3, and 5. Then you (or your the scanner, if it supports it) upload
+the scan into the correct sub-directory of the consume folder (`double-sided` by default;
+keep in mind that Paperless will _not_ automatically create the directory for you.)
+Paperless will then process the scan and move it into an internal staging area.
+
+The next step is to turn your stack upside down (without reordering the sheets of paper),
+and scan it once again, your ADF will now scan pages 6, 4, and 2, in that order. Once this
+scan is copied into the sub-directory, Paperless will collate the previous scan with the
+new one, reversing the order of the pages on the second, "even numbered" scan. The
+resulting document will have the pages 1-6 in the correct order, and this new file will
+then be processed as normal.
+
+!!! tip
+
+    When scanning the even numbered pages, you can omit the last empty pages, if there are
+    any. For example, if page 6 is empty, you only need to scan pages 2 and 4. _Do not_ omit
+    empty pages in the middle of the document.
+
+### Things that could go wrong
+
+Paperless will notice when the first, "odd numbered" scan has less pages than the second
+scan (this can happen when e.g. the ADF skipped a few pages in the first pass). In that
+case, Paperless will remove the staging copy as well as the scan, and give you an error
+message asking you to restart the process from scratch, by scanning the odd pages again,
+followed by the even pages.
+
+It's important that the scan files get consumed in the correct order, and one at a time.
+You therefore need to make sure that Paperless is running while you upload the files into
+the directory; and if you're using [polling](configuration.md#polling), make sure that
+`CONSUMER_POLLING` is set to a value lower than it takes for the second scan to appear,
+like 5-10 or even lower.
+
+Another thing that might happen is that you start a double sided scan, but then forget
+to upload the second file. To avoid collating the wrong documents if you then come back
+a day later to scan a new double-sided document, Paperless will only keep an "odd numbered
+pages" file for up to 30 minutes. If more time passes, it will consider the next incoming
+scan a completely new "odd numbered pages" one. The old staging file will get discarded.
+
+### Interaction with "subdirs as tags"
+
+The collation feature can be used together with the [subdirs as tags](configuration.md#consume_config)
+feature (but this is not a requirement). Just create a correctly named double-sided subdir
+in the hierachy and upload your scans there. For example, both `double-sided/foo/bar` as
+well as `foo/bar/double-sided` will cause the collated document to be treated as if it
+were uploaded into `foo/bar` and receive both `foo` and `bar` tags, but not `double-sided`.
+
+### Interaction with document splitting
+
+You can use the [document splitting](#document-splitting) feature, but if you use a normal
+single-sided split marker page, the split document(s) will have an empty page at the front (or
+whatever else was on the backside of the split marker page.) You can work around that by having
+a split marker page that has the split barcode on _both_ sides. This way, the extra page will
+get automatically removed.

docs/api.md

@@ -6,7 +6,7 @@ provides a browsable API for most of its endpoints, which you can
 inspect at `http://<paperless-host>:<port>/api/`. This also documents
 most of the available filters and ordering fields.
 
-The API provides 7 main endpoints:
+The API provides the following main endpoints:
 
 - `/api/documents/`: Full CRUD support, except POSTing new documents.
   See below.
@@ -19,6 +19,8 @@ The API provides 7 main endpoints:
 - `/api/mail_rules/`: Full CRUD support.
 - `/api/users/`: Full CRUD support.
 - `/api/groups/`: Full CRUD support.
+- `/api/share_links/`: Full CRUD support.
+- `/api/custom_fields/`: Full CRUD support.
 
 All of these endpoints except for the logging endpoint allow you to
 fetch (and edit and delete where appropriate) individual objects by
@@ -47,6 +49,11 @@ fields:
   Read-only.
 - `archived_file_name`: Verbose filename of the archived document.
   Read-only. Null if no archived document is available.
+- `notes`: Array of notes associated with the document.
+- `set_permissions`: Allows setting document permissions. Optional,
+  write-only. See [below](#permissions).
+- `custom_fields`: Array of custom fields & values, specified as
+  { field: CUSTOM_FIELD_ID, value: VALUE }
 
 ## Downloading documents
 
@@ -122,6 +129,11 @@ File metadata is reported as a list of objects in the following form:
 depends on the file type and the metadata available in that specific
 document. Paperless only reports PDF metadata at this point.
 
+## Documents additional endpoints
+
+- `/api/documents/<id>/notes/`: Retrieve notes for a document.
+- `/api/documents/<id>/share_links/`: Retrieve share links for a document.
+
 ## Authorization
 
 The REST api provides three different forms of authentication.
@@ -165,7 +177,7 @@ specific query parameters cause the API to return full text search
 results:
 
 - `/api/documents/?query=your%20search%20query`: Search for a document
-  using a full text query. For details on the syntax, see [Basic Usage - Searching](/usage#basic-usage_searching).
+  using a full text query. For details on the syntax, see [Basic Usage - Searching](usage.md#basic-usage_searching).
 - `/api/documents/?more_like=1234`: Search for documents similar to
   the document with id 1234.
 
@@ -267,6 +279,43 @@ However, querying the tasks endpoint with the returned UUID e.g.
 `/api/tasks/?task_id={uuid}` will provide information on the state of the
 consumption including the ID of a created document if consumption succeeded.
 
+## Permissions
+
+All objects (documents, tags, etc.) allow setting object-level permissions
+with optional `owner` and / or a `set_permissions` parameters which are of
+the form:
+
+```
+"owner": ...,
+"set_permissions": {
+    "view": {
+        "users": [...],
+        "groups": [...],
+    },
+    "change": {
+        "users": [...],
+        "groups": [...],
+    },
+}
+```
+
+!!! note
+
+    Arrays should contain user or group ID numbers.
+
+If these parameters are supplied the object's permissions will be overwritten,
+assuming the authenticated user has permission to do so (the user must be
+the object owner or a superuser).
+
+### Retrieving full permissions
+
+By default, the API will return a truncated version of object-level
+permissions, returning `user_can_change` indicating whether the current user
+can edit the object (either because they are the object owner or have permissions
+granted). You can pass the parameter `full_perms=true` to API calls to view the
+full permissions of objects in a format that mirrors the `set_permissions`
+parameter above.
+
 ## API Versioning
 
 The REST API is versioned since Paperless-ngx 1.3.0.

docs/assets/extra.css

@@ -20,6 +20,28 @@
         margin-left: 4%;
         float: left;
     }
+
+    .grid-flipped-left {
+        width: 66%;
+        float: left;
+    }
+
+    .grid-flipped-right {
+        width: 29%;
+        margin-left: 4%;
+        float: left;
+    }
+
+    .grid-half-left {
+        width: 48%;
+        float: left;
+    }
+
+    .grid-half-right {
+        width: 48%;
+        margin-left: 4%;
+        float: left;
+    }
 }
 
 .grid-left > p {
@@ -31,6 +53,48 @@
     margin: 0;
 }
 
+.clear {
+    clear: both;
+    margin-bottom: 20px;
+    display: block;
+}
+
 .index-callout {
     margin-right: .5rem;
 }
+
+/* make code in headers not bold */
+h4 code {
+    font-weight: normal;
+}
+
+/* Hide config vars from sidebar, toc and move the border on mobile case their hidden */
+.md-nav.md-nav--secondary .md-nav__item .md-nav__link[href*="PAPERLESS_"],
+.md-nav.md-nav--secondary .md-nav__item .md-nav__link[href*="USERMAP_"] {
+    display: none;
+}
+
+@media screen and (max-width: 76.1875em) {
+    .md-nav--primary .md-nav__item {
+        border-top: none;
+    }
+
+    .md-nav--primary .md-nav__link {
+        border-top: .05rem solid var(--md-default-fg-color--lightest);
+    }
+}
+
+/* Show search shortcut key */
+[data-md-toggle="search"]:not(:checked) ~ .md-header .md-search__form::after {
+    position: absolute;
+    top: .3rem;
+    right: .3rem;
+    display: block;
+    padding: .1rem .4rem;
+    color: var(--md-default-fg-color--lighter);
+    font-weight: bold;
+    font-size: .8rem;
+    border: .05rem solid var(--md-default-fg-color--lighter);
+    border-radius: .1rem;
+    content: "/";
+  }

docs/changelog.md

@@ -1,5 +1,480 @@
 # Changelog
 
+## paperless-ngx 1.17.4
+
+### Bug Fixes
+
+- Fix: ghostscript rendering error doesnt trigger frontend failure message [@shamoon](https://github.com/shamoon) ([#4092](https://github.com/paperless-ngx/paperless-ngx/pull/4092))
+
+### All App Changes
+
+- Fix: ghostscript rendering error doesnt trigger frontend failure message [@shamoon](https://github.com/shamoon) ([#4092](https://github.com/paperless-ngx/paperless-ngx/pull/4092))
+
+## paperless-ngx 1.17.3
+
+### Bug Fixes
+
+- Fix: When PDF/A rendering fails, add a consideration for the user to add args to override [@stumpylog](https://github.com/stumpylog) ([#4083](https://github.com/paperless-ngx/paperless-ngx/pull/4083))
+
+### Dependencies
+
+- Chore: update frontend PDF viewer (including pdf-js) [@shamoon](https://github.com/shamoon) ([#4065](https://github.com/paperless-ngx/paperless-ngx/pull/4065))
+
+### Maintenance
+
+- Dev: Upload code coverage in the same job [@stumpylog](https://github.com/stumpylog) ([#4084](https://github.com/paperless-ngx/paperless-ngx/pull/4084))
+
+### All App Changes
+
+<details>
+<summary>3 changes</summary>
+
+- Fix: When PDF/A rendering fails, add a consideration for the user to add args to override [@stumpylog](https://github.com/stumpylog) ([#4083](https://github.com/paperless-ngx/paperless-ngx/pull/4083))
+- Chore: update frontend PDF viewer (including pdf-js) [@shamoon](https://github.com/shamoon) ([#4065](https://github.com/paperless-ngx/paperless-ngx/pull/4065))
+- Chore: Prepare for Python 3.11 support [@stumpylog](https://github.com/stumpylog) ([#4066](https://github.com/paperless-ngx/paperless-ngx/pull/4066))
+</details>
+
+## paperless-ngx 1.17.2
+
+### Features
+
+- Enhancement: Allow to set a prefix for keys and channels in redis [@amo13](https://github.com/amo13) ([#3993](https://github.com/paperless-ngx/paperless-ngx/pull/3993))
+
+### Bug Fixes
+
+- Fix: Increase the HTTP timeouts for Tika/Gotenberg to maximum task time [@stumpylog](https://github.com/stumpylog) ([#4061](https://github.com/paperless-ngx/paperless-ngx/pull/4061))
+- Fix: Allow adding an SSL certificate for IMAP SSL context [@stumpylog](https://github.com/stumpylog) ([#4048](https://github.com/paperless-ngx/paperless-ngx/pull/4048))
+- Fix: tag creation sometimes retained search text [@shamoon](https://github.com/shamoon) ([#4038](https://github.com/paperless-ngx/paperless-ngx/pull/4038))
+- Fix: enforce permissions on bulk_edit operations [@shamoon](https://github.com/shamoon) ([#4007](https://github.com/paperless-ngx/paperless-ngx/pull/4007))
+
+### All App Changes
+
+<details>
+<summary>6 changes</summary>
+
+- Fix: Increase the HTTP timeouts for Tika/Gotenberg to maximum task time [@stumpylog](https://github.com/stumpylog) ([#4061](https://github.com/paperless-ngx/paperless-ngx/pull/4061))
+- Enhancement: disable / hide some UI buttons / elements if insufficient permissions, show errors [@shamoon](https://github.com/shamoon) ([#4014](https://github.com/paperless-ngx/paperless-ngx/pull/4014))
+- Fix: Allow adding an SSL certificate for IMAP SSL context [@stumpylog](https://github.com/stumpylog) ([#4048](https://github.com/paperless-ngx/paperless-ngx/pull/4048))
+- Fix: tag creation sometimes retained search text [@shamoon](https://github.com/shamoon) ([#4038](https://github.com/paperless-ngx/paperless-ngx/pull/4038))
+- Fix: enforce permissions on bulk_edit operations [@shamoon](https://github.com/shamoon) ([#4007](https://github.com/paperless-ngx/paperless-ngx/pull/4007))
+- Enhancement: Allow to set a prefix for keys and channels in redis [@amo13](https://github.com/amo13) ([#3993](https://github.com/paperless-ngx/paperless-ngx/pull/3993))
+</details>
+
+## paperless-ngx 1.17.1
+
+### Features
+
+- Fix / Enhancement: restrict status messages by owner if set \& improve 404 page [@shamoon](https://github.com/shamoon) ([#3959](https://github.com/paperless-ngx/paperless-ngx/pull/3959))
+- Feature: Add Ukrainian translation [@shamoon](https://github.com/shamoon) ([#3941](https://github.com/paperless-ngx/paperless-ngx/pull/3941))
+
+### Bug Fixes
+
+- Fix: handle ASN = 0 on frontend cards [@shamoon](https://github.com/shamoon) ([#3988](https://github.com/paperless-ngx/paperless-ngx/pull/3988))
+- Fix: improve light color filled primary button text legibility [@shamoon](https://github.com/shamoon) ([#3980](https://github.com/paperless-ngx/paperless-ngx/pull/3980))
+- Fix / Enhancement: restrict status messages by owner if set \& improve 404 page [@shamoon](https://github.com/shamoon) ([#3959](https://github.com/paperless-ngx/paperless-ngx/pull/3959))
+- Fix: handle very old date strings in correspondent list [@shamoon](https://github.com/shamoon) ([#3953](https://github.com/paperless-ngx/paperless-ngx/pull/3953))
+
+### Documentation
+
+- docs(bare-metal): add new dependency [@bin101](https://github.com/bin101) ([#3931](https://github.com/paperless-ngx/paperless-ngx/pull/3931))
+
+### Dependencies
+
+- Chore: Loosen Pipfile restriction on some packages and update them [@stumpylog](https://github.com/stumpylog) ([#3972](https://github.com/paperless-ngx/paperless-ngx/pull/3972))
+
+### All App Changes
+
+<details>
+<summary>6 changes</summary>
+
+- Fix: handle ASN = 0 on frontend cards [@shamoon](https://github.com/shamoon) ([#3988](https://github.com/paperless-ngx/paperless-ngx/pull/3988))
+- Fix: improve light color filled primary button text legibility [@shamoon](https://github.com/shamoon) ([#3980](https://github.com/paperless-ngx/paperless-ngx/pull/3980))
+- Fix / Enhancement: restrict status messages by owner if set \& improve 404 page [@shamoon](https://github.com/shamoon) ([#3959](https://github.com/paperless-ngx/paperless-ngx/pull/3959))
+- Fix: handle very old date strings in correspondent list [@shamoon](https://github.com/shamoon) ([#3953](https://github.com/paperless-ngx/paperless-ngx/pull/3953))
+- Chore: Reduces the 2 mail tests flakiness [@stumpylog](https://github.com/stumpylog) ([#3949](https://github.com/paperless-ngx/paperless-ngx/pull/3949))
+- Feature: Add Ukrainian translation [@shamoon](https://github.com/shamoon) ([#3941](https://github.com/paperless-ngx/paperless-ngx/pull/3941))
+</details>
+
+## paperless-ngx 1.17.0
+
+### Features
+
+- Add support for additional UK date formats [@brainrecursion](https://github.com/brainrecursion) ([#3887](https://github.com/paperless-ngx/paperless-ngx/pull/3887))
+- Add 'doc_pk' to PAPERLESS_FILENAME_FORMAT handling [@mechanarchy](https://github.com/mechanarchy) ([#3861](https://github.com/paperless-ngx/paperless-ngx/pull/3861))
+- Feature: hover buttons for saved view widgets [@shamoon](https://github.com/shamoon) ([#3875](https://github.com/paperless-ngx/paperless-ngx/pull/3875))
+- Feature: collate two single-sided multipage scans [@brakhane](https://github.com/brakhane) ([#3784](https://github.com/paperless-ngx/paperless-ngx/pull/3784))
+- Feature: include global and object-level permissions in export / import [@shamoon](https://github.com/shamoon) ([#3672](https://github.com/paperless-ngx/paperless-ngx/pull/3672))
+- Enhancement / Fix: Migrate encrypted png thumbnails to webp [@shamoon](https://github.com/shamoon) ([#3719](https://github.com/paperless-ngx/paperless-ngx/pull/3719))
+- Feature: Add Slovak translation [@shamoon](https://github.com/shamoon) ([#3722](https://github.com/paperless-ngx/paperless-ngx/pull/3722))
+
+### Bug Fixes
+
+- Fix: cancel possibly slow queries on doc details [@shamoon](https://github.com/shamoon) ([#3925](https://github.com/paperless-ngx/paperless-ngx/pull/3925))
+- Fix: note creation / deletion should respect doc permissions [@shamoon](https://github.com/shamoon) ([#3903](https://github.com/paperless-ngx/paperless-ngx/pull/3903))
+- Fix: notes show persistent scrollbars [@shamoon](https://github.com/shamoon) ([#3904](https://github.com/paperless-ngx/paperless-ngx/pull/3904))
+- Fix: Provide SSL context to IMAP client [@stumpylog](https://github.com/stumpylog) ([#3886](https://github.com/paperless-ngx/paperless-ngx/pull/3886))
+- Fix/enhancement: permissions for mail rules \& accounts [@shamoon](https://github.com/shamoon) ([#3869](https://github.com/paperless-ngx/paperless-ngx/pull/3869))
+- Fix: Classifier special case when no items are set to automatic matching [@stumpylog](https://github.com/stumpylog) ([#3858](https://github.com/paperless-ngx/paperless-ngx/pull/3858))
+- Fix: issues with copy2 or copystat and SELinux permissions [@stumpylog](https://github.com/stumpylog) ([#3847](https://github.com/paperless-ngx/paperless-ngx/pull/3847))
+- Fix: Parsing office document timestamps [@stumpylog](https://github.com/stumpylog) ([#3836](https://github.com/paperless-ngx/paperless-ngx/pull/3836))
+- Fix: Add warning to install script need for permissions [@shamoon](https://github.com/shamoon) ([#3835](https://github.com/paperless-ngx/paperless-ngx/pull/3835))
+- Fix interaction between API and barcode archive serial number [@stumpylog](https://github.com/stumpylog) ([#3834](https://github.com/paperless-ngx/paperless-ngx/pull/3834))
+- Enhancement / Fix: Migrate encrypted png thumbnails to webp [@shamoon](https://github.com/shamoon) ([#3719](https://github.com/paperless-ngx/paperless-ngx/pull/3719))
+- Fix: add UI tour step padding [@hakimio](https://github.com/hakimio) ([#3791](https://github.com/paperless-ngx/paperless-ngx/pull/3791))
+- Fix: translate file tasks types in footer [@shamoon](https://github.com/shamoon) ([#3749](https://github.com/paperless-ngx/paperless-ngx/pull/3749))
+- Fix: limit ng-select size for addition of filter button [@shamoon](https://github.com/shamoon) ([#3731](https://github.com/paperless-ngx/paperless-ngx/pull/3731))
+
+### Documentation
+
+- Documentation: improvements to grammar, spelling, indentation [@mechanarchy](https://github.com/mechanarchy) ([#3844](https://github.com/paperless-ngx/paperless-ngx/pull/3844))
+
+### Maintenance
+
+- Bump stumpylog/image-cleaner-action from 0.1.0 to 0.2.0 [@dependabot](https://github.com/dependabot) ([#3910](https://github.com/paperless-ngx/paperless-ngx/pull/3910))
+- Chore: group frontend angular dependabot updates [@shamoon](https://github.com/shamoon) ([#3750](https://github.com/paperless-ngx/paperless-ngx/pull/3750))
+
+### Dependencies
+
+<details>
+<summary>17 changes</summary>
+
+- Chore: Bump the frontend-angular-dependencies group in /src-ui with 11 updates [@shamoon](https://github.com/shamoon) ([#3918](https://github.com/paperless-ngx/paperless-ngx/pull/3918))
+- Bump stumpylog/image-cleaner-action from 0.1.0 to 0.2.0 [@dependabot](https://github.com/dependabot) ([#3910](https://github.com/paperless-ngx/paperless-ngx/pull/3910))
+- Bump the frontend-eslint-dependencies group in /src-ui with 3 updates [@dependabot](https://github.com/dependabot) ([#3911](https://github.com/paperless-ngx/paperless-ngx/pull/3911))
+- Bump tslib from 2.6.0 to 2.6.1 in /src-ui [@dependabot](https://github.com/dependabot) ([#3909](https://github.com/paperless-ngx/paperless-ngx/pull/3909))
+- Bump jest-environment-jsdom from 29.5.0 to 29.6.2 in /src-ui [@dependabot](https://github.com/dependabot) ([#3916](https://github.com/paperless-ngx/paperless-ngx/pull/3916))
+- Bump [@<!---->types/node from 20.3.3 to 20.4.5 in /src-ui @dependabot](https://github.com/<!---->types/node from 20.3.3 to 20.4.5 in /src-ui @dependabot) ([#3915](https://github.com/paperless-ngx/paperless-ngx/pull/3915))
+- Bump bootstrap from 5.3.0 to 5.3.1 in /src-ui [@dependabot](https://github.com/dependabot) ([#3914](https://github.com/paperless-ngx/paperless-ngx/pull/3914))
+- Bump [@<!---->playwright/test from 1.36.1 to 1.36.2 in /src-ui @dependabot](https://github.com/<!---->playwright/test from 1.36.1 to 1.36.2 in /src-ui @dependabot) ([#3912](https://github.com/paperless-ngx/paperless-ngx/pull/3912))
+- Bump the frontend-jest-dependencies group in /src-ui with 1 update [@dependabot](https://github.com/dependabot) ([#3906](https://github.com/paperless-ngx/paperless-ngx/pull/3906))
+- Chore: Update dependencies [@stumpylog](https://github.com/stumpylog) ([#3883](https://github.com/paperless-ngx/paperless-ngx/pull/3883))
+- Chore: Update Python dependencies [@stumpylog](https://github.com/stumpylog) ([#3842](https://github.com/paperless-ngx/paperless-ngx/pull/3842))
+- Bump the frontend-angular-dependencies group in /src-ui with 16 updates [@dependabot](https://github.com/dependabot) ([#3826](https://github.com/paperless-ngx/paperless-ngx/pull/3826))
+- Bump [@<!---->typescript-eslint/eslint-plugin from 5.60.1 to 6.1.0 in /src-ui @dependabot](https://github.com/<!---->typescript-eslint/eslint-plugin from 5.60.1 to 6.1.0 in /src-ui @dependabot) ([#3829](https://github.com/paperless-ngx/paperless-ngx/pull/3829))
+- Bump jest and [@<!---->types/jest in /src-ui @dependabot](https://github.com/<!---->types/jest in /src-ui @dependabot) ([#3828](https://github.com/paperless-ngx/paperless-ngx/pull/3828))
+- Bump [@<!---->playwright/test from 1.36.0 to 1.36.1 in /src-ui @dependabot](https://github.com/<!---->playwright/test from 1.36.0 to 1.36.1 in /src-ui @dependabot) ([#3827](https://github.com/paperless-ngx/paperless-ngx/pull/3827))
+- Bump semver from 5.7.1 to 5.7.2 in /src-ui [@dependabot](https://github.com/dependabot) ([#3793](https://github.com/paperless-ngx/paperless-ngx/pull/3793))
+- Chore: Bump Angular to v16 and other frontend packages [@dependabot](https://github.com/dependabot) ([#3727](https://github.com/paperless-ngx/paperless-ngx/pull/3727))
+</details>
+
+### All App Changes
+
+<details>
+<summary>35 changes</summary>
+
+- Fix: cancel possibly slow queries on doc details [@shamoon](https://github.com/shamoon) ([#3925](https://github.com/paperless-ngx/paperless-ngx/pull/3925))
+- [BUG] Set office document creation date with timezone, if it is naive [@a17t](https://github.com/a17t) ([#3760](https://github.com/paperless-ngx/paperless-ngx/pull/3760))
+- Fix: note creation / deletion should respect doc permissions [@shamoon](https://github.com/shamoon) ([#3903](https://github.com/paperless-ngx/paperless-ngx/pull/3903))
+- Chore: Bump the frontend-angular-dependencies group in /src-ui with 11 updates [@shamoon](https://github.com/shamoon) ([#3918](https://github.com/paperless-ngx/paperless-ngx/pull/3918))
+- Bump the frontend-eslint-dependencies group in /src-ui with 3 updates [@dependabot](https://github.com/dependabot) ([#3911](https://github.com/paperless-ngx/paperless-ngx/pull/3911))
+- Bump tslib from 2.6.0 to 2.6.1 in /src-ui [@dependabot](https://github.com/dependabot) ([#3909](https://github.com/paperless-ngx/paperless-ngx/pull/3909))
+- Bump jest-environment-jsdom from 29.5.0 to 29.6.2 in /src-ui [@dependabot](https://github.com/dependabot) ([#3916](https://github.com/paperless-ngx/paperless-ngx/pull/3916))
+- Bump [@<!---->types/node from 20.3.3 to 20.4.5 in /src-ui @dependabot](https://github.com/<!---->types/node from 20.3.3 to 20.4.5 in /src-ui @dependabot) ([#3915](https://github.com/paperless-ngx/paperless-ngx/pull/3915))
+- Bump bootstrap from 5.3.0 to 5.3.1 in /src-ui [@dependabot](https://github.com/dependabot) ([#3914](https://github.com/paperless-ngx/paperless-ngx/pull/3914))
+- Bump [@<!---->playwright/test from 1.36.1 to 1.36.2 in /src-ui @dependabot](https://github.com/<!---->playwright/test from 1.36.1 to 1.36.2 in /src-ui @dependabot) ([#3912](https://github.com/paperless-ngx/paperless-ngx/pull/3912))
+- Bump the frontend-jest-dependencies group in /src-ui with 1 update [@dependabot](https://github.com/dependabot) ([#3906](https://github.com/paperless-ngx/paperless-ngx/pull/3906))
+- Fix: notes show persistent scrollbars [@shamoon](https://github.com/shamoon) ([#3904](https://github.com/paperless-ngx/paperless-ngx/pull/3904))
+- Add support for additional UK date formats [@brainrecursion](https://github.com/brainrecursion) ([#3887](https://github.com/paperless-ngx/paperless-ngx/pull/3887))
+- Add 'doc_pk' to PAPERLESS_FILENAME_FORMAT handling [@mechanarchy](https://github.com/mechanarchy) ([#3861](https://github.com/paperless-ngx/paperless-ngx/pull/3861))
+- Fix: Provide SSL context to IMAP client [@stumpylog](https://github.com/stumpylog) ([#3886](https://github.com/paperless-ngx/paperless-ngx/pull/3886))
+- Feature: hover buttons for saved view widgets [@shamoon](https://github.com/shamoon) ([#3875](https://github.com/paperless-ngx/paperless-ngx/pull/3875))
+- Fix/enhancement: permissions for mail rules \& accounts [@shamoon](https://github.com/shamoon) ([#3869](https://github.com/paperless-ngx/paperless-ngx/pull/3869))
+- Chore: typing improvements [@stumpylog](https://github.com/stumpylog) ([#3860](https://github.com/paperless-ngx/paperless-ngx/pull/3860))
+- Fix: Classifier special case when no items are set to automatic matching [@stumpylog](https://github.com/stumpylog) ([#3858](https://github.com/paperless-ngx/paperless-ngx/pull/3858))
+- Fix: issues with copy2 or copystat and SELinux permissions [@stumpylog](https://github.com/stumpylog) ([#3847](https://github.com/paperless-ngx/paperless-ngx/pull/3847))
+- Chore: Update Python dependencies [@stumpylog](https://github.com/stumpylog) ([#3842](https://github.com/paperless-ngx/paperless-ngx/pull/3842))
+- Feature: include global and object-level permissions in export / import [@shamoon](https://github.com/shamoon) ([#3672](https://github.com/paperless-ngx/paperless-ngx/pull/3672))
+- Fix: Parsing office document timestamps [@stumpylog](https://github.com/stumpylog) ([#3836](https://github.com/paperless-ngx/paperless-ngx/pull/3836))
+- Fix interaction between API and barcode archive serial number [@stumpylog](https://github.com/stumpylog) ([#3834](https://github.com/paperless-ngx/paperless-ngx/pull/3834))
+- Bump the frontend-angular-dependencies group in /src-ui with 16 updates [@dependabot](https://github.com/dependabot) ([#3826](https://github.com/paperless-ngx/paperless-ngx/pull/3826))
+- Enhancement / Fix: Migrate encrypted png thumbnails to webp [@shamoon](https://github.com/shamoon) ([#3719](https://github.com/paperless-ngx/paperless-ngx/pull/3719))
+- Bump [@<!---->typescript-eslint/eslint-plugin from 5.60.1 to 6.1.0 in /src-ui @dependabot](https://github.com/<!---->typescript-eslint/eslint-plugin from 5.60.1 to 6.1.0 in /src-ui @dependabot) ([#3829](https://github.com/paperless-ngx/paperless-ngx/pull/3829))
+- Bump jest and [@<!---->types/jest in /src-ui @dependabot](https://github.com/<!---->types/jest in /src-ui @dependabot) ([#3828](https://github.com/paperless-ngx/paperless-ngx/pull/3828))
+- Bump [@<!---->playwright/test from 1.36.0 to 1.36.1 in /src-ui @dependabot](https://github.com/<!---->playwright/test from 1.36.0 to 1.36.1 in /src-ui @dependabot) ([#3827](https://github.com/paperless-ngx/paperless-ngx/pull/3827))
+- Bump semver from 5.7.1 to 5.7.2 in /src-ui [@dependabot](https://github.com/dependabot) ([#3793](https://github.com/paperless-ngx/paperless-ngx/pull/3793))
+- Fix: add UI tour step padding [@hakimio](https://github.com/hakimio) ([#3791](https://github.com/paperless-ngx/paperless-ngx/pull/3791))
+- Fix: translate file tasks types in footer [@shamoon](https://github.com/shamoon) ([#3749](https://github.com/paperless-ngx/paperless-ngx/pull/3749))
+- Feature: Add Slovak translation [@shamoon](https://github.com/shamoon) ([#3722](https://github.com/paperless-ngx/paperless-ngx/pull/3722))
+- Fix: limit ng-select size for addition of filter button [@shamoon](https://github.com/shamoon) ([#3731](https://github.com/paperless-ngx/paperless-ngx/pull/3731))
+- Chore: Bump Angular to v16 and other frontend packages [@dependabot](https://github.com/dependabot) ([#3727](https://github.com/paperless-ngx/paperless-ngx/pull/3727))
+</details>
+
+## paperless-ngx 1.16.5
+
+### Features
+
+- Feature: support barcode upscaling for better detection of small barcodes [@bmachek](https://github.com/bmachek) ([#3655](https://github.com/paperless-ngx/paperless-ngx/pull/3655))
+
+### Bug Fixes
+
+- Fix: owner removed when set_permissions passed on object create [@shamoon](https://github.com/shamoon) ([#3702](https://github.com/paperless-ngx/paperless-ngx/pull/3702))
+
+### All App Changes
+
+<details>
+<summary>2 changes</summary>
+
+- Feature: support barcode upscaling for better detection of small barcodes [@bmachek](https://github.com/bmachek) ([#3655](https://github.com/paperless-ngx/paperless-ngx/pull/3655))
+- Fix: owner removed when set_permissions passed on object create [@shamoon](https://github.com/shamoon) ([#3702](https://github.com/paperless-ngx/paperless-ngx/pull/3702))
+</details>
+
+## paperless-ngx 1.16.4
+
+### Bug Fixes
+
+- Fix: prevent button wrapping when sidebar narrows in MS Edge [@shamoon](https://github.com/shamoon) ([#3682](https://github.com/paperless-ngx/paperless-ngx/pull/3682))
+- Fix: Handling for filenames with non-ascii and no content attribute [@stumpylog](https://github.com/stumpylog) ([#3695](https://github.com/paperless-ngx/paperless-ngx/pull/3695))
+- Fix: Generation of thumbnails for existing stored emails [@stumpylog](https://github.com/stumpylog) ([#3696](https://github.com/paperless-ngx/paperless-ngx/pull/3696))
+- Fix: Use row gap for filter editor [@kleinweby](https://github.com/kleinweby) ([#3662](https://github.com/paperless-ngx/paperless-ngx/pull/3662))
+
+### Documentation
+
+- Documentation: update API docs re permissions [@shamoon](https://github.com/shamoon) ([#3697](https://github.com/paperless-ngx/paperless-ngx/pull/3697))
+
+### Maintenance
+
+- Chore: Updates codecov configuration for the flag settings and notification delay [@stumpylog](https://github.com/stumpylog) ([#3656](https://github.com/paperless-ngx/paperless-ngx/pull/3656))
+
+### All App Changes
+
+<details>
+<summary>4 changes</summary>
+
+- Fix: prevent button wrapping when sidebar narrows in MS Edge [@shamoon](https://github.com/shamoon) ([#3682](https://github.com/paperless-ngx/paperless-ngx/pull/3682))
+- Fix: Handling for filenames with non-ascii and no content attribute [@stumpylog](https://github.com/stumpylog) ([#3695](https://github.com/paperless-ngx/paperless-ngx/pull/3695))
+- Fix: Generation of thumbnails for existing stored emails [@stumpylog](https://github.com/stumpylog) ([#3696](https://github.com/paperless-ngx/paperless-ngx/pull/3696))
+- Fix: Use row gap for filter editor [@kleinweby](https://github.com/kleinweby) ([#3662](https://github.com/paperless-ngx/paperless-ngx/pull/3662))
+</details>
+
+## paperless-ngx 1.16.3
+
+### Bug Fixes
+
+- Fix: Set user and home environment through supervisord [@stumpylog](https://github.com/stumpylog) ([#3638](https://github.com/paperless-ngx/paperless-ngx/pull/3638))
+- Fix: Ignore errors when trying to copy the original file's stats [@stumpylog](https://github.com/stumpylog) ([#3652](https://github.com/paperless-ngx/paperless-ngx/pull/3652))
+- Fix: Copy default thumbnail if thumbnail generation fails [@plu](https://github.com/plu) ([#3632](https://github.com/paperless-ngx/paperless-ngx/pull/3632))
+- Fix: Set user and home environment through supervisord [@stumpylog](https://github.com/stumpylog) ([#3638](https://github.com/paperless-ngx/paperless-ngx/pull/3638))
+- Fix: Fix quick install with external database not being fully ready [@stumpylog](https://github.com/stumpylog) ([#3637](https://github.com/paperless-ngx/paperless-ngx/pull/3637))
+
+### Maintenance
+
+- Chore: Update default Postgres version for new installs [@stumpylog](https://github.com/stumpylog) ([#3640](https://github.com/paperless-ngx/paperless-ngx/pull/3640))
+
+### All App Changes
+
+<details>
+<summary>2 changes</summary>
+
+- Fix: Ignore errors when trying to copy the original file's stats [@stumpylog](https://github.com/stumpylog) ([#3652](https://github.com/paperless-ngx/paperless-ngx/pull/3652))
+- Fix: Copy default thumbnail if thumbnail generation fails [@plu](https://github.com/plu) ([#3632](https://github.com/paperless-ngx/paperless-ngx/pull/3632))
+</details>
+
+## paperless-ngx 1.16.2
+
+### Bug Fixes
+
+- Fix: Increase httpx operation timeouts to 30s [@stumpylog](https://github.com/stumpylog) ([#3627](https://github.com/paperless-ngx/paperless-ngx/pull/3627))
+- Fix: Better error handling and checking when parsing documents via Tika [@stumpylog](https://github.com/stumpylog) ([#3617](https://github.com/paperless-ngx/paperless-ngx/pull/3617))
+
+### Development
+
+- Development: frontend unit testing [@shamoon](https://github.com/shamoon) ([#3597](https://github.com/paperless-ngx/paperless-ngx/pull/3597))
+
+### Maintenance
+
+- Chore: Bumps the CI/Docker pipenv version [@stumpylog](https://github.com/stumpylog) ([#3622](https://github.com/paperless-ngx/paperless-ngx/pull/3622))
+- Chore: Set CI artifact retention days [@stumpylog](https://github.com/stumpylog) ([#3621](https://github.com/paperless-ngx/paperless-ngx/pull/3621))
+
+### All App Changes
+
+<details>
+<summary>3 changes</summary>
+
+- Fix: Increase httpx operation timeouts to 30s [@stumpylog](https://github.com/stumpylog) ([#3627](https://github.com/paperless-ngx/paperless-ngx/pull/3627))
+- Fix: Better error handling and checking when parsing documents via Tika [@stumpylog](https://github.com/stumpylog) ([#3617](https://github.com/paperless-ngx/paperless-ngx/pull/3617))
+- Development: frontend unit testing [@shamoon](https://github.com/shamoon) ([#3597](https://github.com/paperless-ngx/paperless-ngx/pull/3597))
+</details>
+
+## paperless-ngx 1.16.1
+
+### Bug Fixes
+
+- Fix: PIL ImportError on ARM devices with Docker [@stumpylog](https://github.com/stumpylog) ([#3605](https://github.com/paperless-ngx/paperless-ngx/pull/3605))
+
+### Maintenance
+
+- Chore: Enable the image cleanup action [@stumpylog](https://github.com/stumpylog) ([#3606](https://github.com/paperless-ngx/paperless-ngx/pull/3606))
+
+## paperless-ngx 1.16.0
+
+### Notable Changes
+
+- Chore: Update base image to Debian bookworm [@stumpylog](https://github.com/stumpylog) ([#3469](https://github.com/paperless-ngx/paperless-ngx/pull/3469))
+
+### Features
+
+- Feature: Update to a simpler Tika library [@stumpylog](https://github.com/stumpylog) ([#3517](https://github.com/paperless-ngx/paperless-ngx/pull/3517))
+- Feature: Allow to filter documents by original filename and checksum [@jayme-github](https://github.com/jayme-github) ([#3485](https://github.com/paperless-ngx/paperless-ngx/pull/3485))
+
+### Bug Fixes
+
+- Fix: return user first / last name from backend [@shamoon](https://github.com/shamoon) ([#3579](https://github.com/paperless-ngx/paperless-ngx/pull/3579))
+- Fix use of `PAPERLESS_DB_TIMEOUT` for all db types [@shamoon](https://github.com/shamoon) ([#3576](https://github.com/paperless-ngx/paperless-ngx/pull/3576))
+- Fix: handle mail rules with no filters on some imap servers [@shamoon](https://github.com/shamoon) ([#3554](https://github.com/paperless-ngx/paperless-ngx/pull/3554))
+
+### Dependencies
+
+- Chore: Python dependency updates (celery 5.3.0 in particular) [@stumpylog](https://github.com/stumpylog) ([#3584](https://github.com/paperless-ngx/paperless-ngx/pull/3584))
+
+### All App Changes
+
+<details>
+<summary>8 changes</summary>
+
+- Chore: Python dependency updates (celery 5.3.0 in particular) [@stumpylog](https://github.com/stumpylog) ([#3584](https://github.com/paperless-ngx/paperless-ngx/pull/3584))
+- Fix: return user first / last name from backend [@shamoon](https://github.com/shamoon) ([#3579](https://github.com/paperless-ngx/paperless-ngx/pull/3579))
+- Fix use of `PAPERLESS_DB_TIMEOUT` for all db types [@shamoon](https://github.com/shamoon) ([#3576](https://github.com/paperless-ngx/paperless-ngx/pull/3576))
+- Fix: handle mail rules with no filters on some imap servers [@shamoon](https://github.com/shamoon) ([#3554](https://github.com/paperless-ngx/paperless-ngx/pull/3554))
+- Chore: Copy file stats from original file [@stumpylog](https://github.com/stumpylog) ([#3551](https://github.com/paperless-ngx/paperless-ngx/pull/3551))
+- Chore: Adds test for barcode ASN when it already exists [@stumpylog](https://github.com/stumpylog) ([#3550](https://github.com/paperless-ngx/paperless-ngx/pull/3550))
+- Feature: Update to a simpler Tika library [@stumpylog](https://github.com/stumpylog) ([#3517](https://github.com/paperless-ngx/paperless-ngx/pull/3517))
+- Feature: Allow to filter documents by original filename and checksum [@jayme-github](https://github.com/jayme-github) ([#3485](https://github.com/paperless-ngx/paperless-ngx/pull/3485))
+</details>
+
+## paperless-ngx 1.15.1
+
+### Bug Fixes
+
+- Fix incorrect colors in v1.15.0 [@shamoon](https://github.com/shamoon) ([#3523](https://github.com/paperless-ngx/paperless-ngx/pull/3523))
+
+### All App Changes
+
+- Fix incorrect colors in v1.15.0 [@shamoon](https://github.com/shamoon) ([#3523](https://github.com/paperless-ngx/paperless-ngx/pull/3523))
+
+## paperless-ngx 1.15.0
+
+### Features
+
+- Feature: quick filters from document detail [@shamoon](https://github.com/shamoon) ([#3476](https://github.com/paperless-ngx/paperless-ngx/pull/3476))
+- Feature: Add explanations to relative dates [@shamoon](https://github.com/shamoon) ([#3471](https://github.com/paperless-ngx/paperless-ngx/pull/3471))
+- Enhancement: paginate frontend tasks [@shamoon](https://github.com/shamoon) ([#3445](https://github.com/paperless-ngx/paperless-ngx/pull/3445))
+- Feature: Better encapsulation of barcode logic [@stumpylog](https://github.com/stumpylog) ([#3425](https://github.com/paperless-ngx/paperless-ngx/pull/3425))
+- Enhancement: Improve frontend error handling [@shamoon](https://github.com/shamoon) ([#3413](https://github.com/paperless-ngx/paperless-ngx/pull/3413))
+
+### Bug Fixes
+
+- Fix: KeyError error on unauthenticated API calls \& persist authentication when enabled [@ajgon](https://github.com/ajgon) ([#3516](https://github.com/paperless-ngx/paperless-ngx/pull/3516))
+- Fix: exclude consumer \& AnonymousUser users from export manifest [@shamoon](https://github.com/shamoon) ([#3487](https://github.com/paperless-ngx/paperless-ngx/pull/3487))
+- Fix: prevent date suggestion search if disabled [@shamoon](https://github.com/shamoon) ([#3472](https://github.com/paperless-ngx/paperless-ngx/pull/3472))
+- Sync Pipfile.lock based on latest Pipfile [@adamantike](https://github.com/adamantike) ([#3475](https://github.com/paperless-ngx/paperless-ngx/pull/3475))
+- Fix: DocumentSerializer should return correct original filename [@jayme-github](https://github.com/jayme-github) ([#3473](https://github.com/paperless-ngx/paperless-ngx/pull/3473))
+- consumer.py: read from original file (instead of temp copy) [@chrisblech](https://github.com/chrisblech) ([#3466](https://github.com/paperless-ngx/paperless-ngx/pull/3466))
+- Bugfix: Catch an nltk AttributeError and handle it [@stumpylog](https://github.com/stumpylog) ([#3453](https://github.com/paperless-ngx/paperless-ngx/pull/3453))
+
+### Documentation
+
+- Adding doc on how to setup Fail2ban [@GuillaumeHullin](https://github.com/GuillaumeHullin) ([#3414](https://github.com/paperless-ngx/paperless-ngx/pull/3414))
+- Docs: Fix typo [@MarcelBochtler](https://github.com/MarcelBochtler) ([#3437](https://github.com/paperless-ngx/paperless-ngx/pull/3437))
+- [Documentation] Move nginx [@shamoon](https://github.com/shamoon) ([#3420](https://github.com/paperless-ngx/paperless-ngx/pull/3420))
+- Documentation: Note possible dependency removal for bare metal [@stumpylog](https://github.com/stumpylog) ([#3408](https://github.com/paperless-ngx/paperless-ngx/pull/3408))
+
+### Development
+
+- Development: migrate frontend tests to playwright [@shamoon](https://github.com/shamoon) ([#3401](https://github.com/paperless-ngx/paperless-ngx/pull/3401))
+
+### Dependencies
+
+<details>
+<summary>10 changes</summary>
+
+- Bump eslint from 8.39.0 to 8.41.0 in /src-ui [@dependabot](https://github.com/dependabot) ([#3513](https://github.com/paperless-ngx/paperless-ngx/pull/3513))
+- Bump concurrently from 8.0.1 to 8.1.0 in /src-ui [@dependabot](https://github.com/dependabot) ([#3510](https://github.com/paperless-ngx/paperless-ngx/pull/3510))
+- Bump [@<!---->ng-bootstrap/ng-bootstrap from 14.1.0 to 14.2.0 in /src-ui @dependabot](https://github.com/<!---->ng-bootstrap/ng-bootstrap from 14.1.0 to 14.2.0 in /src-ui @dependabot) ([#3507](https://github.com/paperless-ngx/paperless-ngx/pull/3507))
+- Bump [@<!---->popperjs/core from 2.11.7 to 2.11.8 in /src-ui @dependabot](https://github.com/<!---->popperjs/core from 2.11.7 to 2.11.8 in /src-ui @dependabot) ([#3508](https://github.com/paperless-ngx/paperless-ngx/pull/3508))
+- Bump [@<!---->typescript-eslint/parser from 5.59.2 to 5.59.8 in /src-ui @dependabot](https://github.com/<!---->typescript-eslint/parser from 5.59.2 to 5.59.8 in /src-ui @dependabot) ([#3505](https://github.com/paperless-ngx/paperless-ngx/pull/3505))
+- Bump bootstrap from 5.2.3 to 5.3.0 in /src-ui [@dependabot](https://github.com/dependabot) ([#3497](https://github.com/paperless-ngx/paperless-ngx/pull/3497))
+- Bump [@<!---->typescript-eslint/eslint-plugin from 5.59.2 to 5.59.8 in /src-ui @dependabot](https://github.com/<!---->typescript-eslint/eslint-plugin from 5.59.2 to 5.59.8 in /src-ui @dependabot) ([#3500](https://github.com/paperless-ngx/paperless-ngx/pull/3500))
+- Bump tslib from 2.5.0 to 2.5.2 in /src-ui [@dependabot](https://github.com/dependabot) ([#3501](https://github.com/paperless-ngx/paperless-ngx/pull/3501))
+- Bump [@<!---->types/node from 18.16.3 to 20.2.5 in /src-ui @dependabot](https://github.com/<!---->types/node from 18.16.3 to 20.2.5 in /src-ui @dependabot) ([#3498](https://github.com/paperless-ngx/paperless-ngx/pull/3498))
+- Bump [@<!---->playwright/test from 1.33.0 to 1.34.3 in /src-ui @dependabot](https://github.com/<!---->playwright/test from 1.33.0 to 1.34.3 in /src-ui @dependabot) ([#3499](https://github.com/paperless-ngx/paperless-ngx/pull/3499))
+</details>
+
+### All App Changes
+
+<details>
+<summary>22 changes</summary>
+
+- Fix: KeyError error on unauthenticated API calls \& persist authentication when enabled [@ajgon](https://github.com/ajgon) ([#3516](https://github.com/paperless-ngx/paperless-ngx/pull/3516))
+- Bump eslint from 8.39.0 to 8.41.0 in /src-ui [@dependabot](https://github.com/dependabot) ([#3513](https://github.com/paperless-ngx/paperless-ngx/pull/3513))
+- Bump concurrently from 8.0.1 to 8.1.0 in /src-ui [@dependabot](https://github.com/dependabot) ([#3510](https://github.com/paperless-ngx/paperless-ngx/pull/3510))
+- Bump [@<!---->ng-bootstrap/ng-bootstrap from 14.1.0 to 14.2.0 in /src-ui @dependabot](https://github.com/<!---->ng-bootstrap/ng-bootstrap from 14.1.0 to 14.2.0 in /src-ui @dependabot) ([#3507](https://github.com/paperless-ngx/paperless-ngx/pull/3507))
+- Bump [@<!---->popperjs/core from 2.11.7 to 2.11.8 in /src-ui @dependabot](https://github.com/<!---->popperjs/core from 2.11.7 to 2.11.8 in /src-ui @dependabot) ([#3508](https://github.com/paperless-ngx/paperless-ngx/pull/3508))
+- Bump [@<!---->typescript-eslint/parser from 5.59.2 to 5.59.8 in /src-ui @dependabot](https://github.com/<!---->typescript-eslint/parser from 5.59.2 to 5.59.8 in /src-ui @dependabot) ([#3505](https://github.com/paperless-ngx/paperless-ngx/pull/3505))
+- Bump bootstrap from 5.2.3 to 5.3.0 in /src-ui [@dependabot](https://github.com/dependabot) ([#3497](https://github.com/paperless-ngx/paperless-ngx/pull/3497))
+- Bump [@<!---->typescript-eslint/eslint-plugin from 5.59.2 to 5.59.8 in /src-ui @dependabot](https://github.com/<!---->typescript-eslint/eslint-plugin from 5.59.2 to 5.59.8 in /src-ui @dependabot) ([#3500](https://github.com/paperless-ngx/paperless-ngx/pull/3500))
+- Bump tslib from 2.5.0 to 2.5.2 in /src-ui [@dependabot](https://github.com/dependabot) ([#3501](https://github.com/paperless-ngx/paperless-ngx/pull/3501))
+- Bump [@<!---->types/node from 18.16.3 to 20.2.5 in /src-ui @dependabot](https://github.com/<!---->types/node from 18.16.3 to 20.2.5 in /src-ui @dependabot) ([#3498](https://github.com/paperless-ngx/paperless-ngx/pull/3498))
+- Bump [@<!---->playwright/test from 1.33.0 to 1.34.3 in /src-ui @dependabot](https://github.com/<!---->playwright/test from 1.33.0 to 1.34.3 in /src-ui @dependabot) ([#3499](https://github.com/paperless-ngx/paperless-ngx/pull/3499))
+- Feature: quick filters from document detail [@shamoon](https://github.com/shamoon) ([#3476](https://github.com/paperless-ngx/paperless-ngx/pull/3476))
+- Fix: exclude consumer \& AnonymousUser users from export manifest [@shamoon](https://github.com/shamoon) ([#3487](https://github.com/paperless-ngx/paperless-ngx/pull/3487))
+- Fix: prevent date suggestion search if disabled [@shamoon](https://github.com/shamoon) ([#3472](https://github.com/paperless-ngx/paperless-ngx/pull/3472))
+- Feature: Add explanations to relative dates [@shamoon](https://github.com/shamoon) ([#3471](https://github.com/paperless-ngx/paperless-ngx/pull/3471))
+- Fix: DocumentSerializer should return correct original filename [@jayme-github](https://github.com/jayme-github) ([#3473](https://github.com/paperless-ngx/paperless-ngx/pull/3473))
+- consumer.py: read from original file (instead of temp copy) [@chrisblech](https://github.com/chrisblech) ([#3466](https://github.com/paperless-ngx/paperless-ngx/pull/3466))
+- Bugfix: Catch an nltk AttributeError and handle it [@stumpylog](https://github.com/stumpylog) ([#3453](https://github.com/paperless-ngx/paperless-ngx/pull/3453))
+- Chore: Improves the logging mixin and allows it to be typed better [@stumpylog](https://github.com/stumpylog) ([#3451](https://github.com/paperless-ngx/paperless-ngx/pull/3451))
+- Enhancement: paginate frontend tasks [@shamoon](https://github.com/shamoon) ([#3445](https://github.com/paperless-ngx/paperless-ngx/pull/3445))
+- Add SSL Support for MariaDB [@kimdre](https://github.com/kimdre) ([#3444](https://github.com/paperless-ngx/paperless-ngx/pull/3444))
+- Enhancement: Improve frontend error handling [@shamoon](https://github.com/shamoon) ([#3413](https://github.com/paperless-ngx/paperless-ngx/pull/3413))
+</details>
+
+## paperless-ngx 1.14.5
+
+### Features
+
+- Feature: owner filtering [@shamoon](https://github.com/shamoon) ([#3309](https://github.com/paperless-ngx/paperless-ngx/pull/3309))
+- Enhancement: dynamic counts include all pages, hide for Any [@shamoon](https://github.com/shamoon) ([#3329](https://github.com/paperless-ngx/paperless-ngx/pull/3329))
+- Enhancement: save tour completion, hide welcome widget [@shamoon](https://github.com/shamoon) ([#3321](https://github.com/paperless-ngx/paperless-ngx/pull/3321))
+
+### Bug Fixes
+
+- Fix: Adds better handling for files with invalid utf8 content [@stumpylog](https://github.com/stumpylog) ([#3387](https://github.com/paperless-ngx/paperless-ngx/pull/3387))
+- Fix: respect permissions for autocomplete suggestions [@shamoon](https://github.com/shamoon) ([#3359](https://github.com/paperless-ngx/paperless-ngx/pull/3359))
+- Fix: Transition to new library for finding IPs for failed logins [@stumpylog](https://github.com/stumpylog) ([#3382](https://github.com/paperless-ngx/paperless-ngx/pull/3382))
+- [Security] Render frontend text as plain text [@shamoon](https://github.com/shamoon) ([#3366](https://github.com/paperless-ngx/paperless-ngx/pull/3366))
+- Fix: default frontend to current owner, allow setting no owner on create [@shamoon](https://github.com/shamoon) ([#3347](https://github.com/paperless-ngx/paperless-ngx/pull/3347))
+- Fix: dont perform mail actions when rule filename filter not met [@shamoon](https://github.com/shamoon) ([#3336](https://github.com/paperless-ngx/paperless-ngx/pull/3336))
+- Fix: permission-aware bulk editing in 1.14.1+ [@shamoon](https://github.com/shamoon) ([#3345](https://github.com/paperless-ngx/paperless-ngx/pull/3345))
+
+### Maintenance
+
+- Chore: Rework workflows [@stumpylog](https://github.com/stumpylog) ([#3242](https://github.com/paperless-ngx/paperless-ngx/pull/3242))
+
+### Dependencies
+
+- Chore: Upgrade channels to v4 [@stumpylog](https://github.com/stumpylog) ([#3383](https://github.com/paperless-ngx/paperless-ngx/pull/3383))
+- Chore: Upgrades Python dependencies to their latest allowed versions [@stumpylog](https://github.com/stumpylog) ([#3365](https://github.com/paperless-ngx/paperless-ngx/pull/3365))
+
+### All App Changes
+
+<details>
+<summary>13 changes</summary>
+
+- Fix: Adds better handling for files with invalid utf8 content [@stumpylog](https://github.com/stumpylog) ([#3387](https://github.com/paperless-ngx/paperless-ngx/pull/3387))
+- Fix: respect permissions for autocomplete suggestions [@shamoon](https://github.com/shamoon) ([#3359](https://github.com/paperless-ngx/paperless-ngx/pull/3359))
+- Chore: Upgrade channels to v4 [@stumpylog](https://github.com/stumpylog) ([#3383](https://github.com/paperless-ngx/paperless-ngx/pull/3383))
+- Fix: Transition to new library for finding IPs for failed logins [@stumpylog](https://github.com/stumpylog) ([#3382](https://github.com/paperless-ngx/paperless-ngx/pull/3382))
+- Feature: owner filtering [@shamoon](https://github.com/shamoon) ([#3309](https://github.com/paperless-ngx/paperless-ngx/pull/3309))
+- [Security] Render frontend text as plain text [@shamoon](https://github.com/shamoon) ([#3366](https://github.com/paperless-ngx/paperless-ngx/pull/3366))
+- Enhancement: dynamic counts include all pages, hide for Any [@shamoon](https://github.com/shamoon) ([#3329](https://github.com/paperless-ngx/paperless-ngx/pull/3329))
+- Fix: default frontend to current owner, allow setting no owner on create [@shamoon](https://github.com/shamoon) ([#3347](https://github.com/paperless-ngx/paperless-ngx/pull/3347))
+- [Fix] Position:fixed for .global-dropzone-overlay [@denilsonsa](https://github.com/denilsonsa) ([#3367](https://github.com/paperless-ngx/paperless-ngx/pull/3367))
+- Fix: dont perform mail actions when rule filename filter not met [@shamoon](https://github.com/shamoon) ([#3336](https://github.com/paperless-ngx/paperless-ngx/pull/3336))
+- Enhancement: save tour completion, hide welcome widget [@shamoon](https://github.com/shamoon) ([#3321](https://github.com/paperless-ngx/paperless-ngx/pull/3321))
+- Fix: permission-aware bulk editing in 1.14.1+ [@shamoon](https://github.com/shamoon) ([#3345](https://github.com/paperless-ngx/paperless-ngx/pull/3345))
+- Fix: Add proper testing for \*\_\_id\_\_in testing [@shamoon](https://github.com/shamoon) ([#3315](https://github.com/paperless-ngx/paperless-ngx/pull/3315))
+</details>
+
 ## paperless-ngx 1.14.4
 
 ### Bug Fixes
@@ -1604,7 +2079,7 @@ This is a maintenance release.
     The changed to the full text searching require you to reindex your
     documents. _The docker image does this automatically, you don't need to
     do anything._ To do this, execute the `document_index reindex`
-    management command (see [Managing the document search index](/administration#index)).
+    management command (see [Managing the document search index](administration.md#index)).
 
 ### paperless-ng 1.3.2
 
@@ -1643,7 +2118,7 @@ This release contains new database migrations.
 - Changes
   - The REST API is versioned from this point onwards. This will
     allow me to make changes without breaking existing clients. See
-    the documentation about [API versioning](/api#api-versioning) for details.
+    the documentation about [API versioning](api.md#api-versioning) for details.
   - Added a color picker for tag colors.
   - Added the ability to use the filter for searching the document
     content as well.
@@ -1677,7 +2152,7 @@ This release contains new database migrations.
 - Changes to the OCRmyPDF integration
   - Added support for deskewing and automatic rotation of
     incorrectly rotated pages. This is enabled by default, see
-    [OCR settings](/configuration#ocr).
+    [OCR settings](configuration.md#ocr).
   - Better support for encrypted files.
   - Better support for various other PDF files: Paperless will now
     attempt to force OCR with safe options when OCR fails with the
@@ -1704,7 +2179,7 @@ This release contains new database migrations.
 
 - Added a docker-specific configuration option to adjust the number of
   worker processes of the web server. See
-  [Docker options](/configuration#docker).
+  [Docker options](configuration.md#docker).
 - Some more memory usage optimizations.
 - Don't show inbox statistics if no inbox tag is defined.
 
@@ -1713,7 +2188,7 @@ This release contains new database migrations.
 - Always show top left corner of thumbnails, even for extra wide
   documents.
 - Added a management command for executing the sanity checker
-  directly. See [management utilities](/administration#sanity-checker).
+  directly. See [management utilities](administration.md#sanity-checker).
 - The weekly sanity check now reports messages in the log files.
 - Fixed an issue with the metadata tab not reporting anything in case
   of missing files.
@@ -1747,7 +2222,7 @@ This release contains new database migrations.
   management commands, since these also ensure that they're always
   executed as the paperless user and you're less likely to run into
   permission issues. See
-  [management commands](/administration#management-commands).
+  [management commands](administration.md#management-commands).
 
 ### paperless-ng 1.1.0
 
@@ -1789,7 +2264,7 @@ This release contains new database migrations.
   status notifications.
 
   Apache `mod_wsgi` users, see
-  [this note](/faq#how-do-i-get-websocket-support-with-apache-mod_wsgi).
+  [this note](faq.md#how-do-i-get-websocket-support-with-apache-mod_wsgi).
 
 - Paperless now offers suggestions for tags, correspondents and types
   on the document detail page.
@@ -1834,7 +2309,7 @@ bug reports coming in, I think that this is reasonably stable.
   - The document exporter locks the media directory and the database
     during execution to ensure that the resulting export is
     consistent.
-  - See the [updated documentation](/administration#exporter) for more details.
+  - See the [updated documentation](administration.md#exporter) for more details.
 - Other changes and additions
   - Added a language selector to the settings.
   - Added date format options to the settings.
@@ -1923,7 +2398,7 @@ paperless.
 - Thanks to [Jo Vandeginste](https://github.com/jovandeginste),
   Paperless has optional support for Office documents such as .docx,
   .doc, .odt and more.
-  - See the [Tika settings](/configuration#tika) on how to enable this
+  - See the [Tika settings](configuration.md#tika) on how to enable this
     feature. This feature requires two additional services (one for
     parsing Office documents and metadata extraction and another for
     converting Office documents to PDF), and is therefore not enabled
@@ -2010,7 +2485,7 @@ paperless.
 
     However, this change is not retroactive: If you used the delete method
     of the bulk editor, you need to reindex your search index by
-    [running the management command `document_index` with the argument `reindex`](/administration#index).
+    [running the management command `document_index` with the argument `reindex`](administration.md#index).
 
 ### paperless-ng 0.9.9
 
@@ -2167,13 +2642,13 @@ primarily.
     edit page. If available, a dropdown menu will appear next to the
     download button.
   - Many of the configuration options regarding OCR have changed.
-    See [OCR settings](/configuration#ocr) for details.
+    See [OCR settings](configuration.md#ocr) for details.
   - Paperless no longer guesses the language of your documents. It
     always uses the language that you specified with
     `PAPERLESS_OCR_LANGUAGE`. Be sure to set this to the language
     the majority of your documents are in. Multiple languages can be
     specified, but that requires more CPU time.
-  - The management command [`document_archiver`](/administration#archiver)
+  - The management command [`document_archiver`](administration.md#archiver)
     can be used to create archived versions for already existing documents.
 - Tags from consumption folder.
   - Thanks to [jayme-github](https://github.com/jayme-github),
@@ -2187,7 +2662,7 @@ primarily.
   - The endpoint for uploading documents now supports specifying
     custom titles, correspondents, tags and types. This can be used
     by clients to override the default behavior of paperless. See
-    [POSTing documents](/api#file-uploads).
+    [POSTing documents](api.md#file-uploads).
   - The document endpoint of API now serves documents in this form:
     - correspondents, document types and tags are referenced by
       their ID in the fields `correspondent`, `document_type` and
@@ -2221,14 +2696,14 @@ primarily.
   - Paperless now supports searching by tags, types and dates and
     correspondents. In order to have this applied to your existing
     documents, you need to perform a `document_index reindex`
-    management command (see [document search index](/administration#index))
+    management command (see [document search index](administration.md#index))
     that adds the data to the search index. You only need to do this
     once, since the schema of the search index changed. Paperless
     keeps the index updated after that whenever something changes.
   - Paperless now has spelling corrections ("Did you mean") for
     miss-typed queries.
   - The documentation contains
-    [information about the query syntax](/usage#basic-usage_searching).
+    [information about the query syntax](usage.md#basic-usage_searching).
 - Front end:
   - Clickable tags, correspondents and types allow quick filtering
     for related documents.
@@ -2289,7 +2764,7 @@ primarily.
 
 ### paperless-ng 0.9.0
 
-- **Deprecated:** GnuPG. [See this note on the state of GnuPG in paperless-ng.](/administration#encryption)
+- **Deprecated:** GnuPG. [See this note on the state of GnuPG in paperless-ng.](administration.md#encryption)
   This features will most likely be removed in future versions.
 - **Added:** New frontend. Features:
   - Single page application: It's much more responsive than the
@@ -2347,7 +2822,7 @@ primarily.
     uses PostgreSQL instead of SQLite. Username, database and
     password all default to `paperless` if not specified.
 - **Modified \[breaking\]:** document_retagger management command
-  rework. See [Document retagger](/administration#retagger) for
+  rework. See [Document retagger](administration.md#retagger) for
   details. Replaces `document_correspondents` management command.
 - **Removed \[breaking\]:** Reminders.
 - **Removed:** All customizations made to the django admin pages.
@@ -2816,7 +3291,7 @@ this big change.
   wherein Paperless wasn't recognising `.tif` files properly. Thanks
   to [ayounggun](https://github.com/ayounggun) for reporting this one
   and to [Kusti Skytén](https://github.com/kskyten) for posting the
-  correct solution in the Github issue.
+  correct solution in the GitHub issue.
 
 ### 0.6.0
 

docs/development.md

@@ -61,7 +61,7 @@ first-time setup.
       Every command is executed directly from the root folder of the project unless specified otherwise.
 
 1.  Install prerequisites + pipenv as mentioned in
-    [Bare metal route](/setup#bare_metal).
+    [Bare metal route](setup.md#bare_metal).
 
 2.  Copy `paperless.conf.example` to `paperless.conf` and enable debug
     mode within the file via `PAPERLESS_DEBUG=true`.
@@ -177,8 +177,7 @@ The front end is built using AngularJS. In order to get started, you need Node.j
 
     The following commands are all performed in the `src-ui`-directory. You will need a running back end (including an active session) to connect to the back end API. To spin it up refer to the commands under the section [above](#back-end-development).
 
-1. Install the Angular CLI. You might need sudo privileges
+1.  Install the Angular CLI. You might need sudo privileges to perform this command:
-   to perform this command:
 
     ```bash
     $ npm install -g @angular/cli
@@ -186,7 +185,7 @@ The front end is built using AngularJS. In order to get started, you need Node.j
 
 2.  Make sure that it's on your path.
 
-3. Install all neccessary modules:
+3.  Install all necessary modules:
 
     ```bash
     $ npm install
@@ -207,7 +206,7 @@ The front end is built using AngularJS. In order to get started, you need Node.j
 
 ### Testing and code style
 
-- The front end code (.ts, .html, .scss) use `prettier` for code
+The front end code (.ts, .html, .scss) use `prettier` for code
 formatting via the Git `pre-commit` hooks which run automatically on
 commit. See [above](#code-formatting-with-pre-commit-hooks) for installation instructions. You can also run this via the CLI with a
 command such as
@@ -216,22 +215,23 @@ The front end is built using AngularJS. In order to get started, you need Node.j
 $ git ls-files -- '*.ts' | xargs pre-commit run prettier --files
 ```
 
-- Front end testing uses jest and cypress. There is currently a need
+Front end testing uses Jest and Playwright. Unit tests and e2e tests,
-  for significantly more front end tests. Unit tests and e2e tests,
 respectively, can be run non-interactively with:
 
 ```bash
 $ ng test
-  $ npm run e2e:ci
+$ npx playwright test
 ```
 
-  - Cypress also includes a UI which can be run with:
+Playwright also includes a UI which can be run with:
 
 ```bash
-    $ ./node_modules/.bin/cypress open
+$ npx playwright test --ui
 ```
 
-- In order to build the front end and serve it as part of Django, execute:
+### Building the frontend
+
+In order to build the front end and serve it as part of Django, execute:
 
 ```bash
 $ ng build --configuration production
@@ -395,7 +395,7 @@ responsible for:
 - Retrieving the content from the original
 - Creating a thumbnail
 - _optional:_ Retrieving a created date from the original
-- _optional:_ Creainge an archived document from the original
+- _optional:_ Creating an archived document from the original
 
 Custom parsers can be added to Paperless-ngx to support more file types. In
 order to do that, you need to write the parser itself and announce its

docs/faq.md

@@ -3,15 +3,16 @@
 ## _What's the general plan for Paperless-ngx?_
 
 **A:** While Paperless-ngx is already considered largely
-"feature-complete" it is a community-driven project and development
+"feature-complete", it is a community-driven project and development
-will be guided in this way. New features can be submitted via GitHub
+will be guided in this way. New features can be submitted via
-discussions and "up-voted" by the community but this is not a
+[GitHub discussions](https://github.com/paperless-ngx/paperless-ngx/discussions)
-guarantee the feature will be implemented. This project will always be
+and "up-voted" by the community, but this is not a
+guarantee that the feature will be implemented. This project will always be
 open to collaboration in the form of PRs, ideas etc.
 
 ## _I'm using docker. Where are my documents?_
 
-**A:** Your documents are stored inside the docker volume
+**A:** By default, your documents are stored inside the docker volume
 `paperless_media`. Docker manages this volume automatically for you. It
 is a persistent storage and will persist as long as you don't
 explicitly delete it. The actual location depends on your host operating
@@ -27,6 +28,12 @@ system. On Linux, chances are high that this location is
     files around manually. This folder is meant to be entirely managed by
     docker and paperless.
 
+!!! note
+
+    Files consumed from the consumption directory are re-created inside
+    this media directory and are removed from the consumption directory
+    itself.
+
 ## Let's say I want to switch tools in a year. Can I easily move to other systems?
 
 **A:** Your documents are stored as plain files inside the media folder.
@@ -39,8 +46,8 @@ elsewhere. Here are a couple notes about that.
 - By default, paperless uses the internal ID of each document as its
   filename. This might not be very convenient for export. However, you
   can adjust the way files are stored in paperless by
-  [configuring the filename format](/advanced_usage#file-name-handling).
+  [configuring the filename format](advanced_usage.md#file-name-handling).
-- [The exporter](/administration#exporter) is
+- [The exporter](administration.md#exporter) is
   another easy way to get your files out of paperless with reasonable
   file names.
 
@@ -52,7 +59,7 @@ elsewhere. Here are a couple notes about that.
   WebP images are processed with OCR and converted into PDF documents.
 - Plain text documents are supported as well and are added verbatim to
   paperless.
-- With the optional Tika integration enabled (see [Tika configuration](/configuration#tika),
+- With the optional Tika integration enabled (see [Tika configuration](https://docs.paperless-ngx.com/configuration#tika)),
   Paperless also supports various Office documents (.docx, .doc, odt,
   .ppt, .pptx, .odp, .xls, .xlsx, .ods).
 
@@ -71,12 +78,12 @@ has to do much less work to serve the data.
 !!! note
 
     You can adjust some of the settings so that paperless uses less
-    processing power. See [setup](/setup#less-powerful-devices) for details.
+    processing power. See [setup](setup.md#less-powerful-devices) for details.
 
 ## _How do I install paperless-ngx on Raspberry Pi?_
 
-**A:** Docker images are available for armv7 and arm64 hardware, so just
+**A:** Docker images are available for arm64 hardware, so just
-follow the docker-compose instructions. Apart from more required disk
+follow the [docker-compose instructions](https://docs.paperless-ngx.com/setup/#installation). Apart from more required disk
 space compared to a bare metal installation, docker comes with close to
 zero overhead, even on Raspberry Pi.
 
@@ -85,6 +92,13 @@ the python requirements do not have precompiled packages for ARM /
 ARM64. Installation of these will require additional development
 libraries and compilation will take a long time.
 
+!!! note
+
+    For ARMv7 (32-bit) systems, paperless may still function, but it could require
+    modifications to the Dockerfile (if using Docker) or additional
+    tools for installing bare metal.  It is suggested to upgrade to arm64
+    instead.
+
 ## _How do I run this on Unraid?_
 
 **A:** Paperless-ngx is available as [community
@@ -96,14 +110,11 @@ Fahrer](https://github.com/Tooa) created a container template for that.
 **A:** I honestly don't know! As for all other devices that might be
 able to run paperless, you're a bit on your own. If you can't run the
 docker image, the documentation has instructions for bare metal
-installs. I'm running paperless on an i3 processor from 2015 or so.
+installs.
-This is also what I use to test new releases with. Apart from that, I
-also have a Raspberry Pi, which I occasionally build the image on and
-see if it works.
 
 ## _How do I proxy this with NGINX?_
 
-**A:** See [here](/setup#nginx).
+**A:** See [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Using-a-Reverse-Proxy-with-Paperless-ngx#nginx).
 
 ## _How do I get WebSocket support with Apache mod_wsgi_?
 

docs/index.md

@@ -5,7 +5,7 @@
 **Paperless-ngx** is a _community-supported_ open-source document management system that transforms your
 physical documents into a searchable online archive so you can keep, well, _less paper_.
 
-[Get started](/setup){ .md-button .md-button--primary .index-callout }
+[Get started](setup.md){ .md-button .md-button--primary .index-callout }
 [Demo](https://demo.paperless-ngx.com){ .md-button .md-button--secondary target=\_blank }
 
 </div>
@@ -15,103 +15,159 @@ physical documents into a searchable online archive so you can keep, well, _less
 </div>
 <div class="clear"></div>
 
-## Why This Exists
+## Features
 
-Paper is a nightmare. Environmental issues aside, there's no excuse for
+-   **Organize and index** your scanned documents with tags, correspondents, types, and more.
-it in the 21st century. It takes up space, collects dust, doesn't
+-   Performs **OCR** on your documents, adding selectable text to image-only documents.
-support any form of a search feature, indexing is tedious, it's heavy
+-   Uses machine-learning to automatically add tags, correspondents and document types to your documents.
-and prone to damage & loss.
+-   Supports PDF documents, images, plain text files, Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents)[^1] and more.
+-   Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely with different configurations assigned to different documents.
+-   **Beautiful, modern web application** that features:
+    -   Customizable dashboard with statistics.
+    -   Filtering by tags, correspondents, types, and more.
+    -   Bulk editing of tags, correspondents, types and more.
+    -   Drag-and-drop uploading of documents throughout the app.
+    -   Customizable views can be saved and displayed on the dashboard and / or sidebar.
+    -   Support for custom fields of various data types.
+    -   Shareable public links with optional expiration.
+-   **Full text search** helps you find what you need:
+    -   Auto completion suggests relevant words from your documents.
+    -   Results are sorted by relevance to your search query.
+    -   Highlighting shows you which parts of the document matched the query.
+    -   Searching for similar documents ("More like this")
+-   **Email processing**[^1]: import documents from your email accounts:
+    -   Configure multiple accounts and rules for each account.
+    -   After processing, paperless can perform actions on the messages such as marking as read, deleting and more.
+-   A built-in robust **multi-user permissions** system that supports 'global' permissions as well as per document or object.
+-   A powerful templating system that gives you more control over the consumption pipeline.
+-   **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.
 
-This software is designed to make "going paperless" easier. No more worrying
+[^1]: Office document and email consumption support is optional and provided by Apache Tika (see [configuration](https://docs.paperless-ngx.com/configuration/#tika))
-about finding stuff again, feed documents right from the post box into
-the scanner and then shred them. Perhaps you might find it useful too.
 
 ## Paperless, a history
 
-Paperless is a simple Django application running in two parts: a
+Paperless-ngx is the official successor to the original [Paperless](https://github.com/the-paperless-project/paperless) & [Paperless-ng](https://github.com/jonaswinkler/paperless-ng) projects and is designed to distribute the responsibility of advancing and supporting the project among a team of people. [Consider joining us!](https://github.com/paperless-ngx/paperless-ngx#community-support)
-_Consumer_ (the thing that does the indexing) and the _Web server_ (the
-part that lets you search & download already-indexed documents). If you
-want to learn more about its functions keep on reading after the
-installation section.
 
-Paperless-ngx is a document management system that transforms your
+Further discussion of the transition between these projects can be found at
-physical documents into a searchable online archive so you can keep,
+[ng#1599](https://github.com/jonaswinkler/paperless-ng/issues/1599) and [ng#1632](https://github.com/jonaswinkler/paperless-ng/issues/1632).
-well, _less paper_.
-
-Paperless-ngx forked from paperless-ng to continue the great work and
-distribute responsibility of supporting and advancing the project among
-a team of people.
-
-NG stands for both Angular (the framework used for the Frontend) and
-next-gen. Publishing this project under a different name also avoids
-confusion between paperless and paperless-ngx.
-
-If you want to learn about what's different in paperless-ngx from
-Paperless, check out these resources in the documentation:
-
-- [Some screenshots](#screenshots) of the new UI are available.
-- Read [this section](/advanced_usage#automatic-matching) if you want to learn about how paperless automates all
-  tagging using machine learning.
-- Paperless now comes with a [proper email consumer](/usage#usage-email) that's fully tested and production ready.
-- Paperless creates searchable PDF/A documents from whatever you put into the consumption directory. This means
-  that you can select text in image-only documents coming from your scanner.
-- See [this note](/administration#encryption) about GnuPG encryption in paperless-ngx.
-- Paperless is now integrated with a
-  [task processing queue](/setup#task_processor) that tells you at a glance when and why something is not working.
-- The [changelog](/changelog) contains a detailed list of all changes in paperless-ngx.
 
 ## Screenshots
 
-This is what Paperless-ngx looks like.
+Paperless-ngx aims to be as nice to use as it is useful. Check out some screenshots below.
 
-The dashboard shows customizable views on your document and allows
+<div class="grid-flipped-left" markdown>
-document uploads:
+  ![image](assets/screenshots/dashboard.png)
+</div>
+<div class="grid-flipped-right" markdown>
+  The dashboard shows saved views which can be sorted. Documents can be uploaded with the button or dropped anywhere in the application.
+</div>
+<div class="clear"></div>
 
-[![image](assets/screenshots/dashboard.png)](assets/screenshots/dashboard.png)
+The document list provides three different styles to browse your documents.
 
-The document list provides three different styles to scroll through your
+![image](assets/screenshots/documents-table.png){: style="width:32%"}
-documents:
+![image](assets/screenshots/documents-smallcards.png){: style="width:32%"}
+![image](assets/screenshots/documents-largecards.png){: style="width:32%"}
 
-[![image](assets/screenshots/documents-table.png)](assets/screenshots/documents-table.png)
+<div class="clear"></div>
 
-[![image](assets/screenshots/documents-smallcards.png)](assets/screenshots/documents-smallcards.png)
+<div class="grid-left" markdown>
+  Use the 'slim' sidebar to focus on your docs and minimize the UI.
+</div>
+<div class="grid-right" markdown>
+  ![image](assets/screenshots/documents-smallcards-slimsidebar.png)
+</div>
+<div class="clear"></div>
 
-[![image](assets/screenshots/documents-largecards.png)](assets/screenshots/documents-largecards.png)
+Of course, Paperless-ngx also supports dark mode:
 
-Paperless-ngx also supports dark mode:
+![image](assets/screenshots/documents-smallcards-dark.png)
 
-[![image](assets/screenshots/documents-smallcards-dark.png)](assets/screenshots/documents-smallcards-dark.png)
+<div class="clear"></div>
 
-Extensive filtering mechanisms:
+<div class="grid-left" markdown>
+  Quickly find documents with extensive filtering mechanisms.
+</div>
+<div class="grid-right" markdown>
+  ![image](assets/screenshots/documents-filter.png)
+</div>
+<div class="clear"></div>
+<div class="grid-left" markdown>
+  And perform bulk edit operations to set tags, correspondents, etc. as well as permissions.
+</div>
+<div class="grid-right" markdown>
+  ![image](assets/screenshots/bulk-edit.png)
+</div>
+<div class="clear"></div>
 
-[![image](assets/screenshots/documents-filter.png)](assets/screenshots/documents-filter.png)
+Side-by-side editing of documents.
 
-Bulk editing of document tags, correspondents, etc.:
+![image](assets/screenshots/editing.png)
 
-[![image](assets/screenshots/bulk-edit.png)](assets/screenshots/bulk-edit.png)
+<div class="grid-left" markdown>
+  Support for custom fields.
 
-Side-by-side editing of documents:
+![image](assets/screenshots/custom_field1.png)
 
-[![image](assets/screenshots/editing.png)](assets/screenshots/editing.png)
+</div>
+<div class="grid-right" markdown>
+  ![image](assets/screenshots/custom_field2.png)
+</div>
+<div class="clear"></div>
 
-Tag editing. This looks about the same for correspondents and document
+<div class="grid-left" markdown>
-types.
+  A robust permissions system with support for 'global' and document / object permissions.
 
-[![image](assets/screenshots/new-tag.png)](assets/screenshots/new-tag.png)
+![image](assets/screenshots/permissions_global.png)
 
+</div>
+<div class="grid-right" markdown>
+  ![image](assets/screenshots/permissions_document.png)
+</div>
+<div class="clear"></div>
+
+<div class="grid-left" markdown>
   Searching provides auto complete and highlights the results.
 
-[![image](assets/screenshots/search-preview.png)](assets/screenshots/search-preview.png)
+![image](assets/screenshots/search-preview.png)
 
-[![image](assets/screenshots/search-results.png)](assets/screenshots/search-results.png)
+</div>
+<div class="grid-right" markdown>
+  ![image](assets/screenshots/search-results.png)
+</div>
+<div class="clear"></div>
 
-Fancy mail filters!
+Tag, correspondent, document type and storage path editing.
 
-[![image](assets/screenshots/mail-rules-edited.png)](assets/screenshots/mail-rules-edited.png)
+![image](assets/screenshots/new-tag.png){: style="width:21%; float: left"}
+![image](assets/screenshots/new-correspondent.png){: style="width:21%; margin-left: 4%; float: left"}
+![image](assets/screenshots/new-document_type.png){: style="width:21%; margin-left: 4%; float: left"}
+![image](assets/screenshots/new-storage_path.png){: style="width:21%; margin-left: 4%; float: left"}
+
+<div class="clear"></div>
+
+<div class="grid-half-left" markdown>
+  Mail rules support various filters and actions for incoming e-mails.
+
+![image](assets/screenshots/mail-rules-edited.png)
+
+</div>
+<div class="grid-half-right" markdown>
+  Consumption templates provide finer control over the document pipeline.
+
+![image](assets/screenshots/consumption_template.png)
+
+</div>
+<div class="clear"></div>
+
+<div class="clear"></div>
 
 Mobile devices are supported.
 
-[![image](assets/screenshots/mobile.png)](assets/screenshots/mobile.png)
+![image](assets/screenshots/mobile1.png){: style="width:32%"}
+![image](assets/screenshots/mobile2.png){: style="width:32%"}
+![image](assets/screenshots/mobile3.png){: style="width:32%"}
 
 ## Support
 
@@ -131,7 +187,7 @@ People interested in continuing the work on paperless-ngx are encouraged to reac
 
 ### Translation
 
-Paperless-ngx is available in many languages that are coordinated on [Crowdin](https://crwd.in/paperless-ngx). If you want to help out by translating paperless-ngx into your language, please head over to https://crwd.in/paperless-ngx, and thank you!
+Paperless-ngx is available in many languages that are coordinated on [Crowdin](https://crwd.in/paperless-ngx). If you want to help out by translating paperless-ngx into your language, please head over to the [Paperless-ngx project at Crowdin](https://crwd.in/paperless-ngx), and thank you!
 
 ## Scanners & Software
 

docs/setup.md

@@ -30,7 +30,7 @@ steps described in [Docker setup](#docker_hub) automatically.
 2.  Download and run the installation script:
 
     ```shell-session
-    $ bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
+    $ bash -c "$(curl --location --silent --show-error https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
     ```
 
     !!! note
@@ -124,7 +124,7 @@ steps described in [Docker setup](#docker_hub) automatically.
       user in the container. This value (`user_id` below), should be
       the same id that `USERMAP_UID` and `USERMAP_GID` are set to in
       the next step. See `USERMAP_UID` and `USERMAP_GID`
-      [here](/configuration#docker).
+      [here](configuration.md#docker).
 
     Your entry for Paperless should contain something like:
 
@@ -148,12 +148,12 @@ steps described in [Docker setup](#docker_hub) automatically.
     !!! note
 
         You can copy any setting from the file `paperless.conf.example` and
-        paste it here. Have a look at [configuration](/configuration) to see what's available.
+        paste it here. Have a look at [configuration](configuration.md) to see what's available.
 
     !!! note
 
         You can utilize Docker secrets for configuration settings by
-        appending `_FILE` to configuration values. For example `PAPERLESS_DBUSER`
+        appending `_FILE` to configuration values. For example [`PAPERLESS_DBUSER`](configuration.md#PAPERLESS_DBUSER)
         can be set using `PAPERLESS_DBUSER_FILE=/var/run/secrets/password.txt`.
 
     !!! warning
@@ -162,8 +162,8 @@ steps described in [Docker setup](#docker_hub) automatically.
         system notifications with `inotify`. When storing the consumption
         directory on such a file system, paperless will not pick up new
         files with the default configuration. You will need to use
-        `PAPERLESS_CONSUMER_POLLING`, which will disable inotify. See
+        [`PAPERLESS_CONSUMER_POLLING`](configuration.md#PAPERLESS_CONSUMER_POLLING), which will disable inotify. See
-        [here](/configuration#polling).
+        [here](configuration.md#polling).
 
 6.  Run `docker-compose pull`. This will pull the image.
 
@@ -223,20 +223,8 @@ steps described in [Docker setup](#docker_hub) automatically.
     webserver:
       build:
         context: .
-        args:
-          QPDF_VERSION: x.y.x
-          PIKEPDF_VERSION: x.y.z
-          PSYCOPG2_VERSION: x.y.z
-          JBIG2ENC_VERSION: 0.29
     ```
 
-    !!! note
-
-        You should match the build argument versions to the version for the
-        release you have checked out. These are pre-built images with
-        certain, more updated software. If you want to build these images
-        your self, that is possible, but beyond the scope of these steps.
-
 4.  Follow steps 3 to 8 of [Docker Setup](#docker_hub). When asked to run
     `docker-compose pull` to pull the image, do
 
@@ -255,10 +243,11 @@ supported.
 
 1.  Install dependencies. Paperless requires the following packages.
 
-    - `python3` 3.8, 3.9
+    - `python3` - 3.9 - 3.11 are supported
     - `python3-pip`
     - `python3-dev`
     - `default-libmysqlclient-dev` for MariaDB
+    - `pkg-config` for mysqlclient (python dependency)
     - `fonts-liberation` for generating thumbnails for plain text
       files
     - `imagemagick` >= 6 for PDF conversion
@@ -273,7 +262,7 @@ supported.
     Use this list for your preferred package management:
 
     ```
-    python3 python3-pip python3-dev imagemagick fonts-liberation gnupg libpq-dev default-libmysqlclient-dev libmagic-dev mime-support libzbar0 poppler-utils
+    python3 python3-pip python3-dev imagemagick fonts-liberation gnupg libpq-dev default-libmysqlclient-dev pkg-config libmagic-dev mime-support libzbar0 poppler-utils
     ```
 
     These dependencies are required for OCRmyPDF, which is used for text
@@ -341,41 +330,41 @@ supported.
     home folder of the user you created before (`/opt/paperless`).
 
     Optional: If you cloned the git repo, you will have to
-    compile the frontend yourself, see [here](/development#front-end-development)
+    compile the frontend yourself, see [here](development.md#front-end-development)
     and use the `build` step, not `serve`.
 
-6.  Configure paperless. See [configuration](/configuration) for details.
+6.  Configure paperless. See [configuration](configuration.md) for details.
     Edit the included `paperless.conf` and adjust the settings to your
     needs. Required settings for getting
     paperless running are:
 
-    - `PAPERLESS_REDIS` should point to your redis server, such as
+    - [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS) should point to your redis server, such as
       <redis://localhost:6379>.
-    - `PAPERLESS_DBENGINE` optional, and should be one of `postgres`,
+    - [`PAPERLESS_DBENGINE`](configuration.md#PAPERLESS_DBENGINE) optional, and should be one of `postgres`,
       `mariadb`, or `sqlite`
-    - `PAPERLESS_DBHOST` should be the hostname on which your
+    - [`PAPERLESS_DBHOST`](configuration.md#PAPERLESS_DBHOST) should be the hostname on which your
       PostgreSQL server is running. Do not configure this to use
       SQLite instead. Also configure port, database name, user and
       password as necessary.
-    - `PAPERLESS_CONSUMPTION_DIR` should point to a folder which
+    - [`PAPERLESS_CONSUMPTION_DIR`](configuration.md#PAPERLESS_CONSUMPTION_DIR) should point to a folder which
       paperless should watch for documents. You might want to have
-      this somewhere else. Likewise, `PAPERLESS_DATA_DIR` and
+      this somewhere else. Likewise, [`PAPERLESS_DATA_DIR`](configuration.md#PAPERLESS_DATA_DIR) and
-      `PAPERLESS_MEDIA_ROOT` define where paperless stores its data.
+      [`PAPERLESS_MEDIA_ROOT`](configuration.md#PAPERLESS_MEDIA_ROOT) define where paperless stores its data.
       If you like, you can point both to the same directory.
-    - `PAPERLESS_SECRET_KEY` should be a random sequence of
+    - [`PAPERLESS_SECRET_KEY`](configuration.md#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
+    - [`PAPERLESS_URL`](configuration.md#PAPERLESS_URL) if you are behind a reverse proxy. This should
       point to your domain. Please see
-      [configuration](/configuration) for more
+      [configuration](configuration.md) for more
       information.
 
     Many more adjustments can be made to paperless, especially the OCR
     part. The following options are recommended for everyone:
 
-    - Set `PAPERLESS_OCR_LANGUAGE` to the language most of your
+    - Set [`PAPERLESS_OCR_LANGUAGE`](configuration.md#PAPERLESS_OCR_LANGUAGE) to the language most of your
       documents are written in.
-    - Set `PAPERLESS_TIME_ZONE` to your local time zone.
+    - Set [`PAPERLESS_TIME_ZONE`](configuration.md#PAPERLESS_TIME_ZONE) to your local time zone.
 
     !!! warning
 
@@ -483,7 +472,7 @@ supported.
         in front of gunicorn instead.
 
         For instructions on how to use nginx for that,
-        [see the instructions below](/setup#nginx).
+        [see the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Using-a-Reverse-Proxy-with-Paperless-ngx#nginx).
 
     !!! warning
 
@@ -521,7 +510,7 @@ supported.
     not available for most distributions.
 
 15. Optional: If using the NLTK machine learning processing (see
-    `PAPERLESS_ENABLE_NLTK` in [configuration](/configuration#software_tweaks) for details),
+    [`PAPERLESS_ENABLE_NLTK`](configuration.md#PAPERLESS_ENABLE_NLTK) for details),
     download the NLTK data for the Snowball
     Stemmer, Stopwords and Punkt tokenizer to your
     `PAPERLESS_DATA_DIR/nltk`. Refer to the [NLTK
@@ -559,7 +548,7 @@ Users who installed with the bare-metal route should also update their
 Git clone to point to `https://github.com/paperless-ngx/paperless-ngx`,
 e.g. using the command
 `git remote set-url origin https://github.com/paperless-ngx/paperless-ngx`
-and then pull the lastest version.
+and then pull the latest version.
 
 ## Migrating from Paperless
 
@@ -570,7 +559,7 @@ your setup depending on how you installed paperless.
 This setup describes how to update an existing paperless Docker
 installation. The important things to keep in mind are as follows:
 
-- Read the [changelog](/changelog) and
+- Read the [changelog](changelog.md) and
   take note of breaking changes.
 - You should decide if you want to stick with SQLite or want to
   migrate your database to PostgreSQL. See [documentation](#sqlite_to_psql)
@@ -630,7 +619,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
     See [Docker setup](#docker_hub) details on
     which edits are advised.
 
-6.  [Update paperless.](/administration#updating)
+6.  [Update paperless.](administration.md#updating)
 
 7.  In order to find your existing documents with the new search
     feature, you need to invoke a one-time operation that will create
@@ -669,23 +658,23 @@ commands as well.
 1.  Stop and remove the paperless container
 2.  If using an external database, stop the container
 3.  Update Redis configuration
-    a) If `REDIS_URL` is already set, change it to `PAPERLESS_REDIS`
+    a) If `REDIS_URL` is already set, change it to [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS)
     and continue to step 4.
     b) Otherwise, in the `docker-compose.yml` add a new service for
     Redis, following [the example compose
     files](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose)
-    c) Set the environment variable `PAPERLESS_REDIS` so it points to
+    c) Set the environment variable [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS) so it points to
     the new Redis container
 4.  Update user mapping
     a) If set, change the environment variable `PUID` to `USERMAP_UID`
     b) If set, change the environment variable `PGID` to `USERMAP_GID`
 5.  Update configuration paths
-    a) Set the environment variable `PAPERLESS_DATA_DIR` to `/config`
+    a) Set the environment variable [`PAPERLESS_DATA_DIR`](configuration.md#PAPERLESS_DATA_DIR) to `/config`
 6.  Update media paths
-    a) Set the environment variable `PAPERLESS_MEDIA_ROOT` to
+    a) Set the environment variable [`PAPERLESS_MEDIA_ROOT`](configuration.md#PAPERLESS_MEDIA_ROOT) to
     `/data/media`
 7.  Update timezone
-    a) Set the environment variable `PAPERLESS_TIME_ZONE` to the same
+    a) Set the environment variable [`PAPERLESS_TIME_ZONE`](configuration.md#PAPERLESS_TIME_ZONE) to the same
     value as `TZ`
 8.  Modify the `image:` to point to
     `ghcr.io/paperless-ngx/paperless-ngx:latest` or a specific version
@@ -717,7 +706,7 @@ below use PostgreSQL, but are applicable to MySQL/MariaDB with the
 !!! warning
 
     MySQL is case insensitive by default, treating values like "Name" and
-    "NAME" as identical. See [MySQL caveats](/advanced_usage#mysql-caveats) for details.
+    "NAME" as identical. See [MySQL caveats](advanced_usage.md#mysql-caveats) for details.
 
 !!! warning
 
@@ -738,7 +727,7 @@ below use PostgreSQL, but are applicable to MySQL/MariaDB with the
     file to `docker-compose.yml`. Remember to adjust the consumption
     directory, if necessary.
     b) Without docker, configure the database in your `paperless.conf`
-    file. See [configuration](/configuration) for
+    file. See [configuration](configuration.md) for
     details.
 
 3.  Open a shell and initialize the database:
@@ -822,36 +811,36 @@ the Pi and configuring some options in paperless can help improve
 performance immensely:
 
 - Stick with SQLite to save some resources.
-- Consider setting `PAPERLESS_OCR_PAGES` to 1, so that paperless will
+- Consider setting [`PAPERLESS_OCR_PAGES`](configuration.md#PAPERLESS_OCR_PAGES) to 1, so that paperless will
   only OCR the first page of your documents. In most cases, this page
   contains enough information to be able to find it.
-- `PAPERLESS_TASK_WORKERS` and `PAPERLESS_THREADS_PER_WORKER` are
+- [`PAPERLESS_TASK_WORKERS`](configuration.md#PAPERLESS_TASK_WORKERS) and [`PAPERLESS_THREADS_PER_WORKER`](configuration.md#PAPERLESS_THREADS_PER_WORKER) are
   configured to use all cores. The Raspberry Pi models 3 and up have 4
   cores, meaning that paperless will use 2 workers and 2 threads per
   worker. This may result in sluggish response times during
   consumption, so you might want to lower these settings (example: 2
   workers and 1 thread to always have some computing power left for
   other tasks).
-- Keep `PAPERLESS_OCR_MODE` at its default value `skip` and consider
+- Keep [`PAPERLESS_OCR_MODE`](configuration.md#PAPERLESS_OCR_MODE) at its default value `skip` and consider
   OCR'ing your documents before feeding them into paperless. Some
   scanners are able to do this!
-- Set `PAPERLESS_OCR_SKIP_ARCHIVE_FILE` to `with_text` to skip archive
+- Set [`PAPERLESS_OCR_SKIP_ARCHIVE_FILE`](configuration.md#PAPERLESS_OCR_SKIP_ARCHIVE_FILE) to `with_text` to skip archive
   file generation for already ocr'ed documents, or `always` to skip it
   for all documents.
 - If you want to perform OCR on the device, consider using
   `PAPERLESS_OCR_CLEAN=none`. This will speed up OCR times and use
   less memory at the expense of slightly worse OCR results.
-- If using docker, consider setting `PAPERLESS_WEBSERVER_WORKERS` to 1. This will save some memory.
+- If using docker, consider setting [`PAPERLESS_WEBSERVER_WORKERS`](configuration.md#PAPERLESS_WEBSERVER_WORKERS) to 1. This will save some memory.
-- Consider setting `PAPERLESS_ENABLE_NLTK` to false, to disable the
+- Consider setting [`PAPERLESS_ENABLE_NLTK`](configuration.md#PAPERLESS_ENABLE_NLTK) to false, to disable the
   more advanced language processing, which can take more memory and
   processing time.
 
-For details, refer to [configuration](/configuration).
+For details, refer to [configuration](configuration.md).
 
 !!! note
 
     Updating the
-    [automatic matching algorithm](/advanced_usage#automatic-matching) takes quite a bit of time. However, the update mechanism
+    [automatic matching algorithm](advanced_usage.md#automatic-matching) takes quite a bit of time. However, the update mechanism
     checks if your data has changed before doing the heavy lifting. If you
     experience the algorithm taking too much cpu time, consider changing the
     schedule in the admin interface to daily. You can also manually invoke
@@ -862,45 +851,8 @@ For details, refer to [configuration](/configuration).
 
 # Using nginx as a reverse proxy {#nginx}
 
-If you want to expose paperless to the internet, you should hide it
+Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Using-a-Reverse-Proxy-with-Paperless-ngx#nginx) for user-maintained documentation of using nginx with Paperless-ngx.
-behind a reverse proxy with SSL enabled.
 
-In addition to the usual configuration for SSL, the following
+# Enhancing security {#security}
-configuration is required for paperless to operate:
 
-```nginx
+Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Using-Security-Tools-with-Paperless-ngx) for user-maintained documentation of how to configure security tools like Fail2ban with Paperless-ngx.
-http {
-
-    # Adjust as required. This is the maximum size for file uploads.
-    # The default value 1M might be a little too small.
-    client_max_body_size 10M;
-
-    server {
-
-        location / {
-
-            # Adjust host and port as required.
-            proxy_pass http://localhost:8000/;
-
-            # These configuration options are required for WebSockets to work.
-            proxy_http_version 1.1;
-            proxy_set_header Upgrade $http_upgrade;
-            proxy_set_header Connection "upgrade";
-
-            proxy_redirect off;
-            proxy_set_header Host $host;
-            proxy_set_header X-Real-IP $remote_addr;
-            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-            proxy_set_header X-Forwarded-Host $server_name;
-            add_header P3P 'CP=""'; # may not be required in all setups
-        }
-    }
-}
-```
-
-The `PAPERLESS_URL` configuration variable is also required when using a
-reverse proxy. Please refer to the [hosting and security](/configuration#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.md

@@ -46,8 +46,7 @@ run:
 If you notice that the consumer will only pickup files in the
 consumption directory at startup, but won't find any other files added
 later, you will need to enable filesystem polling with the configuration
-option `PAPERLESS_CONSUMER_POLLING`, see
+option [`PAPERLESS_CONSUMER_POLLING`](configuration.md#PAPERLESS_CONSUMER_POLLING).
-`[here](/configuration#polling).
 
 This will disable listening to filesystem changes with inotify and
 paperless will manually check the consumption directory for changes
@@ -145,7 +144,7 @@ The following error occured while consuming document.pdf: [Errno 13] Permission
 This happens when paperless does not have permission to delete files
 inside the consumption directory. Ensure that `USERMAP_UID` and
 `USERMAP_GID` are set to the user id and group id you use on the host
-operating system, if these are different from `1000`. See [Docker setup](/setup#docker_hub).
+operating system, if these are different from `1000`. See [Docker setup](setup.md#docker_hub).
 
 Also ensure that you are able to read and write to the consumption
 directory on the host.
@@ -265,8 +264,8 @@ This probably indicates paperless tried to consume the same file twice.
 This can happen for a number of reasons, depending on how documents are
 placed into the consume folder. If paperless is using inotify (the
 default) to check for documents, try adjusting the
-[inotify configuration](/configuration#inotify). If polling is enabled, try adjusting the
+[inotify configuration](configuration.md#inotify). If polling is enabled, try adjusting the
-[polling configuration](/configuration#polling).
+[polling configuration](configuration.md#polling).
 
 ## Consumer fails waiting for file to remain unmodified.
 
@@ -278,7 +277,7 @@ You might find messages like these in your log files:
 
 This indicates paperless timed out while waiting for the file to be
 completely written to the consume folder. Adjusting
-[polling configuration](/configuration#polling) values should resolve the issue.
+[polling configuration](configuration.md#polling) values should resolve the issue.
 
 !!! note
 
@@ -297,8 +296,8 @@ This indicates paperless was unable to open the file, as the OS reported
 the file as still being in use. To prevent a crash, paperless did not
 try to consume the file. If paperless is using inotify (the default) to
 check for documents, try adjusting the
-[inotify configuration](/configuration#inotify). If polling is enabled, try adjusting the
+[inotify configuration](configuration.md#inotify). If polling is enabled, try adjusting the
-[polling configuration](/configuration#polling).
+[polling configuration](configuration.md#polling).
 
 !!! note
 
@@ -320,7 +319,7 @@ many workers attempting to access the database simultaneously.
 
 Consider changing to the PostgreSQL database if you will be processing
 many documents at once often. Otherwise, try tweaking the
-`PAPERLESS_DB_TIMEOUT` setting to allow more time for the database to
+[`PAPERLESS_DB_TIMEOUT`](configuration.md#PAPERLESS_DB_TIMEOUT) setting to allow more time for the database to
 unlock. This may have minor performance implications.
 
 ## gunicorn fails to start with "is not a valid port number"
@@ -330,7 +329,7 @@ environment variable named `${serviceName}_PORT`. This is
 the same environment variable which is used by Paperless to optionally
 change the port gunicorn listens on.
 
-To fix this, set `PAPERLESS_PORT` again to your desired port, or the
+To fix this, set [`PAPERLESS_PORT`](configuration.md#PAPERLESS_PORT) again to your desired port, or the
 default of 8000.
 
 ## Database Warns about unique constraint "documents_tag_name_uniq
@@ -345,3 +344,15 @@ STATEMENT:  INSERT INTO "documents_tag" ("owner_id", "name", "match", "matching_
 
 This can happen during heavy consumption when using polling. Paperless will handle it correctly and the file
 will still be consumed
+
+## Consumption fails with "Ghostscript PDF/A rendering failed"
+
+Newer versions of OCRmyPDF will fail if it encounters errors during processing.
+This is intentional as the output archive file may differ in unexpected or undesired
+ways from the original. As the logs indicate, if you encounter this error you can set
+`PAPERLESS_OCR_USER_ARGS: '{"continue_on_soft_render_error": true}'` to try to 'force'
+processing documents with this issue.
+
+## Platform-Specific Deployment Troubleshooting
+
+A user-maintained wiki page is available to help troubleshoot issues that may arise when trying to deploy Paperless-ngx on specific platforms, for example SELinux. Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Platform%E2%80%90Specific-Troubleshooting).

docs/usage.md

@@ -62,14 +62,16 @@ following operations on your documents:
     paperless to create archived versions for digital documents, you can
     configure that by configuring
     `PAPERLESS_OCR_SKIP_ARCHIVE_FILE=with_text`. Please read the
-    [relevant section in the documentation](/configuration#ocr).
+    [relevant section in the documentation](configuration.md#ocr).
 
 !!! note
 
     No matter which options you choose, Paperless will always store the
     original document that it found in the consumption directory or in the
     mail and will never overwrite that document. Archived versions are
-    stored alongside the original versions.
+    stored alongside the original versions. Any files found in the
+    consumption directory will stored inside the Paperless-ngx file
+    structure and will not be retained in the consumption directory.
 
 ### The consumption directory
 
@@ -77,7 +79,9 @@ The primary method of getting documents into your database is by putting
 them in the consumption directory. The consumer waits patiently, looking
 for new additions to this directory. When it finds them,
 the consumer goes about the process of parsing them with the OCR,
-indexing what it finds, and storing it in the media directory.
+indexing what it finds, and storing it in the media directory. You should
+think of this folder as a temporary location, as files will be re-created
+inside Paperless-ngx and removed from the consumption folder.
 
 Getting stuff into this directory is up to you. If you're running
 Paperless on your local computer, you might just want to drag and drop
@@ -88,27 +92,25 @@ Typically, you're looking at an FTP server like
 [Proftpd](http://www.proftpd.org/) or a Windows folder share with
 [Samba](https://www.samba.org/).
 
+!!! warning
+
+    Files found in the consumption directory that are consumed will be
+    removed from the consumption directory and stored inside the
+    Paperless-ngx file structure using any settings / storage paths
+    you have specified. This action is performed as safely as possible
+    but this means it is expected that files in the consumption
+    directory will no longer exist (there) after being consumed.
+
 ### Web UI Upload
 
-The dashboard has a file drop field to upload documents to paperless.
+The dashboard has a button to upload documents to paperless or you
-Simply drag a file onto this field or select a file with the file
+can simply drag a file anywhere into the app to initiate the consumption
-dialog. Multiple files are supported.
+process.
-
-You can also upload documents on any other page of the web UI by
-dragging-and-dropping files into your browser window.
 
 ### Mobile upload {#usage-mobile_upload}
 
-The mobile app over at [https://github.com/qcasey/paperless_share](https://github.com/qcasey/paperless_share)
+Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Affiliated-Projects) for a user-maintained list of affiliated projects and
-allows Android users to share any documents with paperless. This can be
+software (e.g. for mobile devices) that is compatible with Paperless-ngx.
-combined with any of the mobile scanning apps out there, such as Office
-Lens.
-
-Furthermore, there is the [Paperless
-App](https://github.com/bauerj/paperless_app) as well, which not only
-has document upload, but also document browsing and download features.
-
-Another option is [Paperless Mobile](https://github.com/astubenbord/paperless-mobile), an Android app that supports document upload, scanning, management of labels and more.
 
 ### IMAP (Email) {#usage-email}
 
@@ -132,9 +134,9 @@ These rules perform the following:
 5.  If documents were consumed from a mail, the rule action is performed
     on that mail.
 
-Paperless will completely ignore mails that do not match your filters.
+Paperless will check all emails only once and completely ignore messages
-It will also only perform the action on mails that it has consumed
+that do not match your filters. It will also only perform the rule action
-documents from.
+on e-mails that it has consumed documents from.
 
 The actions all ensure that the same mail is not consumed twice by
 different means. These are as follows:
@@ -195,20 +197,31 @@ different means. These are as follows:
     them further.
 
 Paperless is set up to check your mails every 10 minutes. This can be
-configured via `PAPERLESS_EMAIL_TASK_CRON` (see [software tweaks](/configuration#software_tweaks))
+configured via [`PAPERLESS_EMAIL_TASK_CRON`](configuration.md#PAPERLESS_EMAIL_TASK_CRON)
 
 ### REST API
 
-You can also submit a document using the REST API, see [POSTing documents](/api#file-uploads)
+You can also submit a document using the REST API, see [POSTing documents](api.md#file-uploads)
 for details.
 
 ## Permissions
 
 As of version 1.14.0 Paperless-ngx added core support for user / group permissions. Permissions is
-based around an object 'owner' and 'view' and 'edit' permissions can be granted to other users
+based around 'global' permissions as well as 'object-level' permissions. Global permissions designate
-or groups.
+which parts of the application a user can access (e.g. Documents, Tags, Settings) and object-level
+determine which objects are visible or editable. All objects have an 'owner' and 'view' and 'edit'
+permissions which can be granted to other users or groups. The paperless-ngx permissions system uses
+the built-in user model of the backend framework, Django.
 
-Permissions uses the built-in user model of the backend framework, Django.
+!!! tip
+
+    Object-level permissions only apply to the object itself. In other words, setting permissions
+    for a Tag will _not_ affect the permissions of documents that have the Tag.
+
+Permissions can be set using the new "Permissions" tab when editing documents, or bulk-applied
+in the UI by selecting documents and choosing the "Permissions" button. Owner can also optionally
+be set for documents uploaded via the API. Documents consumed via the consumption dir currently
+do not have an owner set.
 
 !!! note
 
@@ -223,10 +236,12 @@ Permissions uses the built-in user model of the backend framework, Django.
 
     Note that superusers have access to all objects.
 
-Permissions can be set using the new "Permissions" tab when editing documents, or bulk-applied
+### Default permissions
-in the UI by selecting documents and choosing the "Permissions" button. Owner can also optionally
+
-be set for documents uploaded via the API. Documents consumed via the consumption dir currently
+Default permissions for documents can be set using consumption templates.
-do not have an owner set.
+
+For objects created via the web UI (tags, doc types, etc.) the default is to set the current user
+as owner and no extra permissions, but you explicitly set these under Settings > Permissions.
 
 ### Users and Groups
 
@@ -235,6 +250,112 @@ These can be found under Settings > Users & Groups, assuming the user has access
 as a member of a group those permissions will be inherited and this is reflected in the UI. Explicit
 permissions can be granted to limit access to certain parts of the UI (and corresponding API endpoints).
 
+### Password reset
+
+In order to enable the password reset feature you will need to setup an SMTP backend, see
+[`PAPERLESS_EMAIL_HOST`](configuration.md#PAPERLESS_EMAIL_HOST)
+
+## Consumption templates
+
+Consumption templates were introduced in v2.0 and allow for finer control over what metadata (tags, doc
+types) and permissions (owner, privileges) are assigned to documents during consumption. In general,
+templates are applied sequentially (by sort order) but subsequent templates will never override an
+assignment from a preceding template. The same is true for mail rules, e.g. if you set the correspondent
+in a mail rule any subsequent consumption templates that are applied _will not_ overwrite this. The
+exception to this is assignments that can be multiple e.g. tags and permissions, which will be merged.
+
+Consumption templates allow you to filter by:
+
+- Source, e.g. documents uploaded via consume folder, API (& the web UI) and mail fetch
+- File name, including wildcards e.g. \*.pdf will apply to all pdfs
+- File path, including wildcards. Note that enabling `PAPERLESS_CONSUMER_RECURSIVE` would allow, for
+  example, automatically assigning documents to different owners based on the upload directory.
+- Mail rule. Choosing this option will force 'mail fetch' to be the template source.
+
+!!! note
+
+    You must include a file name filter, a path filter or a mail rule filter. Use * for either to apply
+    to all files.
+
+Consumption templates can assign:
+
+- Title, see [title placeholders](usage.md#title_placeholders) below
+- Tags, correspondent, document types
+- Document owner
+- View and / or edit permissions to users or groups
+
+### Consumption template permissions
+
+All users who have application permissions for editing consumption templates can see the same set
+of templates. In other words, templates themselves intentionally do not have an owner or permissions.
+
+Given their potentially far-reaching capabilities, you may want to restrict access to templates.
+
+Upon migration, existing installs will grant access to consumption templates to users who can add
+documents (and superusers who can always access all parts of the app).
+
+### Title placeholders
+
+Consumption template titles can include placeholders, _only for items that are assigned within the template_.
+This is because at the time of consumption (when the title is to be set), no automatic tags etc. have been
+applied. You can use the following placeholders:
+
+- `{correspondent}`: assigned correspondent name
+- `{document_type}`: assigned document type name
+- `{owner_username}`: assigned owner username
+- `{added}`: added datetime
+- `{added_year}`: added year
+- `{added_year_short}`: added year
+- `{added_month}`: added month
+- `{added_month_name}`: added month name
+- `{added_month_name_short}`: added month short name
+- `{added_day}`: added day
+
+## Custom Fields {#custom-fields}
+
+Paperless-ngx supports the use of custom fields for documents as of v2.0, allowing a user
+to optionally attach data to documents which does not fit in the existing set of fields
+Paperless-ngx provides.
+
+1. First, create a custom field (under "Manage"), with a given name and data type. This could be something like "Invoice Number" or "Date Paid", with a data type of "Number", "Date", "String", etc.
+2. Once created, a field can be used with documents and data stored. To do so, use the "Custom Fields" menu on the document detail page, choose your existing field and click "Add". Once the field is visible in the form you can enter the appropriate
+   data which will be validated according to the custom field "data type".
+3. Fields can be removed by hovering over the field name revealing a "Remove" button.
+
+!!! important
+
+    Added / removed fields, as well as any data is not saved to the document until you
+    actually hit the "Save" button, similar to other changes on the document details page.
+
+!!! note
+
+    Once the data type for a field is set, it cannot be changed.
+
+Multiple fields may be attached to a document but the same field name cannot be assigned multiple times to the a single document.
+
+The following custom field types are supported:
+
+- `Text`: any text
+- `Boolean`: true / false (check / unchecked) field
+- `Date`: date
+- `URL`: a valid url
+- `Integer`: integer number e.g. 12
+- `Number`: float number e.g. 12.3456
+- `Monetary`: float number with exactly two decimals, e.g. 12.30
+
+## Share Links
+
+Paperless-ngx added the abiltiy to create shareable links to files in version 2.0. You can find the button for this on the document detail screen.
+
+- Share links do not require a user to login and thus link directly to a file.
+- Links are unique and are of the form `{paperless-url}/share/{randomly-generated-slug}`.
+- Links can optionally have an expiration time set.
+- After a link expires or is deleted users will be redirected to the regular paperless-ngx login.
+
+!!! tip
+
+    If your paperless-ngx instance is behind a reverse-proxy you may want to create an exception to bypass any authentication layers that are part of your setup in order to make links truly publicly-accessible. Of course, do so with caution.
+
 ## Best practices {#basic-searching}
 
 Paperless offers a couple tools that help you organize your document
@@ -443,7 +564,7 @@ Once you have scanned in a document, proceed in paperless as follows.
     paperless will assign them automatically. After consuming a couple
     documents, you can even ask paperless to *learn* when to assign tags and
     correspondents by itself. For details on this feature, see
-    [advanced matching](/advanced_usage#matching).
+    [advanced matching](advanced_usage.md#matching).
 
 ### Task management
 

install-paperless-ngx.sh

@@ -38,7 +38,6 @@ ask_docker_folder() {
 			echo "Invalid folder: $result"
 		fi
 
-
 	done
 }
 
@@ -58,7 +57,7 @@ if ! command -v docker &> /dev/null ; then
 fi
 
 DOCKER_COMPOSE_CMD="docker-compose"
-if ! command -v ${DOCKER_COMPOSE_CMD} ; then
+if ! command -v ${DOCKER_COMPOSE_CMD} &> /dev/null ; then
 	if docker compose version &> /dev/null ; then
 		DOCKER_COMPOSE_CMD="docker compose"
 	else
@@ -72,7 +71,7 @@ fi
 if ! docker stats --no-stream &> /dev/null ; then
 	echo ""
 	echo "WARN: It look like the current user does not have Docker permissions."
-	echo "WARN: Use 'sudo usermod -aG docker $USER' to assign Docker permissions to the user."
+	echo "WARN: Use 'sudo usermod -aG docker $USER' to assign Docker permissions to the user (may require restarting shell)."
 	echo ""
 	sleep 3
 fi
@@ -321,7 +320,8 @@ fi
 wget "https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docker/compose/docker-compose.$DOCKER_COMPOSE_VERSION.yml" -O docker-compose.yml
 wget "https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docker/compose/.env" -O .env
 
-SECRET_KEY=$(tr --delete --complement 'a-zA-Z0-9' < /dev/urandom 2>/dev/null | head --bytes 64)
+SECRET_KEY=$(LC_ALL=C tr -dc 'a-zA-Z0-9!"#$%&'\''()*+,-./:;<=>?@[\]^_`{|}~' < /dev/urandom | head --bytes 64)
+
 
 DEFAULT_LANGUAGES=("deu eng fra ita spa")
 
@@ -384,6 +384,14 @@ fi
 
 ${DOCKER_COMPOSE_CMD} pull
 
+if [ "$DATABASE_BACKEND" == "postgres" ] || [ "$DATABASE_BACKEND" == "mariadb" ] ; then
+	echo "Starting DB first for initilzation"
+	${DOCKER_COMPOSE_CMD} up --detach db
+	# hopefully enough time for even the slower systems
+	sleep 15
+	${DOCKER_COMPOSE_CMD} stop
+fi
+
 ${DOCKER_COMPOSE_CMD} run --rm -e DJANGO_SUPERUSER_PASSWORD="$PASSWORD" webserver createsuperuser --noinput --username "$USERNAME" --email "$EMAIL"
 
 ${DOCKER_COMPOSE_CMD} up --detach

mkdocs.yml

@@ -28,6 +28,7 @@ theme:
     repo: fontawesome/brands/github
   favicon: assets/favicon.png
 repo_url: https://github.com/paperless-ngx/paperless-ngx
+repo_name: paperless-ngx/paperless-ngx
 edit_uri: blob/main/docs/
 extra_css:
   - assets/extra.css
@@ -42,6 +43,7 @@ markdown_extensions:
   - pymdownx.superfences
   - pymdownx.inlinehilite
   - pymdownx.snippets
+  - footnotes
 strict: true
 nav:
     - index.md
@@ -64,3 +66,5 @@ extra:
       link: https://hub.docker.com/r/paperlessngx/paperless-ngx
     - icon: material/chat
       link: https://matrix.to/#/#paperless:matrix.org
+plugins:
+  - glightbox

paperless.conf.example

@@ -66,6 +66,11 @@
 #PAPERLESS_CONSUMER_SUBDIRS_AS_TAGS=false
 #PAPERLESS_CONSUMER_ENABLE_BARCODES=false
 #PAPERLESS_CONSUMER_BARCODE_STRING=PATCHT
+#PAPERLESS_CONSUMER_BARCODE_UPSCALE=0.0
+#PAPERLESS_CONSUMER_BARCODE_DPI=300
+#PAPERLESS_CONSUMER_ENABLE_COLLATE_DOUBLE_SIDED=false
+#PAPERLESS_CONSUMER_COLLATE_DOUBLE_SIDED_SUBDIR_NAME=double-sided
+#PAPERLESS_CONSUMER_COLLATE_DOUBLE_SIDED_TIFF_SUPPORT=false
 #PAPERLESS_PRE_CONSUME_SCRIPT=/path/to/an/arbitrary/script.sh
 #PAPERLESS_POST_CONSUME_SCRIPT=/path/to/an/arbitrary/script.sh
 #PAPERLESS_FILENAME_DATE_ORDER=YMD

scripts/start_services.sh

@@ -1,6 +1,6 @@
 #!/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 -p 5432:5432 -e POSTGRES_PASSWORD=password -v paperless_pgdata:/var/lib/postgresql/data -d postgres:15
 docker run -d -p 6379:6379 redis:latest
 docker run -p 3000:3000 -d gotenberg/gotenberg:7.8 gotenberg --chromium-disable-javascript=true --chromium-allow-list="file:///tmp/.*"
 docker run -p 9998:9998 -d ghcr.io/paperless-ngx/tika:latest

src-ui/.eslintrc.json

@@ -24,7 +24,7 @@
           "error",
           {
             "type": "attribute",
-            "prefix": "app",
+            "prefix": "pngx",
             "style": "camelCase"
           }
         ],
@@ -32,7 +32,7 @@
           "error",
           {
             "type": "element",
-            "prefix": "app",
+            "prefix": "pngx",
             "style": "kebab-case"
           }
         ]

src-ui/.gitignore

@@ -49,3 +49,6 @@ Thumbs.db
 # Cypress
 cypress/videos/**/*
 cypress/screenshots/**/*
+/test-results/
+/playwright-report/
+/playwright/.cache/

src-ui/angular.json

@@ -12,32 +12,39 @@
       },
       "root": "",
       "sourceRoot": "src",
-      "prefix": "app",
+      "prefix": "pngx",
       "i18n": {
         "sourceLocale": "en-US",
         "locales": {
           "ar-AR": "src/locale/messages.ar_AR.xlf",
+          "af-ZA": "src/locale/messages.af_ZA.xlf",
+          "bg-BG": "src/locale/messages.bg_BG.xlf",
           "be-BY": "src/locale/messages.be_BY.xlf",
           "ca-ES": "src/locale/messages.ca_ES.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",
+          "el-GR": "src/locale/messages.el_GR.xlf",
           "en-GB": "src/locale/messages.en_GB.xlf",
           "es-ES": "src/locale/messages.es_ES.xlf",
           "fi-FI": "src/locale/messages.fi_FI.xlf",
           "fr-FR": "src/locale/messages.fr_FR.xlf",
+          "hu-HU": "src/locale/messages.hu_HU.xlf",
           "it-IT": "src/locale/messages.it_IT.xlf",
           "lb-LU": "src/locale/messages.lb_LU.xlf",
           "nl-NL": "src/locale/messages.nl_NL.xlf",
+          "no-NO": "src/locale/messages.no_NO.xlf",
           "pl-PL": "src/locale/messages.pl_PL.xlf",
           "pt-BR": "src/locale/messages.pt_BR.xlf",
           "pt-PT": "src/locale/messages.pt_PT.xlf",
           "ro-RO": "src/locale/messages.ro_RO.xlf",
           "ru-RU": "src/locale/messages.ru_RU.xlf",
+          "sk-SK": "src/locale/messages.sk_SK.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",
+          "uk-UA": "src/locale/messages.uk_UA.xlf",
           "zh-CN": "src/locale/messages.zh_CN.xlf"
         }
       },
@@ -147,37 +154,6 @@
             "scripts": []
           }
         },
-        "e2e": {
-          "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": {
-            "devServerTarget": "paperless-ui:serve"
-          },
-          "configurations": {
-            "production": {
-              "devServerTarget": "paperless-ui:serve:production"
-            }
-          }
-        },
-        "cypress-open": {
-          "builder": "@cypress/schematic:cypress",
-          "options": {
-            "watch": true,
-            "headless": false
-          }
-        },
         "lint": {
           "builder": "@angular-eslint/builder:lint",
           "options": {
@@ -190,7 +166,6 @@
       }
     }
   },
-  "defaultProject": "paperless-ui",
   "cli": {
     "schematicCollections": [
       "@angular-eslint/schematics"

src-ui/cypress.config.ts

@@ -1,14 +0,0 @@
-import { defineConfig } from 'cypress'
-
-export default defineConfig({
-  videosFolder: 'cypress/videos',
-  video: false,
-  screenshotsFolder: 'cypress/screenshots',
-  fixturesFolder: 'cypress/fixtures',
-  e2e: {
-    setupNodeEvents(on, config) {
-      return require('./cypress/plugins/index.ts')(on, config)
-    },
-    baseUrl: 'http://localhost:4200',
-  },
-})

src-ui/cypress/e2e/auth/auth.cy.ts

@@ -1,68 +0,0 @@
-describe('settings', () => {
-  beforeEach(() => {
-    // also uses global fixtures from cypress/support/e2e.ts
-
-    // mock restricted permissions
-    cy.intercept('http://localhost:8000/api/ui_settings/', {
-      fixture: 'ui_settings/settings_restricted.json',
-    })
-  })
-
-  it('should not allow user to edit settings', () => {
-    cy.visit('/dashboard')
-    cy.contains('Settings').should('not.exist')
-    cy.visit('/settings').wait(2000)
-    cy.contains("You don't have permissions to do that").should('exist')
-  })
-
-  it('should not allow user to view documents', () => {
-    cy.visit('/dashboard')
-    cy.contains('Documents').should('not.exist')
-    cy.visit('/documents').wait(2000)
-    cy.contains("You don't have permissions to do that").should('exist')
-    cy.visit('/documents/1').wait(2000)
-    cy.contains("You don't have permissions to do that").should('exist')
-  })
-
-  it('should not allow user to view correspondents', () => {
-    cy.visit('/dashboard')
-    cy.contains('Correspondents').should('not.exist')
-    cy.visit('/correspondents').wait(2000)
-    cy.contains("You don't have permissions to do that").should('exist')
-  })
-
-  it('should not allow user to view tags', () => {
-    cy.visit('/dashboard')
-    cy.contains('Tags').should('not.exist')
-    cy.visit('/tags').wait(2000)
-    cy.contains("You don't have permissions to do that").should('exist')
-  })
-
-  it('should not allow user to view document types', () => {
-    cy.visit('/dashboard')
-    cy.contains('Document Types').should('not.exist')
-    cy.visit('/documenttypes').wait(2000)
-    cy.contains("You don't have permissions to do that").should('exist')
-  })
-
-  it('should not allow user to view storage paths', () => {
-    cy.visit('/dashboard')
-    cy.contains('Storage Paths').should('not.exist')
-    cy.visit('/storagepaths').wait(2000)
-    cy.contains("You don't have permissions to do that").should('exist')
-  })
-
-  it('should not allow user to view logs', () => {
-    cy.visit('/dashboard')
-    cy.contains('Logs').should('not.exist')
-    cy.visit('/logs').wait(2000)
-    cy.contains("You don't have permissions to do that").should('exist')
-  })
-
-  it('should not allow user to view tasks', () => {
-    cy.visit('/dashboard')
-    cy.contains('Tasks').should('not.exist')
-    cy.visit('/tasks').wait(2000)
-    cy.contains("You don't have permissions to do that").should('exist')
-  })
-})

src-ui/cypress/e2e/documents/document-detail.cy.ts

@@ -1,118 +0,0 @@
-describe('document-detail', () => {
-  beforeEach(() => {
-    // also uses global fixtures from cypress/support/e2e.ts
-
-    this.modifiedDocuments = []
-
-    cy.fixture('documents/documents.json').then((documentsJson) => {
-      cy.intercept(
-        'GET',
-        'http://localhost:8000/api/documents/1/?full_perms=true',
-        (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.fixture('documents/1/notes.json').then((notesJson) => {
-      cy.intercept(
-        'GET',
-        'http://localhost:8000/api/documents/1/notes/',
-        (req) => {
-          req.reply(notesJson.filter((c) => c.id != 10)) // 3
-        }
-      )
-
-      cy.intercept(
-        'DELETE',
-        'http://localhost:8000/api/documents/1/notes/?id=9',
-        (req) => {
-          req.reply(notesJson.filter((c) => c.id != 9 && c.id != 10)) // 2
-        }
-      )
-
-      cy.intercept(
-        'POST',
-        'http://localhost:8000/api/documents/1/notes/',
-        (req) => {
-          req.reply(notesJson) // 4
-        }
-      )
-    })
-
-    cy.viewport(1024, 1024)
-    cy.visit('/documents/1/').wait('@ui-settings')
-  })
-
-  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')
-  })
-
-  it('should show a mobile preview', () => {
-    cy.viewport(440, 1000)
-    cy.get('a')
-      .contains('Preview')
-      .scrollIntoView({ offset: { top: 150, left: 0 } })
-      .click()
-    cy.get('pdf-viewer').should('be.visible')
-  })
-
-  it('should show a list of notes', () => {
-    cy.wait(1000).get('a').contains('Notes').click({ force: true }).wait(1000)
-    cy.get('app-document-notes').find('.card').its('length').should('eq', 3)
-  })
-
-  it('should support note deletion', () => {
-    cy.wait(1000).get('a').contains('Notes').click().wait(1000)
-    cy.get('app-document-notes')
-      .find('.card')
-      .first()
-      .find('button')
-      .click({ force: true })
-      .wait(500)
-    cy.get('app-document-notes').find('.card').its('length').should('eq', 2)
-  })
-
-  it('should support note insertion', () => {
-    cy.wait(1000).get('a').contains('Notes').click().wait(1000)
-    cy.get('app-document-notes')
-      .find('form textarea')
-      .type('Testing new note')
-      .wait(500)
-    cy.get('app-document-notes').find('form button').click().wait(1500)
-    cy.get('app-document-notes').find('.card').its('length').should('eq', 4)
-  })
-
-  it('should support navigation to notes tab by url', () => {
-    cy.visit('/documents/1/notes')
-    cy.get('app-document-notes').should('exist')
-  })
-
-  it('should dynamically update note counts', () => {
-    cy.visit('/documents/1/notes')
-    cy.get('app-document-notes').within(() => cy.contains('Delete').click())
-    cy.get('ul.nav').find('li').contains('Notes').find('.badge').contains('2')
-  })
-})

src-ui/cypress/e2e/documents/documents-list.cy.ts

@@ -1,196 +0,0 @@
-describe('documents-list', () => {
-  beforeEach(() => {
-    // also uses global fixtures from cypress/support/e2e.ts
-
-    this.bulkEdits = {}
-
-    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
-        } else if (req.query.hasOwnProperty('correspondent__id__in')) {
-          // filtering e.g. http://localhost:8000/api/documents/?page=1&page_size=50&ordering=-created&correspondent__id__in=9,14
-          const correspondent_ids = req.query['correspondent__id__in']
-            .toString()
-            .split(',')
-            .map((c) => +c)
-          response.results = (documentsJson.results as Array<any>).filter((d) =>
-            correspondent_ids.includes(d.correspondent)
-          )
-          response.count = response.results.length
-        } else if (req.query.hasOwnProperty('correspondent__id__none')) {
-          // filtering e.g. http://localhost:8000/api/documents/?page=1&page_size=50&ordering=-created&correspondent__id__none=9,14
-          const correspondent_ids = req.query['correspondent__id__none']
-            .toString()
-            .split(',')
-            .map((c) => +c)
-          response.results = (documentsJson.results as Array<any>).filter(
-            (d) => !correspondent_ids.includes(d.correspondent)
-          )
-          response.count = response.results.length
-        }
-
-        req.reply(response)
-      })
-
-      cy.intercept('http://localhost:8000/api/documents/selection_data/', {
-        fixture: 'documents/selection_data.json',
-      }).as('selection-data')
-    })
-
-    cy.viewport(1280, 1024)
-    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 input[value="details"]').next().click()
-    cy.get('table')
-  })
-
-  it('should change to large cards view', () => {
-    cy.get('div.btn-group input[value="largeCards"]').next().click()
-    cy.get('app-document-card-large')
-  })
-
-  it('should show partial tag selection', () => {
-    cy.get('app-document-card-small:nth-child(1)').click()
-    cy.get('app-document-card-small:nth-child(4)').click()
-    cy.get('app-bulk-editor button')
-      .contains('Tags')
-      .click()
-      .wait('@selection-data')
-    cy.get('svg.bi-dash').should('be.visible')
-    cy.get('svg.bi-check').should('be.visible')
-  })
-
-  it('should allow bulk removal', () => {
-    cy.get('app-document-card-small:nth-child(1)').click()
-    cy.get('app-document-card-small:nth-child(4)').click()
-    cy.get('app-bulk-editor').within(() => {
-      cy.get('button').contains('Tags').click().wait('@selection-data')
-      cy.get('button').contains('Another Sample Tag').click()
-      cy.get('button').contains('Apply').click()
-    })
-    cy.contains('operation will remove the tag')
-  })
-
-  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 filter including multiple correspondents', () => {
-    cy.get('app-filter-editor app-filterable-dropdown[title="Correspondent"]')
-      .click()
-      .within(() => {
-        cy.contains('button', 'ABC Test Correspondent').click()
-        cy.contains('button', 'Corresp 11').click()
-      })
-    cy.contains('3 documents')
-  })
-
-  it('should filter excluding multiple correspondents', () => {
-    cy.get('app-filter-editor app-filterable-dropdown[title="Correspondent"]')
-      .click()
-      .within(() => {
-        cy.contains('button', 'ABC Test Correspondent').click()
-        cy.contains('button', 'Corresp 11').click()
-        cy.contains('label', 'Exclude').click()
-      })
-    cy.contains('3 documents')
-  })
-
-  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/e2e/documents/query-params.cy.ts

@@ -1,391 +0,0 @@
-import { PaperlessDocument } from 'src/app/data/paperless-document'
-
-describe('documents query params', () => {
-  beforeEach(() => {
-    // also uses global fixtures from cypress/support/e2e.ts
-
-    cy.fixture('documents/documents.json').then((documentsJson) => {
-      // mock api filtering
-      cy.intercept('GET', 'http://localhost:8000/api/documents/*', (req) => {
-        let response = { ...documentsJson }
-
-        if (req.query.hasOwnProperty('ordering')) {
-          const sort_field = req.query['ordering'].toString().replace('-', '')
-          const reverse = req.query['ordering'].toString().indexOf('-') !== -1
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).sort((docA, docB) => {
-            let result = 0
-            switch (sort_field) {
-              case 'created':
-              case 'added':
-                result =
-                  new Date(docA[sort_field]) < new Date(docB[sort_field])
-                    ? -1
-                    : 1
-                break
-              case 'archive_serial_number':
-                result = docA[sort_field] < docB[sort_field] ? -1 : 1
-                break
-            }
-            if (reverse) result = -result
-            return result
-          })
-        }
-
-        if (req.query.hasOwnProperty('tags__id__in')) {
-          const tag_ids: Array<number> = req.query['tags__id__in']
-            .toString()
-            .split(',')
-            .map((v) => +v)
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter(
-            (d) =>
-              d.tags.length > 0 &&
-              d.tags.filter((t) => tag_ids.includes(t)).length > 0
-          )
-          response.count = response.results.length
-        } else if (req.query.hasOwnProperty('tags__id__none')) {
-          const tag_ids: Array<number> = req.query['tags__id__none']
-            .toString()
-            .split(',')
-            .map((v) => +v)
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.tags.filter((t) => tag_ids.includes(t)).length == 0)
-          response.count = response.results.length
-        } else if (
-          req.query.hasOwnProperty('is_tagged') &&
-          req.query['is_tagged'] == '0'
-        ) {
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.tags.length == 0)
-          response.count = response.results.length
-        }
-
-        if (req.query.hasOwnProperty('document_type__id')) {
-          const doctype_id = +req.query['document_type__id']
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.document_type == doctype_id)
-          response.count = response.results.length
-        } else if (
-          req.query.hasOwnProperty('document_type__isnull') &&
-          req.query['document_type__isnull'] == '1'
-        ) {
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.document_type == undefined)
-          response.count = response.results.length
-        }
-
-        if (req.query.hasOwnProperty('correspondent__id')) {
-          const correspondent_id = +req.query['correspondent__id']
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.correspondent == correspondent_id)
-          response.count = response.results.length
-        } else if (
-          req.query.hasOwnProperty('correspondent__isnull') &&
-          req.query['correspondent__isnull'] == '1'
-        ) {
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.correspondent == undefined)
-          response.count = response.results.length
-        }
-
-        if (req.query.hasOwnProperty('storage_path__id')) {
-          const storage_path_id = +req.query['storage_path__id']
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.storage_path == storage_path_id)
-          response.count = response.results.length
-        } else if (
-          req.query.hasOwnProperty('storage_path__isnull') &&
-          req.query['storage_path__isnull'] == '1'
-        ) {
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.storage_path == undefined)
-          response.count = response.results.length
-        }
-
-        if (req.query.hasOwnProperty('created__date__gt')) {
-          const date = new Date(req.query['created__date__gt'])
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => new Date(d.created) > date)
-          response.count = response.results.length
-        } else if (req.query.hasOwnProperty('created__date__lt')) {
-          const date = new Date(req.query['created__date__lt'])
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => new Date(d.created) < date)
-          response.count = response.results.length
-        }
-
-        if (req.query.hasOwnProperty('added__date__gt')) {
-          const date = new Date(req.query['added__date__gt'])
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => new Date(d.added) > date)
-          response.count = response.results.length
-        } else if (req.query.hasOwnProperty('added__date__lt')) {
-          const date = new Date(req.query['added__date__lt'])
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => new Date(d.added) < date)
-          response.count = response.results.length
-        }
-
-        if (req.query.hasOwnProperty('title_content')) {
-          const title_content_regexp = new RegExp(
-            req.query['title_content'].toString(),
-            'i'
-          )
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter(
-            (d) =>
-              title_content_regexp.test(d.title) ||
-              title_content_regexp.test(d.content)
-          )
-          response.count = response.results.length
-        }
-
-        if (req.query.hasOwnProperty('archive_serial_number')) {
-          const asn = +req.query['archive_serial_number']
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.archive_serial_number == asn)
-          response.count = response.results.length
-        } else if (req.query.hasOwnProperty('archive_serial_number__isnull')) {
-          const isnull = req.query['storage_path__isnull'] == '1'
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) =>
-            isnull
-              ? d.archive_serial_number == undefined
-              : d.archive_serial_number != undefined
-          )
-          response.count = response.results.length
-        } else if (req.query.hasOwnProperty('archive_serial_number__gt')) {
-          const asn = +req.query['archive_serial_number__gt']
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter(
-            (d) => d.archive_serial_number > 0 && d.archive_serial_number > asn
-          )
-          response.count = response.results.length
-        } else if (req.query.hasOwnProperty('archive_serial_number__lt')) {
-          const asn = +req.query['archive_serial_number__lt']
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter(
-            (d) => d.archive_serial_number > 0 && d.archive_serial_number < asn
-          )
-          response.count = response.results.length
-        }
-
-        if (req.query.hasOwnProperty('owner__id')) {
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.owner == req.query['owner__id'])
-          response.count = response.results.length
-        } else if (req.query.hasOwnProperty('owner__id__in')) {
-          const owners = req.query['owner__id__in']
-            .toString()
-            .split(',')
-            .map((o) => parseInt(o))
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => owners.includes(d.owner))
-          response.count = response.results.length
-        } else if (req.query.hasOwnProperty('owner__id__none')) {
-          const owners = req.query['owner__id__none']
-            .toString()
-            .split(',')
-            .map((o) => parseInt(o))
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => !owners.includes(d.owner))
-          response.count = response.results.length
-        } else if (req.query.hasOwnProperty('owner__isnull')) {
-          response.results = (
-            documentsJson.results as Array<PaperlessDocument>
-          ).filter((d) => d.owner === null)
-          response.count = response.results.length
-        }
-
-        req.reply(response)
-      })
-    })
-  })
-
-  it('should show a list of documents sorted by created', () => {
-    cy.visit('/documents?sort=created')
-    cy.get('app-document-card-small').first().contains('No latin title')
-  })
-
-  it('should show a list of documents reverse sorted by created', () => {
-    cy.visit('/documents?sort=created&reverse=true')
-    cy.get('app-document-card-small').first().contains('Doc 6')
-  })
-
-  it('should show a list of documents sorted by added', () => {
-    cy.visit('/documents?sort=added')
-    cy.get('app-document-card-small').first().contains('No latin title')
-  })
-
-  it('should show a list of documents reverse sorted by added', () => {
-    cy.visit('/documents?sort=added&reverse=true')
-    cy.get('app-document-card-small').first().contains('Doc 6')
-  })
-
-  it('should show a list of documents filtered by any tags', () => {
-    cy.visit('/documents?sort=created&reverse=true&tags__id__in=2,4,5')
-    cy.contains('3 documents')
-  })
-
-  it('should show a list of documents filtered by excluded tags', () => {
-    cy.visit('/documents?sort=created&reverse=true&tags__id__none=2,4')
-    cy.contains('3 documents')
-  })
-
-  it('should show a list of documents filtered by no tags', () => {
-    cy.visit('/documents?sort=created&reverse=true&is_tagged=0')
-    cy.contains('3 documents')
-  })
-
-  it('should show a list of documents filtered by document type', () => {
-    cy.visit('/documents?sort=created&reverse=true&document_type__id=1')
-    cy.contains('2 documents')
-  })
-
-  it('should show a list of documents filtered by multiple correspondents', () => {
-    cy.visit('/documents?sort=created&reverse=true&document_type__id__in=1,2')
-    cy.contains('3 documents')
-  })
-
-  it('should show a list of documents filtered by no document type', () => {
-    cy.visit('/documents?sort=created&reverse=true&document_type__isnull=1')
-    cy.contains('3 documents')
-  })
-
-  it('should show a list of documents filtered by correspondent', () => {
-    cy.visit('/documents?sort=created&reverse=true&correspondent__id=9')
-    cy.contains('2 documents')
-  })
-
-  it('should show a list of documents filtered by multiple correspondents', () => {
-    cy.visit('/documents?sort=created&reverse=true&correspondent__id__in=9,14')
-    cy.contains('3 documents')
-  })
-
-  it('should show a list of documents filtered by no correspondent', () => {
-    cy.visit('/documents?sort=created&reverse=true&correspondent__isnull=1')
-    cy.contains('3 documents')
-  })
-
-  it('should show a list of documents filtered by storage path', () => {
-    cy.visit('/documents?sort=created&reverse=true&storage_path__id=2')
-    cy.contains('One document')
-  })
-
-  it('should show a list of documents filtered by no storage path', () => {
-    cy.visit('/documents?sort=created&reverse=true&storage_path__isnull=1')
-    cy.contains('5 documents')
-  })
-
-  it('should show a list of documents filtered by title or content', () => {
-    cy.visit('/documents?sort=created&reverse=true&title_content=lorem')
-    cy.contains('2 documents')
-  })
-
-  it('should show a list of documents filtered by asn', () => {
-    cy.visit('/documents?sort=created&reverse=true&archive_serial_number=12345')
-    cy.contains('One document')
-  })
-
-  it('should show a list of documents filtered by empty asn', () => {
-    cy.visit(
-      '/documents?sort=created&reverse=true&archive_serial_number__isnull=1'
-    )
-    cy.contains('2 documents')
-  })
-
-  it('should show a list of documents filtered by non-empty asn', () => {
-    cy.visit(
-      '/documents?sort=created&reverse=true&archive_serial_number__isnull=0'
-    )
-    cy.contains('2 documents')
-  })
-
-  it('should show a list of documents filtered by asn greater than', () => {
-    cy.visit(
-      '/documents?sort=created&reverse=true&archive_serial_number__gt=12346'
-    )
-    cy.contains('One document')
-  })
-
-  it('should show a list of documents filtered by asn less than', () => {
-    cy.visit(
-      '/documents?sort=created&reverse=true&archive_serial_number__lt=12346'
-    )
-    cy.contains('One document')
-  })
-
-  it('should show a list of documents filtered by created date greater than', () => {
-    cy.visit(
-      '/documents?sort=created&reverse=true&created__date__gt=2022-03-23'
-    )
-    cy.contains('5 documents')
-  })
-
-  it('should show a list of documents filtered by created date less than', () => {
-    cy.visit(
-      '/documents?sort=created&reverse=true&created__date__lt=2022-03-23'
-    )
-    cy.contains('One document')
-  })
-
-  it('should show a list of documents filtered by added date greater than', () => {
-    cy.visit('/documents?sort=created&reverse=true&added__date__gt=2022-03-24')
-    cy.contains('4 documents')
-  })
-
-  it('should show a list of documents filtered by added date less than', () => {
-    cy.visit('/documents?sort=created&reverse=true&added__date__lt=2022-03-24')
-    cy.contains('2 documents')
-  })
-
-  it('should show a list of documents filtered by multiple filters', () => {
-    cy.visit(
-      '/documents?sort=created&reverse=true&document_type__id=1&correspondent__id=9&tags__id__in=4,5'
-    )
-    cy.contains('2 documents')
-  })
-
-  it('should show a list of documents filtered by owner', () => {
-    cy.visit('/documents?owner__id=15')
-    cy.contains('One document')
-  })
-
-  it('should show a list of documents filtered by multiple owners', () => {
-    cy.visit('/documents?owner__id__in=6,15')
-    cy.contains('2 documents')
-  })
-
-  it('should show a list of documents filtered by excluded owners', () => {
-    cy.visit('/documents?owner__id__none=6')
-    cy.contains('5 documents')
-  })
-
-  it('should show a list of documents filtered by null owner', () => {
-    cy.visit('/documents?owner__isnull=true')
-    cy.contains('4 documents')
-  })
-})

src-ui/cypress/e2e/manage/manage.cy.ts

@@ -1,25 +0,0 @@
-describe('manage', () => {
-  // also uses global fixtures from cypress/support/e2e.ts
-
-  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:visible').contains('Documents').first().click() // id = 4
-    cy.contains('3 documents')
-  })
-})

src-ui/cypress/e2e/settings/settings.cy.ts

@@ -1,187 +0,0 @@
-describe('settings', () => {
-  beforeEach(() => {
-    // also uses global fixtures from cypress/support/e2e.ts
-
-    this.modifiedViews = []
-
-    // mock API methods
-    cy.intercept('http://localhost:8000/api/ui_settings/', {
-      fixture: 'ui_settings/settings.json',
-    }).then(() => {
-      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')
-      })
-
-      this.newMailAccounts = []
-
-      cy.intercept(
-        'POST',
-        'http://localhost:8000/api/mail_accounts/',
-        (req) => {
-          const newRule = req.body
-          newRule.id = 3
-          this.newMailAccounts.push(newRule) // store this for later
-          req.reply({ result: 'OK' })
-        }
-      ).as('saveAccount')
-
-      cy.fixture('mail_accounts/mail_accounts.json').then(
-        (mailAccountsJson) => {
-          cy.intercept(
-            'GET',
-            'http://localhost:8000/api/mail_accounts/*',
-            (req) => {
-              let response = { ...mailAccountsJson }
-              if (this.newMailAccounts.length) {
-                response.results = response.results.concat(this.newMailAccounts)
-              }
-
-              req.reply(response)
-            }
-          ).as('getAccounts')
-        }
-      )
-
-      this.newMailRules = []
-
-      cy.intercept('POST', 'http://localhost:8000/api/mail_rules/', (req) => {
-        const newRule = req.body
-        newRule.id = 2
-        this.newMailRules.push(newRule) // store this for later
-        req.reply({ result: 'OK' })
-      }).as('saveRule')
-
-      cy.fixture('mail_rules/mail_rules.json').then((mailRulesJson) => {
-        cy.intercept('GET', 'http://localhost:8000/api/mail_rules/*', (req) => {
-          let response = { ...mailRulesJson }
-          if (this.newMailRules.length) {
-            response.results = response.results.concat(this.newMailRules)
-          }
-
-          req.reply(response)
-        }).as('getRules')
-      })
-
-      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.viewport(1024, 1600)
-    cy.visit('/settings')
-  })
-
-  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(2000)
-    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().wait(2000)
-    cy.get('#show_in_sidebar_1').click()
-    cy.contains('button', 'Save').click().wait('@savedViews').wait(2000)
-    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').wait(2000)
-    cy.visit('/dashboard')
-    cy.get('app-saved-view-widget').contains('Inbox').should('not.exist')
-  })
-
-  it('should show a list of mail accounts & support creation', () => {
-    cy.contains('a', 'Mail').click()
-    cy.get('app-settings .tab-content ul li').its('length').should('eq', 5) // 2 headers, 2 accounts, 1 rule
-    cy.contains('button', 'Add Account').click()
-    cy.contains('Create new mail account')
-    cy.get('app-input-text[formcontrolname="name"]').type(
-      'Example Mail Account'
-    )
-    cy.get('app-input-text[formcontrolname="imap_server"]').type(
-      'mail.example.com'
-    )
-    cy.get('app-input-text[formcontrolname="imap_port"]').type('993')
-    cy.get('app-input-text[formcontrolname="username"]').type('username')
-    cy.get('app-input-password[formcontrolname="password"]').type('pass')
-    cy.contains('app-mail-account-edit-dialog button', 'Save')
-      .click()
-      .wait('@saveAccount')
-      .wait('@getAccounts')
-    cy.contains('Saved account')
-
-    cy.get('app-settings .tab-content ul li').its('length').should('eq', 6)
-  })
-
-  it('should show a list of mail rules & support creation', () => {
-    cy.contains('a', 'Mail').click()
-    cy.get('app-settings .tab-content ul li').its('length').should('eq', 5) // 2 headers, 2 accounts, 1 rule
-
-    cy.wait(1000)
-    cy.contains('button', 'Add Rule').click()
-    cy.contains('Create new mail rule')
-    cy.get('app-input-text[formcontrolname="name"]').type('Example Rule')
-    cy.get('app-input-select[formcontrolname="account"]').type('Example{enter}')
-    cy.get('app-input-number[formcontrolname="maximum_age"]').type('30')
-    cy.get('app-input-text[formcontrolname="filter_subject"]').type(
-      '[paperless]'
-    )
-    cy.contains('app-mail-rule-edit-dialog button', 'Save')
-      .click()
-      .wait('@saveRule')
-      .wait('@getRules')
-    cy.contains('Saved rule').wait(1000)
-
-    cy.get('app-settings .tab-content ul li').its('length').should('eq', 6)
-  })
-})

src-ui/cypress/e2e/tasks/tasks.cy.ts

@@ -1,93 +0,0 @@
-describe('tasks', () => {
-  beforeEach(() => {
-    this.dismissedTasks = new Set<number>()
-
-    cy.fixture('tasks/tasks.json').then((tasksViewsJson) => {
-      // acknowledge tasks POST
-      cy.intercept(
-        'POST',
-        'http://localhost:8000/api/acknowledge_tasks/',
-        (req) => {
-          req.body['tasks'].forEach((t) => this.dismissedTasks.add(t)) // store this for later
-          req.reply({ result: 'OK' })
-        }
-      )
-
-      cy.intercept('GET', 'http://localhost:8000/api/tasks/', (req) => {
-        let response = [...tasksViewsJson]
-        if (this.dismissedTasks.size) {
-          response = response.filter((t) => {
-            return !this.dismissedTasks.has(t.id)
-          })
-        }
-
-        req.reply(response)
-      }).as('tasks')
-    })
-
-    cy.visit('/tasks')
-    cy.wait('@tasks')
-  })
-
-  it('should show a list of dismissable tasks in tabs', () => {
-    cy.get('tbody').find('tr:visible').its('length').should('eq', 10) // double because collapsible result tr
-    cy.wait(500) // stabilizes the test, for some reason...
-    cy.get('tbody')
-      .find('button:visible')
-      .contains('Dismiss')
-      .first()
-      .click()
-      .wait('@tasks')
-      .wait(2000)
-      .then(() => {
-        cy.get('tbody').find('tr:visible').its('length').should('eq', 8) // double because collapsible result tr
-      })
-  })
-
-  it('should correctly switch between task tabs', () => {
-    cy.get('tbody').find('tr:visible').its('length').should('eq', 10) // double because collapsible result tr
-    cy.wait(500) // stabilizes the test, for some reason...
-    cy.get('app-tasks')
-      .find('a:visible')
-      .contains('Queued')
-      .first()
-      .click()
-      .wait(2000)
-      .then(() => {
-        cy.get('tbody').find('tr:visible').should('not.exist')
-      })
-    cy.get('app-tasks')
-      .find('a:visible')
-      .contains('Started')
-      .first()
-      .click()
-      .wait(2000)
-      .then(() => {
-        cy.get('tbody').find('tr:visible').its('length').should('eq', 2) // double because collapsible result tr
-      })
-    cy.get('app-tasks')
-      .find('a:visible')
-      .contains('Complete')
-      .first()
-      .click()
-      .wait('@tasks')
-      .wait(2000)
-      .then(() => {
-        cy.get('tbody').find('tr:visible').its('length').should('eq', 12) // double because collapsible result tr
-      })
-  })
-
-  it('should allow toggling all tasks in list and warn on dismiss', () => {
-    cy.get('thead').find('input[type="checkbox"]').first().click()
-    cy.get('body').find('button').contains('Dismiss selected').first().click()
-    cy.contains('Confirm')
-    cy.get('.modal')
-      .contains('button', 'Dismiss')
-      .click()
-      .wait('@tasks')
-      .wait(2000)
-      .then(() => {
-        cy.get('tbody').find('tr:visible').should('not.exist')
-      })
-  })
-})

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

@@ -1,257 +0,0 @@
-{
-    "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": "correspondent-slug",
-            "name": "Correspondent Slug",
-            "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

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

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

@@ -1 +0,0 @@
-{"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/notes.json

@@ -1,26 +0,0 @@
-[
-    {
-        "id": 10,
-        "note": "Testing new note",
-        "created": "2022-08-08T04:24:55.176008Z",
-        "user": 3
-    },
-    {
-        "id": 9,
-        "note": "Testing one more time",
-        "created": "2022-02-18T04:24:55.176008Z",
-        "user": 15
-    },
-    {
-        "id": 8,
-        "note": "Another note",
-        "created": "2021-11-08T04:24:47.925042Z",
-        "user": 3
-    },
-    {
-        "id": 7,
-        "note": "Cupcake ipsum dolor sit amet cheesecake candy cookie tiramisu. Donut chocolate chupa chups macaroon brownie halvah pie cheesecake gummies. Sweet chocolate bar candy donut gummi bears bear claw liquorice bonbon shortbread.\n\nDonut chocolate bar candy wafer wafer tiramisu. Gummies chocolate cake muffin toffee carrot cake macaroon. Toffee toffee jelly beans danish lollipop cake.",
-        "created": "2021-02-08T02:37:49.724132Z",
-        "user": 3
-    }
-]

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

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

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

@@ -1,206 +0,0 @@
-{
-    "count": 3,
-    "next": null,
-    "previous": null,
-    "results": [
-        {
-            "id": 1,
-            "correspondent": 9,
-            "document_type": 1,
-            "storage_path": null,
-            "title": "No latin title",
-            "content": "Test document PDF \n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla est purus, ultrices in porttitor \nin, accumsan non quam. Nam consectetur porttitor rhoncus. Curabitur eu est et leo feugiat \nauctor vel quis lorem. Ut et ligula dolor, sit amet consequat lorem. Aliquam porta eros sed \nvelit imperdiet egestas. Maecenas tempus eros ut diam ullamcorper id dictum libero \ntempor. Donec quis augue quis magna condimentum lobortis. Quisque imperdiet ipsum vel \nmagna viverra rutrum. Cras viverra molestie urna, vitae vestibulum turpis varius id. \nVestibulum mollis, arcu iaculis bibendum varius, velit sapien blandit metus, ac posuere lorem \nnulla ac dolor. Maecenas urna elit, tincidunt in dapibus nec, vehicula eu dui. Duis lacinia \nfringilla massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur \nridiculus mus. Ut consequat ultricies est, non rhoncus mauris congue porta. Vivamus viverra \nsuscipit felis eget condimentum. Cum sociis natoque penatibus et magnis dis parturient \nmontes, nascetur ridiculus mus. Integer bibendum sagittis ligula, non faucibus nulla volutpat \nvitae. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. \nIn aliquet quam et velit bibendum accumsan. Cum sociis natoque penatibus et magnis dis \nparturient montes, nascetur ridiculus mus. Vestibulum vitae ipsum nec arcu semper \nadipiscing at ac lacus. Praesent id pellentesque orci. Morbi congue viverra nisl nec rhoncus. \nInteger mattis, ipsum a tincidunt commodo, lacus arcu elementum elit, at mollis eros ante ac \nrisus. In volutpat, ante at pretium ultricies, velit magna suscipit enim, aliquet blandit massa \norci nec lorem. Nulla facilisi. Duis eu vehicula arcu. Nulla facilisi. Maecenas pellentesque \nvolutpat felis, quis tristique ligula luctus vel. Sed nec mi eros. Integer augue enim, sollicitudin \nullamcorper mattis eget, aliquam in est. Morbi sollicitudin libero nec augue dignissim ut \nconsectetur dui volutpat. Nulla facilisi. Mauris egestas vestibulum neque cursus tincidunt. \nDonec sit amet pulvinar orci. \nQuisque volutpat pharetra tincidunt. Fusce sapien arcu, molestie eget varius egestas, \nfaucibus ac urna. Sed at nisi in velit egestas aliquam ut a felis. Aenean malesuada iaculis nisl, \nut tempor lacus egestas consequat. Nam nibh lectus, gravida sed egestas ut, feugiat quis \ndolor. Donec eu leo enim, non laoreet ante. Morbi dictum tempor vulputate. Phasellus \nultricies risus vel augue sagittis euismod. Vivamus tincidunt placerat nisi in aliquam. Cras \nquis mi ac nunc pretium aliquam. Aenean elementum erat ac metus commodo rhoncus. \nAliquam nulla augue, porta non sagittis quis, accumsan vitae sem. Phasellus id lectus tortor, \neget pulvinar augue. Etiam eget velit ac purus fringilla blandit. Donec odio odio, sagittis sed \niaculis sed, consectetur eget sem. Lorem ipsum dolor sit amet, consectetur adipiscing elit. \nMaecenas accumsan velit vel turpis rutrum in sodales diam placerat. \nQuisque luctus ullamcorper velit sit amet lobortis. Etiam ligula felis, vulputate quis rhoncus \nnec, fermentum eget odio. Vivamus vel ipsum ac augue sodales mollis euismod nec tellus. \nFusce et augue rutrum nunc semper vehicula vel semper nisl. Nam laoreet euismod quam at \nvarius. Sed aliquet auctor nibh. Curabitur malesuada fermentum lacus vel accumsan. Duis \nornare scelerisque nulla, ac pulvinar ligula tempus sit amet. In placerat nulla ac ante \nscelerisque posuere. Phasellus at ante felis. Sed hendrerit risus a metus posuere rutrum. \nPhasellus eu augue dui. Proin in vestibulum ipsum. Aenean accumsan mollis sapien, ut \neleifend sem blandit at. Vivamus luctus mi eget lorem lobortis pharetra. Phasellus at tortor \nquam, a volutpat purus. Etiam sollicitudin arcu vel elit bibendum et imperdiet risus tincidunt. \nEtiam elit velit, posuere ut pulvinar ac, condimentum eget justo. Fusce a erat velit. Vivamus \nimperdiet ultrices orci in hendrerit.",
-            "tags": [
-                4
-            ],
-            "created": "2022-03-22T07:24:18Z",
-            "created_date": "2022-03-22",
-            "modified": "2022-03-22T07:24:23.264859Z",
-            "added": "2022-03-22T07:24:22.922631Z",
-            "archive_serial_number": null,
-            "original_file_name": "2022-03-22 no latin title.pdf",
-            "archived_file_name": "2022-03-22 no latin title.pdf",
-            "owner": null,
-            "user_can_change": true,
-            "permissions": {
-                "view": {
-                    "users": [],
-                    "groups": []
-                },
-                "change": {
-                    "users": [],
-                    "groups": []
-                }
-            },
-            "notes": [
-                {
-                    "id": 9,
-                    "note": "Testing one more time",
-                    "created": "2022-02-18T04:24:55.176008Z",
-                    "user": 15
-                },
-                {
-                    "id": 8,
-                    "note": "Another note",
-                    "created": "2021-11-08T04:24:47.925042Z",
-                    "user": 3
-                },
-                {
-                    "id": 7,
-                    "note": "Cupcake ipsum dolor sit amet cheesecake candy cookie tiramisu. Donut chocolate chupa chups macaroon brownie halvah pie cheesecake gummies. Sweet chocolate bar candy donut gummi bears bear claw liquorice bonbon shortbread.\n\nDonut chocolate bar candy wafer wafer tiramisu. Gummies chocolate cake muffin toffee carrot cake macaroon. Toffee toffee jelly beans danish lollipop cake.",
-                    "created": "2021-02-08T02:37:49.724132Z",
-                    "user": 3
-                }
-            ]
-        },
-        {
-            "id": 2,
-            "correspondent": null,
-            "document_type": null,
-            "storage_path": 2,
-            "title": "lorem ipsum dolor sit amet",
-            "content": "Test document PDF",
-            "tags": [],
-            "created": "2022-03-23T07:24:18Z",
-            "created_date": "2022-03-23",
-            "modified": "2022-03-23T07:24:23.264859Z",
-            "added": "2022-03-23T07:24:22.922631Z",
-            "archive_serial_number": 12345,
-            "original_file_name": "2022-03-23 lorem ipsum dolor sit amet.pdf",
-            "archived_file_name": "2022-03-23 llorem ipsum dolor sit amet.pdf",
-            "owner": null,
-            "user_can_change": true,
-            "permissions": {
-                "view": {
-                    "users": [],
-                    "groups": []
-                },
-                "change": {
-                    "users": [],
-                    "groups": []
-                }
-            },
-            "notes": []
-        },
-        {
-            "id": 3,
-            "correspondent": 14,
-            "document_type": 1,
-            "storage_path": null,
-            "title": "dolor",
-            "content": "Test document PDF",
-            "tags": [
-                2
-            ],
-            "created": "2022-03-24T07:24:18Z",
-            "created_date": "2022-03-24",
-            "modified": "2022-03-24T07:24:23.264859Z",
-            "added": "2022-03-24T07:24:22.922631Z",
-            "archive_serial_number": null,
-            "original_file_name": "2022-03-24 dolor.pdf",
-            "archived_file_name": "2022-03-24 dolor.pdf",
-            "owner": null,
-            "user_can_change": true,
-            "permissions": {
-                "view": {
-                    "users": [],
-                    "groups": []
-                },
-                "change": {
-                    "users": [],
-                    "groups": []
-                }
-            },
-            "notes": []
-        },
-        {
-            "id": 4,
-            "correspondent": 9,
-            "document_type": 2,
-            "storage_path": null,
-            "title": "sit amet",
-            "content": "Test document PDF",
-            "tags": [
-                4, 5
-            ],
-            "created": "2022-06-01T07:24:18Z",
-            "created_date": "2022-06-01",
-            "modified": "2022-06-01T07:24:23.264859Z",
-            "added": "2022-06-01T07:24:22.922631Z",
-            "archive_serial_number": 12347,
-            "original_file_name": "2022-06-01 sit amet.pdf",
-            "archived_file_name": "2022-06-01 sit amet.pdf",
-            "owner": null,
-            "user_can_change": true,
-            "permissions": {
-                "view": {
-                    "users": [],
-                    "groups": []
-                },
-                "change": {
-                    "users": [],
-                    "groups": []
-                }
-            },
-            "notes": []
-        },
-        {
-            "id": 5,
-            "correspondent": null,
-            "document_type": null,
-            "storage_path": null,
-            "title": "Doc 5",
-            "content": "Test document 5",
-            "tags": [],
-            "created": "2023-05-01T07:24:18Z",
-            "created_date": "2023-05-02",
-            "modified": "2023-05-02T07:24:23.264859Z",
-            "added": "2023-05-02T07:24:22.922631Z",
-            "archive_serial_number": null,
-            "original_file_name": "doc5.pdf",
-            "archived_file_name": "doc5.pdf",
-            "owner": 15,
-            "user_can_change": true,
-            "permissions": {
-                "view": {
-                    "users": [1],
-                    "groups": []
-                },
-                "change": {
-                    "users": [],
-                    "groups": []
-                }
-            },
-            "notes": []
-        },
-        {
-            "id": 6,
-            "correspondent": null,
-            "document_type": null,
-            "storage_path": null,
-            "title": "Doc 6",
-            "content": "Test document 6",
-            "tags": [],
-            "created": "2023-05-01T10:24:18Z",
-            "created_date": "2023-05-02",
-            "modified": "2023-05-02T10:24:23.264859Z",
-            "added": "2023-05-02T10:24:22.922631Z",
-            "archive_serial_number": null,
-            "original_file_name": "doc6.pdf",
-            "archived_file_name": "doc6.pdf",
-            "owner": 6,
-            "user_can_change": true,
-            "permissions": {
-                "view": {
-                    "users": [1],
-                    "groups": []
-                },
-                "change": {
-                    "users": [],
-                    "groups": []
-                }
-            },
-            "notes": []
-        }
-    ]
-}

src-ui/cypress/fixtures/documents/selection_data.json

@@ -1,293 +0,0 @@
-{
-    "selected_correspondents": [
-        {
-            "id": 62,
-            "document_count": 0
-        },
-        {
-            "id": 75,
-            "document_count": 0
-        },
-        {
-            "id": 55,
-            "document_count": 0
-        },
-        {
-            "id": 56,
-            "document_count": 0
-        },
-        {
-            "id": 73,
-            "document_count": 0
-        },
-        {
-            "id": 58,
-            "document_count": 0
-        },
-        {
-            "id": 44,
-            "document_count": 0
-        },
-        {
-            "id": 42,
-            "document_count": 0
-        },
-        {
-            "id": 74,
-            "document_count": 0
-        },
-        {
-            "id": 54,
-            "document_count": 0
-        },
-        {
-            "id": 29,
-            "document_count": 0
-        },
-        {
-            "id": 71,
-            "document_count": 0
-        },
-        {
-            "id": 68,
-            "document_count": 0
-        },
-        {
-            "id": 82,
-            "document_count": 0
-        },
-        {
-            "id": 34,
-            "document_count": 0
-        },
-        {
-            "id": 41,
-            "document_count": 0
-        },
-        {
-            "id": 51,
-            "document_count": 0
-        },
-        {
-            "id": 46,
-            "document_count": 0
-        },
-        {
-            "id": 40,
-            "document_count": 0
-        },
-        {
-            "id": 43,
-            "document_count": 0
-        },
-        {
-            "id": 80,
-            "document_count": 0
-        },
-        {
-            "id": 70,
-            "document_count": 0
-        },
-        {
-            "id": 52,
-            "document_count": 0
-        },
-        {
-            "id": 67,
-            "document_count": 0
-        },
-        {
-            "id": 53,
-            "document_count": 0
-        },
-        {
-            "id": 32,
-            "document_count": 0
-        },
-        {
-            "id": 63,
-            "document_count": 0
-        },
-        {
-            "id": 35,
-            "document_count": 0
-        },
-        {
-            "id": 45,
-            "document_count": 0
-        },
-        {
-            "id": 38,
-            "document_count": 0
-        },
-        {
-            "id": 79,
-            "document_count": 0
-        },
-        {
-            "id": 48,
-            "document_count": 0
-        },
-        {
-            "id": 72,
-            "document_count": 0
-        },
-        {
-            "id": 78,
-            "document_count": 0
-        },
-        {
-            "id": 39,
-            "document_count": 0
-        },
-        {
-            "id": 57,
-            "document_count": 0
-        },
-        {
-            "id": 61,
-            "document_count": 0
-        },
-        {
-            "id": 81,
-            "document_count": 0
-        },
-        {
-            "id": 77,
-            "document_count": 0
-        },
-        {
-            "id": 69,
-            "document_count": 0
-        },
-        {
-            "id": 36,
-            "document_count": 3
-        },
-        {
-            "id": 31,
-            "document_count": 0
-        },
-        {
-            "id": 30,
-            "document_count": 0
-        },
-        {
-            "id": 50,
-            "document_count": 0
-        },
-        {
-            "id": 49,
-            "document_count": 0
-        },
-        {
-            "id": 60,
-            "document_count": 0
-        },
-        {
-            "id": 47,
-            "document_count": 0
-        },
-        {
-            "id": 66,
-            "document_count": 0
-        },
-        {
-            "id": 37,
-            "document_count": 0
-        },
-        {
-            "id": 28,
-            "document_count": 0
-        },
-        {
-            "id": 59,
-            "document_count": 0
-        },
-        {
-            "id": 33,
-            "document_count": 0
-        },
-        {
-            "id": 76,
-            "document_count": 0
-        }
-    ],
-    "selected_tags": [
-        {
-            "id": 4,
-            "document_count": 2
-        },
-        {
-            "id": 7,
-            "document_count": 0
-        },
-        {
-            "id": 5,
-            "document_count": 1
-        },
-        {
-            "id": 6,
-            "document_count": 0
-        },
-        {
-            "id": 3,
-            "document_count": 0
-        },
-        {
-            "id": 2,
-            "document_count": 1
-        },
-        {
-            "id": 1,
-            "document_count": 0
-        },
-        {
-            "id": 8,
-            "document_count": 0
-        }
-    ],
-    "selected_document_types": [
-        {
-            "id": 4,
-            "document_count": 0
-        },
-        {
-            "id": 10,
-            "document_count": 0
-        },
-        {
-            "id": 2,
-            "document_count": 0
-        },
-        {
-            "id": 11,
-            "document_count": 0
-        },
-        {
-            "id": 9,
-            "document_count": 0
-        },
-        {
-            "id": 7,
-            "document_count": 2
-        },
-        {
-            "id": 3,
-            "document_count": 0
-        },
-        {
-            "id": 1,
-            "document_count": 0
-        },
-        {
-            "id": 5,
-            "document_count": 0
-        },
-        {
-            "id": 8,
-            "document_count": 1
-        }
-    ],
-    "selected_storage_paths": []
-}

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

@@ -1,119 +0,0 @@
-{
-    "count": 2,
-    "next": null,
-    "previous": null,
-    "results": [
-        {
-            "id": 6,
-            "name": "Another Group",
-            "permissions": [
-                "add_user",
-                "change_user",
-                "delete_user",
-                "view_user",
-                "add_note",
-                "change_note",
-                "delete_note",
-                "view_note"
-            ]
-        },
-        {
-            "id": 1,
-            "name": "First Group",
-            "permissions": [
-                "add_group",
-                "change_group",
-                "delete_group",
-                "view_group",
-                "add_permission",
-                "change_permission",
-                "delete_permission",
-                "view_permission",
-                "add_token",
-                "change_token",
-                "delete_token",
-                "view_token",
-                "add_tokenproxy",
-                "change_tokenproxy",
-                "delete_tokenproxy",
-                "view_tokenproxy",
-                "add_contenttype",
-                "change_contenttype",
-                "delete_contenttype",
-                "view_contenttype",
-                "add_chordcounter",
-                "change_chordcounter",
-                "delete_chordcounter",
-                "view_chordcounter",
-                "add_groupresult",
-                "change_groupresult",
-                "delete_groupresult",
-                "view_groupresult",
-                "add_taskresult",
-                "change_taskresult",
-                "delete_taskresult",
-                "view_taskresult",
-                "add_failure",
-                "change_failure",
-                "delete_failure",
-                "view_failure",
-                "add_ormq",
-                "change_ormq",
-                "delete_ormq",
-                "view_ormq",
-                "add_schedule",
-                "change_schedule",
-                "delete_schedule",
-                "view_schedule",
-                "add_success",
-                "change_success",
-                "delete_success",
-                "view_success",
-                "add_task",
-                "change_task",
-                "delete_task",
-                "view_task",
-                "add_note",
-                "change_note",
-                "delete_note",
-                "view_note",
-                "add_correspondent",
-                "change_correspondent",
-                "delete_correspondent",
-                "view_correspondent",
-                "add_document",
-                "change_document",
-                "delete_document",
-                "view_document",
-                "add_documenttype",
-                "change_documenttype",
-                "delete_documenttype",
-                "view_documenttype",
-                "add_frontendsettings",
-                "change_frontendsettings",
-                "delete_frontendsettings",
-                "view_frontendsettings",
-                "add_log",
-                "change_log",
-                "delete_log",
-                "view_log",
-                "add_savedview",
-                "change_savedview",
-                "delete_savedview",
-                "view_savedview",
-                "add_savedviewfilterrule",
-                "change_savedviewfilterrule",
-                "delete_savedviewfilterrule",
-                "view_savedviewfilterrule",
-                "add_taskattributes",
-                "change_taskattributes",
-                "delete_taskattributes",
-                "view_taskattributes",
-                "add_session",
-                "change_session",
-                "delete_session",
-                "view_session"
-            ]
-        }
-    ]
-}

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

@@ -1,27 +0,0 @@
-{
-    "count": 2,
-    "next": null,
-    "previous": null,
-    "results": [
-        {
-            "id": 1,
-            "name": "IMAP Server",
-            "imap_server": "imap.example.com",
-            "imap_port": 993,
-            "imap_security": 2,
-            "username": "inbox@example.com",
-            "password": "pass",
-            "character_set": "UTF-8"
-        },
-        {
-            "id": 2,
-            "name": "Gmail",
-            "imap_server": "imap.gmail.com",
-            "imap_port": 993,
-            "imap_security": 2,
-            "username": "user@gmail.com",
-            "password": "pass",
-            "character_set": "UTF-8"
-        }
-    ]
-}

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

@@ -1,31 +0,0 @@
-{
-    "count": 1,
-    "next": null,
-    "previous": null,
-    "results": [
-        {
-            "id": 1,
-            "name": "Gmail",
-            "account": 2,
-            "folder": "INBOX",
-            "filter_from": null,
-            "filter_to": null,
-            "filter_subject": "[paperless]",
-            "filter_body": null,
-            "filter_attachment_filename": null,
-            "maximum_age": 30,
-            "action": 3,
-            "action_parameter": null,
-            "assign_title_from": 1,
-            "assign_tags": [
-                9
-            ],
-            "assign_correspondent_from": 1,
-            "assign_correspondent": 2,
-            "assign_document_type": null,
-            "order": 0,
-            "attachment_type": 2,
-            "consumption_scope": 1
-        }
-    ]
-}

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

@@ -1 +0,0 @@
-{"version":"v1.7.1","update_available":false,"feature_is_set":true}

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

@@ -1,44 +0,0 @@
-{
-    "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/storage_paths/storage_paths.json

@@ -1,17 +0,0 @@
-{
-    "count": 1,
-    "next": null,
-    "previous": null,
-    "results": [
-        {
-            "id": 2,
-            "slug": "year-title",
-            "name": "Year - Title",
-            "path": "{created_year}/{title}",
-            "match": "",
-            "matching_algorithm": 6,
-            "is_insensitive": true,
-            "document_count": 1
-        }
-    ]
-}

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

@@ -1,103 +0,0 @@
-{
-    "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/fixtures/tasks/tasks.json

@@ -1,142 +0,0 @@
-[
-    {
-        "id": 141,
-        "type": "file",
-        "result": "sample 2.pdf: Not consuming sample 2.pdf: It is a duplicate. : Traceback (most recent call last):\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ngx.nosync-udqDZzaE/lib/python3.8/site-packages/django_q/cluster.py\", line 432, in worker\n    res = f(*task[\"args\"], **task[\"kwargs\"])\n  File \"/Users/admin/Documents/paperless-ngx/src/documents/tasks.py\", line 316, in consume_file\n    document = Consumer().try_consume_file(\n  File \"/Users/admin/Documents/paperless-ngx/src/documents/consumer.py\", line 218, in try_consume_file\n    self.pre_check_duplicate()\n  File \"/Users/admin/Documents/paperless-ngx/src/documents/consumer.py\", line 113, in pre_check_duplicate\n    self._fail(\n  File \"/Users/admin/Documents/paperless-ngx/src/documents/consumer.py\", line 84, in _fail\n    raise ConsumerError(f\"{self.filename}: {log_message or message}\")\ndocuments.consumer.ConsumerError: sample 2.pdf: Not consuming sample 2.pdf: It is a duplicate.\n",
-        "status": "FAILURE",
-        "task_id": "d8ddbe298a42427d82553206ddf0bc94",
-        "task_file_name": "sample 2.pdf",
-        "date_created": "2022-05-26T23:17:38.333474-07:00",
-        "date_done": null,
-        "acknowledged": false,
-        "related_document": null
-    },
-    {
-        "id": 132,
-        "type": "file",
-        "result": " : Traceback (most recent call last):\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/ocrmypdf/subprocess.py\", line 131, in get_version\n    env=env,\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/ocrmypdf/subprocess.py\", line 68, in run\n    proc = subprocess_run(args, env=env, **kwargs)\n  File \"/Users/admin/opt/anaconda3/envs/paperless-ng/lib/python3.6/subprocess.py\", line 423, in run\n    with Popen(*popenargs, **kwargs) as process:\n  File \"/Users/admin/opt/anaconda3/envs/paperless-ng/lib/python3.6/subprocess.py\", line 729, in __init__\n    restore_signals, start_new_session)\n  File \"/Users/admin/opt/anaconda3/envs/paperless-ng/lib/python3.6/subprocess.py\", line 1364, in _execute_child\n    raise child_exception_type(errno_num, err_msg, err_filename)\nFileNotFoundError: [Errno 2] No such file or directory: 'unpaper': 'unpaper'\n\nThe above exception was the direct cause of the following exception:\n\nTraceback (most recent call last):\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/ocrmypdf/subprocess.py\", line 287, in check_external_program\n    found_version = version_checker()\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/ocrmypdf/_exec/unpaper.py\", line 34, in version\n    return get_version('unpaper')\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/ocrmypdf/subprocess.py\", line 137, in get_version\n    ) from e\nocrmypdf.exceptions.MissingDependencyError: Could not find program 'unpaper' on the PATH\n\nDuring handling of the above exception, another exception occurred:\n\nTraceback (most recent call last):\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/paperless_tesseract/parsers.py\", line 176, in parse\n    ocrmypdf.ocr(**ocr_args)\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/ocrmypdf/api.py\", line 315, in ocr\n    check_options(options, plugin_manager)\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/ocrmypdf/_validation.py\", line 260, in check_options\n    _check_options(options, plugin_manager, ocr_engine_languages)\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/ocrmypdf/_validation.py\", line 250, in _check_options\n    check_options_preprocessing(options)\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/ocrmypdf/_validation.py\", line 128, in check_options_preprocessing\n    required_for=['--clean, --clean-final'],\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/ocrmypdf/subprocess.py\", line 293, in check_external_program\n    raise MissingDependencyError()\nocrmypdf.exceptions.MissingDependencyError\n\nDuring handling of the above exception, another exception occurred:\n\nTraceback (most recent call last):\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/documents/consumer.py\", line 179, in try_consume_file\n    document_parser.parse(self.path, mime_type, self.filename)\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/paperless_tesseract/parsers.py\", line 197, in parse\n    raise ParseError(e)\ndocuments.parsers.ParseError\n\nDuring handling of the above exception, another exception occurred:\n\nTraceback (most recent call last):\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/django_q/cluster.py\", line 436, in worker\n    res = f(*task[\"args\"], **task[\"kwargs\"])\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/documents/tasks.py\", line 73, in consume_file\n    override_tag_ids=override_tag_ids)\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/documents/consumer.py\", line 196, in try_consume_file\n    raise ConsumerError(e)\ndocuments.consumer.ConsumerError\n",
-        "status": "FAILURE",
-        "task_id": "4c554075552c4cc985abd76e6f274c90",
-        "task_file_name": "pdf-sample 10.24.48 PM.pdf",
-        "date_created": "2022-05-26T14:26:07.846365-07:00",
-        "date_done": null,
-        "acknowledged": null
-    },
-    {
-        "id": 115,
-        "type": "file",
-        "result": "2021-01-24 2021-01-20 sample_wide_orange.pdf: Document is a duplicate : Traceback (most recent call last):\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/django_q/cluster.py\", line 436, in worker\n    res = f(*task[\"args\"], **task[\"kwargs\"])\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/documents/tasks.py\", line 75, in consume_file\n    task_id=task_id\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/documents/consumer.py\", line 168, in try_consume_file\n    self.pre_check_duplicate()\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/documents/consumer.py\", line 85, in pre_check_duplicate\n    self._fail(\"Document is a duplicate\")\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/documents/consumer.py\", line 53, in _fail\n    raise ConsumerError(f\"{self.filename}: {message}\")\ndocuments.consumer.ConsumerError: 2021-01-24 2021-01-20 sample_wide_orange.pdf: Document is a duplicate\n",
-        "status": "FAILURE",
-        "task_id": "86494713646a4364b01da17aadca071d",
-        "task_file_name": "2021-01-24 2021-01-20 sample_wide_orange.pdf",
-        "date_created": "2022-05-26T14:26:07.817608-07:00",
-        "date_done": null,
-        "acknowledged": null
-    },
-    {
-        "id": 85,
-        "type": "file",
-        "result": "cannot open resource : Traceback (most recent call last):\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/django_q/cluster.py\", line 436, in worker\n    res = f(*task[\"args\"], **task[\"kwargs\"])\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/documents/tasks.py\", line 81, in consume_file\n    task_id=task_id\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/documents/consumer.py\", line 244, in try_consume_file\n    self.path, mime_type, self.filename)\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/documents/parsers.py\", line 302, in get_optimised_thumbnail\n    thumbnail = self.get_thumbnail(document_path, mime_type, file_name)\n  File \"/Users/admin/Documents/Work/Contributions/paperless-ng/src/paperless_text/parsers.py\", line 29, in get_thumbnail\n    layout_engine=ImageFont.LAYOUT_BASIC)\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/PIL/ImageFont.py\", line 852, in truetype\n    return freetype(font)\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/PIL/ImageFont.py\", line 849, in freetype\n    return FreeTypeFont(font, size, index, encoding, layout_engine)\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ng/lib/python3.6/site-packages/PIL/ImageFont.py\", line 210, in __init__\n    font, size, index, encoding, layout_engine=layout_engine\nOSError: cannot open resource\n",
-        "status": "FAILURE",
-        "task_id": "abca803fa46342e1ac81f3d3f2080e79",
-        "task_file_name": "simple.txt",
-        "date_created": "2022-05-26T14:26:07.771541-07:00",
-        "date_done": null,
-        "acknowledged": null
-    },
-    {
-        "id": 41,
-        "type": "file",
-        "result": "commands.txt: Not consuming commands.txt: It is a duplicate. : Traceback (most recent call last):\n  File \"/Users/admin/.local/share/virtualenvs/paperless-ngx.nosync-udqDZzaE/lib/python3.8/site-packages/django_q/cluster.py\", line 432, in worker\n    res = f(*task[\"args\"], **task[\"kwargs\"])\n  File \"/Users/admin/Documents/paperless-ngx/src/documents/tasks.py\", line 70, in consume_file\n    document = Consumer().try_consume_file(\n  File \"/Users/admin/Documents/paperless-ngx/src/documents/consumer.py\", line 199, in try_consume_file\n    self.pre_check_duplicate()\n  File \"/Users/admin/Documents/paperless-ngx/src/documents/consumer.py\", line 97, in pre_check_duplicate\n    self._fail(\n  File \"/Users/admin/Documents/paperless-ngx/src/documents/consumer.py\", line 69, in _fail\n    raise ConsumerError(f\"{self.filename}: {log_message or message}\")\ndocuments.consumer.ConsumerError: commands.txt: Not consuming commands.txt: It is a duplicate.\n",
-        "status": "FAILURE",
-        "task_id": "0af67672e8e14404b060d4cf8f69313d",
-        "task_file_name": "commands.txt",
-        "date_created": "2022-05-26T14:26:07.704247-07:00",
-        "date_done": null,
-        "acknowledged": null
-    },
-    {
-        "id": 10,
-        "type": "file",
-        "result": "Success. New document id 260 created",
-        "status": "SUCCESS",
-        "task_id": "b7629a0f41bd40c7a3ea4680341321b5",
-        "task_file_name": "2022-03-24+Sonstige+ScanPC2022-03-24_081058.pdf",
-        "date_created": "2022-05-26T14:26:07.670577-07:00",
-        "date_done": "2022-05-26T14:26:07.670577-07:00",
-        "acknowledged": false,
-        "related_document": 260
-    },
-    {
-        "id": 9,
-        "type": "file",
-        "result": "Success. New document id 261 created",
-        "status": "SUCCESS",
-        "task_id": "02e276a86a424ccfb83309df5d8594be",
-        "task_file_name": "2sample-pdf-with-images.pdf",
-        "date_created": "2022-05-26T14:26:07.668987-07:00",
-        "date_done": "2022-05-26T14:26:07.668987-07:00",
-        "acknowledged": false,
-        "related_document": 261
-    },
-    {
-        "id": 8,
-        "type": "file",
-        "result": "Success. New document id 262 created",
-        "status": "SUCCESS",
-        "task_id": "41229b8be9b445c0a523697d0f58f13e",
-        "task_file_name": "2sample-pdf-with-images_pw.pdf",
-        "date_created": "2022-05-26T14:26:07.667993-07:00",
-        "date_done": "2022-05-26T14:26:07.667993-07:00",
-        "acknowledged": false,
-        "related_document": 262
-    },
-    {
-        "id": 6,
-        "type": "file",
-        "result": "Success. New document id 264 created",
-        "status": "SUCCESS",
-        "task_id": "bbbca32d408c4619bd0b512a8327c773",
-        "task_file_name": "homebridge.log",
-        "date_created": "2022-05-26T14:26:07.665560-07:00",
-        "date_done": "2022-05-26T14:26:07.665560-07:00",
-        "acknowledged": false,
-        "related_document": 264
-    },
-    {
-        "id": 5,
-        "type": "file",
-        "result": "Success. New document id 265 created",
-        "status": "SUCCESS",
-        "task_id": "00ab285ab4bf482ab30c7d580b252ecb",
-        "task_file_name": "IMG_7459.PNG",
-        "date_created": "2022-05-26T14:26:07.664506-07:00",
-        "date_done": "2022-05-26T14:26:07.664506-07:00",
-        "acknowledged": false,
-        "related_document": 265
-    },
-    {
-        "id": 3,
-        "type": "file",
-        "result": "Success. New document id 267 created",
-        "status": "SUCCESS",
-        "task_id": "289c5163cfec410db42948a0cacbeb9c",
-        "task_file_name": "IMG_7459.PNG",
-        "date_created": "2022-05-26T14:26:07.659661-07:00",
-        "date_done": "2022-05-26T14:26:07.659661-07:00",
-        "acknowledged": false,
-        "related_document": 267
-    },
-    {
-        "id": 1,
-        "type": "file",
-        "result": null,
-        "status": "STARTED",
-        "task_id": "7a4ebdb2bde04311935284027ef8ca65",
-        "task_file_name": "2019-08-04 DSA Questionnaire - 5-8-19.pdf",
-        "date_created": "2022-05-26T14:26:07.655276-07:00",
-        "date_done": null,
-        "acknowledged": false,
-        "related_document": null
-    }
-]