Basic RTL tweaks

.codecov.yml

@@ -14,9 +14,6 @@ flag_management:
 # codecov will only comment if coverage changes
 comment:
   require_changes: true
-  # https://docs.codecov.com/docs/javascript-bundle-analysis
-  require_bundle_changes: true
-  bundle_change_threshold: "50Kb"
 coverage:
   status:
     project:
@@ -25,12 +22,7 @@ coverage:
         threshold: 1%
     patch:
       default:
-        # For the changed lines only, target 100% covered, but
-        # allow as low as 75%
-        target: 100%
+        # For the changed lines only, target 75% covered, but
+        # allow as low as 50%
+        target: 75%
         threshold: 25%
-# https://docs.codecov.com/docs/javascript-bundle-analysis
-bundle_analysis:
-  # Fail if the bundle size increases by more than 1MB
-  warning_threshold: "1MB"
-  status: true

.codespellrc

@@ -1,3 +1,3 @@
 [codespell]
 write-changes = True
-ignore-words-list = criterias,afterall,valeu,ureue,equest,ure,assertIn
+ignore-words-list = criterias,afterall,valeu,ureue,equest,ure

.devcontainer/Dockerfile

@@ -1,180 +0,0 @@
-# syntax=docker/dockerfile:1
-
-FROM --platform=$BUILDPLATFORM docker.io/node:20-bookworm-slim as main-app
-
-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.9.0
-ARG GS_VERSION=10.03.1
-
-# Set Python environment variables
-ENV PYTHONDONTWRITEBYTECODE=1 \
-    PYTHONUNBUFFERED=1 \
-    # Ignore warning from Whitenoise
-    PYTHONWARNINGS="ignore:::django.http.response:517" \
-    PNGX_CONTAINERIZED=1
-
-#
-# Begin installation and configuration
-# Order the steps below from least often changed to most
-#
-
-# Packages need for running
-ARG RUNTIME_PACKAGES="\
-  # General utils
-  curl \
-  # Docker specific
-  gosu \
-  # Timezones support
-  tzdata \
-  # fonts for text file thumbnail generation
-  fonts-liberation \
-  gettext \
-  ghostscript \
-  gnupg \
-  icc-profiles-free \
-  imagemagick \
-  # PostgreSQL
-  postgresql-client \
-  # MySQL / MariaDB
-  mariadb-client \
-  # OCRmyPDF dependencies
-  tesseract-ocr \
-  tesseract-ocr-eng \
-  tesseract-ocr-deu \
-  tesseract-ocr-fra \
-  tesseract-ocr-ita \
-  tesseract-ocr-spa \
-  unpaper \
-  pngquant \
-  jbig2dec \
-  # lxml
-  libxml2 \
-  libxslt1.1 \
-  # itself
-  qpdf \
-  # Mime type detection
-  file \
-  libmagic1 \
-  media-types \
-  zlib1g \
-  # Barcode splitter
-  libzbar0 \
-  poppler-utils \
-  htop \
-  sudo"
-
-# Install basic runtime packages.
-# These change very infrequently
-RUN set -eux \
-  echo "Installing system packages" \
-    && apt-get update \
-    && apt-get install --yes --quiet --no-install-recommends ${RUNTIME_PACKAGES}
-
-ARG PYTHON_PACKAGES="\
-  python3 \
-  python3-pip \
-  python3-wheel \
-  pipenv \
-  ca-certificates"
-
-RUN set -eux \
-  echo "Installing python packages" \
-    && apt-get update \
-    && apt-get install --yes --quiet ${PYTHON_PACKAGES}
-
-RUN set -eux \
-  && 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-1_${TARGETARCH}.deb \
-          https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/libgs10_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
-      && curl --fail --silent --show-error --location \
-          --output ghostscript_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
-          https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/ghostscript_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
-      && curl --fail --silent --show-error --location \
-          --output libgs10-common_${GS_VERSION}.dfsg-1_all.deb \
-          https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/libgs10-common_${GS_VERSION}.dfsg-1_all.deb \
-        && dpkg --install ./libgs10-common_${GS_VERSION}.dfsg-1_all.deb \
-        && dpkg --install ./libgs10_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
-        && dpkg --install ./ghostscript_${GS_VERSION}.dfsg-1_${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
-
-# setup docker-specific things
-# These change sometimes, but rarely
-WORKDIR /usr/src/paperless/src/docker/
-
-COPY [ \
-  "docker/imagemagick-policy.xml", \
-  "./" \
-]
-
-RUN set -eux \
-  && echo "Configuring ImageMagick" \
-    && mv imagemagick-policy.xml /etc/ImageMagick-6/policy.xml
-
-# Packages needed only for building a few quick Python
-# dependencies
-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 \
-  pkg-config \
-  pre-commit"
-
-# 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 ${BUILD_PACKAGES}
-
-RUN set -eux \
-  && npm update npm -g
-
-# add users, setup scripts
-# Mount the compiled frontend to expected location
-RUN set -eux \
-  && echo "Setting up user/group" \
-    && groupmod --new-name paperless node \
-    && usermod --login paperless --home /usr/src/paperless node \
-    && usermod -s /bin/bash paperless \
-    && echo "paperless ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers \
-  && echo "Creating volume directories" \
-    && mkdir --parents --verbose /usr/src/paperless/paperless-ngx/data \
-    && mkdir --parents --verbose /usr/src/paperless/paperless-ngx/media \
-    && mkdir --parents --verbose /usr/src/paperless/paperless-ngx/consume \
-    && mkdir --parents --verbose /usr/src/paperless/paperless-ngx/export \
-    && mkdir --parents --verbose /usr/src/paperless/paperless-ngx/.venv \
-  && 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
-
-VOLUME ["/usr/src/paperless/paperless-ngx/data", \
-        "/usr/src/paperless/paperless-ngx/media", \
-        "/usr/src/paperless/paperless-ngx/consume", \
-        "/usr/src/paperless/paperless-ngx/export", \
-        "/usr/src/paperless/paperless-ngx/.venv"]

.devcontainer/devcontainer.json

@@ -1,28 +0,0 @@
-{
-    "name": "Paperless Development",
-    "dockerComposeFile": "docker-compose.devcontainer.sqlite-tika.yml",
-    "service": "paperless-development",
-    "workspaceFolder": "/usr/src/paperless/paperless-ngx",
-    "postCreateCommand": "pipenv install --dev && pipenv run pre-commit install",
-    "customizations": {
-        "vscode": {
-          "extensions": [
-            "mhutchie.git-graph",
-            "ms-python.python",
-            "ms-vscode.js-debug-nightly",
-            "eamodio.gitlens",
-            "yzhang.markdown-all-in-one"
-          ],
-          "settings": {
-            "python.defaultInterpreterPath": "/usr/src/paperless/paperless-ngx/.venv/bin/python",
-            "python.pythonPath": "/usr/src/paperless/paperless-ngx/.venv/bin/python",
-            "python.terminal.activateEnvInCurrentTerminal": true,
-            "editor.formatOnPaste": false,
-            "editor.formatOnSave": true,
-            "editor.formatOnType": true,
-            "files.trimTrailingWhitespace": true
-          }
-        }
-      },
-      "remoteUser": "paperless"
-    }

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

@@ -1,83 +0,0 @@
-# Docker Compose file for developing Paperless NGX in VSCode DevContainers.
-# This file contains everything Paperless NGX needs to run.
-# Paperless supports amd64, arm, and arm64 hardware.
-# All compose files of Paperless configure it in the following way:
-#
-# - Paperless is (re)started on system boot if it was running before shutdown.
-# - Docker volumes for storing data are managed by Docker.
-# - Folders for importing and exporting files are created in the same directory
-#   as this file and mounted to the correct folders inside the container.
-# - Paperless listens on port 8000.
-#
-# SQLite is used as the database. The SQLite file is stored in the data volume.
-#
-# In addition, this Docker Compose file adds the following optional
-# configurations:
-#
-# - Apache Tika and Gotenberg servers are started with Paperless NGX and Paperless
-#   is configured to use these services. These provide support for consuming
-#   Office documents (Word, Excel, PowerPoint, and their LibreOffice counterparts).
-#
-# This file is intended only to be used through VSCOde devcontainers. See README.md
-# in the folder .devcontainer.
-
-
-services:
-  broker:
-    image: docker.io/library/redis:7
-    restart: unless-stopped
-    volumes:
-      - ./redisdata:/data
-
-  # No ports need to be exposed; the VSCode DevContainer plugin manages them.
-  paperless-development:
-    image: paperless-ngx
-    build:
-      context: ../    # Dockerfile cannot access files from parent directories if context is not set.
-      dockerfile: ./.devcontainer/Dockerfile
-    restart: unless-stopped
-    depends_on:
-      - broker
-      - gotenberg
-      - tika
-    volumes:
-      - ..:/usr/src/paperless/paperless-ngx:delegated
-      - ../.devcontainer/vscode:/usr/src/paperless/paperless-ngx/.vscode:delegated # VSCode config files
-      - pipenv:/usr/src/paperless/paperless-ngx/.venv
-      - /usr/src/paperless/paperless-ngx/src/documents/static/frontend # Static frontend files exist only in container
-      - /usr/src/paperless/paperless-ngx/src/.pytest_cache
-      - /usr/src/paperless/paperless-ngx/.ruff_cache
-      - /usr/src/paperless/paperless-ngx/htmlcov
-      - /usr/src/paperless/paperless-ngx/.coverage
-      - ./data:/usr/src/paperless/paperless-ngx/data
-      - ./media:/usr/src/paperless/paperless-ngx/media
-      - ./consume:/usr/src/paperless/paperless-ngx/consume
-      - ~/.gitconfig:/usr/src/paperless/.gitconfig:ro
-    environment:
-      PAPERLESS_REDIS: redis://broker:6379
-      PAPERLESS_TIKA_ENABLED: 1
-      PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
-      PAPERLESS_TIKA_ENDPOINT: http://tika:9998
-      PAPERLESS_STATICDIR: ./src/documents/static
-      PAPERLESS_DEBUG: true
-
-    # Overrides default command so things don't shut down after the process ends.
-    command: /bin/sh -c "chown -R paperless:paperless /usr/src/paperless/paperless-ngx/src/documents/static/frontend && chown -R paperless:paperless /usr/src/paperless/paperless-ngx/.ruff_cache && while sleep 1000; do :; done"
-
-  gotenberg:
-    image: docker.io/gotenberg/gotenberg:7.10
-    restart: unless-stopped
-
-    # The Gotenberg Chromium route is used to convert .eml files. We do not
-    # want to allow external content like tracking pixels or even JavaScript.
-    command:
-      - "gotenberg"
-      - "--chromium-disable-javascript=true"
-      - "--chromium-allow-list=file:///tmp/.*"
-
-  tika:
-    image: docker.io/apache/tika:latest
-    restart: unless-stopped
-
-volumes:
-  pipenv:

.devcontainer/vscode/launch.json

@@ -1,58 +0,0 @@
-{
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Chrome: Debug Angular Frontend",
-						"description": "Debug the Angular Dev Frontend in Chrome",
-            "type": "chrome",
-            "request": "launch",
-            "url": "http://localhost:4200",
-            "webRoot": "${workspaceFolder}/src-ui",
-            "preLaunchTask": "Start: Frontend Angular"
-        },
-        {
-            "name": "Debug: Backend Server (manage.py runserver)",
-						"description": "Debug the Django Backend Server",
-            "type": "python",
-            "request": "launch",
-            "program": "${workspaceFolder}/src/manage.py",
-            "args": [
-                "runserver"
-            ],
-            "django": true,
-            "console": "integratedTerminal",
-            "env": {
-                "PYTHONPATH": "${workspaceFolder}/src"
-            },
-            "python": "${workspaceFolder}/.venv/bin/python"
-        },
-        {
-            "name": "Debug: Consumer Service (manage.py document_consumer)",
-						"description": "Debug the Consumer Service which processes files from a directory",
-            "type": "python",
-            "request": "launch",
-            "program": "${workspaceFolder}/src/manage.py",
-            "args": [
-                "document_consumer"
-            ],
-            "django": true,
-            "console": "integratedTerminal",
-            "env": {
-                "PYTHONPATH": "${workspaceFolder}/src"
-            },
-            "python": "${workspaceFolder}/.venv/bin/python"
-        }
-    ],
-    "compounds": [
-        {
-            "name": "Debug: FullStack",
-						"description": "Debug run the Angular dev frontend, Django backend, and consumer service",
-            "configurations": [
-                "Chrome: Debug Angular Frontend",
-                "Debug: Backend Server (manage.py runserver)",
-                "Debug: Consumer Service (manage.py document_consumer)"
-            ],
-            "preLaunchTask": "Start: Celery Worker"
-        }
-    ]
-}

.devcontainer/vscode/settings.json

@@ -1,11 +0,0 @@
-{
-    "python.testing.pytestArgs": [
-        "src"
-    ],
-    "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true,
-    "files.watcherExclude": {
-        "**/.venv/**": true,
-        "**/pytest_cache/**": true
-    }
-}

.devcontainer/vscode/tasks.json

@@ -1,223 +0,0 @@
-{
-	"version": "2.0.0",
-	"tasks": [
-		{
-			"label": "Start: Celery Worker",
-			"description": "Start the Celery Worker which processes background and consume tasks",
-			"type": "shell",
-			"command": "pipenv run celery --app paperless worker -l DEBUG",
-			"isBackground": true,
-			"options": {
-				"cwd": "${workspaceFolder}/src"
-			},
-			"problemMatcher": [
-				{
-					"owner": "custom",
-					"pattern": [
-						{
-							"regexp": ".",
-							"file": 1,
-							"location": 2,
-							"message": 3
-						}
-					],
-					"background": {
-						"activeOnStart": true,
-						"beginsPattern": "celery.*",
-						"endsPattern": "ready"
-					}
-				}
-			]
-		},
-		{
-			"label": "Start: Frontend Angular",
-			"description": "Start the Frontend Angular Dev Server",
-			"type": "shell",
-			"command": "npm start",
-			"isBackground": true,
-			"options": {
-				"cwd": "${workspaceFolder}/src-ui"
-			},
-			"problemMatcher": [
-				{
-					"owner": "custom",
-					"pattern": [
-						{
-							"regexp": ".",
-							"file": 1,
-							"location": 2,
-							"message": 3
-						}
-					],
-					"background": {
-						"activeOnStart": true,
-						"beginsPattern": ".*",
-						"endsPattern": "Compiled successfully"
-					}
-				}
-			]
-		},
-		{
-			"label": "Start: Consumer Service (manage.py document_consumer)",
-			"description": "Start the Consumer Service which processes files from a directory",
-			"type": "shell",
-			"command": "pipenv run python manage.py document_consumer",
-			"group": "build",
-			"presentation": {
-				"echo": true,
-				"reveal": "always",
-				"focus": false,
-				"panel": "shared",
-				"showReuseMessage": false,
-				"clear": true,
-				"revealProblems": "onProblem"
-			},
-			"options": {
-				"cwd": "${workspaceFolder}/src"
-			}
-		},
-		{
-			"label": "Start: Backend Server (manage.py runserver)",
-			"description": "Start the Backend Server which serves the Django API and the compiled Angular frontend",
-			"type": "shell",
-			"command": "pipenv run python manage.py runserver",
-			"group": "build",
-			"presentation": {
-				"echo": true,
-				"reveal": "always",
-				"focus": false,
-				"panel": "shared",
-				"showReuseMessage": false,
-				"clear": true,
-				"revealProblems": "onProblem"
-			},
-			"options": {
-				"cwd": "${workspaceFolder}/src"
-			}
-		},
-		{
-			"label": "Maintenance: manage.py migrate",
-			"description": "Apply database migrations",
-			"type": "shell",
-			"command": "pipenv run python manage.py migrate",
-			"group": "none",
-			"presentation": {
-				"echo": true,
-				"reveal": "always",
-				"focus": true,
-				"panel": "shared",
-				"showReuseMessage": false,
-				"clear": true,
-				"revealProblems": "onProblem"
-			},
-			"options": {
-				"cwd": "${workspaceFolder}/src"
-			}
-		},
-		{
-			"label": "Maintenance: Build Documentation",
-			"description": "Build the documentation with MkDocs",
-			"type": "shell",
-			"command": "pipenv run mkdocs build --config-file mkdocs.yml && pipenv run mkdocs serve",
-			"group": "none",
-			"presentation": {
-				"echo": true,
-				"reveal": "always",
-				"focus": true,
-				"panel": "shared",
-				"showReuseMessage": false,
-				"clear": true,
-				"revealProblems": "onProblem"
-			},
-			"options": {
-				"cwd": "${workspaceFolder}"
-			}
-		},
-		{
-			"label": "Maintenance: manage.py createsuperuser",
-			"description": "Create a superuser",
-			"type": "shell",
-			"command": "pipenv run python manage.py createsuperuser",
-			"group": "none",
-			"presentation": {
-				"echo": true,
-				"reveal": "always",
-				"focus": true,
-				"panel": "shared",
-				"showReuseMessage": false,
-				"clear": true,
-				"revealProblems": "onProblem"
-			},
-			"options": {
-				"cwd": "${workspaceFolder}/src"
-			}
-		},
-		{
-			"label": "Maintenance: recreate .venv",
-			"description": "Recreate the python virtual environment and install python dependencies",
-			"type": "shell",
-			"command": "rm -R -v .venv/* || pipenv install --dev",
-			"group": "none",
-			"presentation": {
-				"echo": true,
-				"reveal": "always",
-				"focus": true,
-				"panel": "shared",
-				"showReuseMessage": false,
-				"clear": true,
-				"revealProblems": "onProblem"
-			},
-			"options": {
-				"cwd": "${workspaceFolder}"
-			}
-		},
-		{
-			"label": "Maintenance: Install Frontend Dependencies",
-			"description": "Install frontend (npm) dependencies",
-			"type": "npm",
-			"script": "install",
-			"path": "src-ui",
-			"group": "clean",
-			"problemMatcher": [],
-			"detail": "install dependencies from package"
-		},
-		{
-			"description": "Clean install frontend dependencies and build the frontend for production",
-			"label": "Maintenance: Compile frontend for production",
-			"type": "shell",
-			"command": "npm ci && ./node_modules/.bin/ng build --configuration production",
-			"group": "none",
-			"presentation": {
-				"echo": true,
-				"reveal": "always",
-				"focus": true,
-				"panel": "shared",
-				"showReuseMessage": false,
-				"clear": true,
-				"revealProblems": "onProblem"
-			},
-			"options": {
-				"cwd": "${workspaceFolder}/src-ui"
-			}
-		},
-		{
-			"label": "Project Setup: Run all Init Tasks",
-			"description": "Runs all init tasks to setup the project including migrate the database, create a superuser and compile the frontend for production",
-			"dependsOrder": "sequence",
-			"dependsOn": [
-				"Maintenance: manage.py migrate",
-				"Maintenance: manage.py createsuperuser",
-				"Maintenance: Compile frontend for production"
-			]
-		},
-		{
-			"label": "Project Start: Run all Services",
-			"description": "Runs all services required to start the project including the Celery Worker, the Consumer Service and the Backend Server",
-			"dependsOn": [
-				"Start: Celery Worker",
-				"Start: Consumer Service (manage.py document_consumer)",
-				"Start: Backend Server (manage.py runserver)"
-			]
-		}
-	]
-}

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -9,7 +9,7 @@ body:
         ### ⚠️ 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.
 
-        Also, note that **Paperless-ngx does not perform OCR or archive file creation itself**, those are handled by other tools. Problems with OCR or archive versions of specific files should likely be raised 'upstream', see https://github.com/ocrmypdf/OCRmyPDF/issues or https://github.com/tesseract-ocr/tesseract/issues
+        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: |
@@ -86,23 +86,22 @@ body:
       description: Note there are significant differences from the official image and linuxserver.io, please check if your issue is specific to the third-party image.
     validations:
       required: true
-  - type: textarea
-    id: system-status
-    attributes:
-      label: System status
-      description: If available, copy & paste the system status output from Settings > System Status > Copy
-      render: json
   - type: input
     id: browser
     attributes:
       label: Browser
       description: Which browser you are using, if relevant.
       placeholder: e.g. Chrome, Safari
-  - type: textarea
+  - type: input
     id: config-changes
     attributes:
       label: Configuration changes
       description: Any configuration changes you made in `docker-compose.yml`, `docker-compose.env` or `paperless.conf`.
+  - type: input
+    id: other
+    attributes:
+      label: Other
+      description: Any other relevant details.
   - type: checkboxes
     id: required-checks
     attributes:
@@ -110,8 +109,6 @@ body:
       options:
         - label: I believe this issue is a bug that affects all users of Paperless-ngx, not something specific to my installation.
           required: true
-        - label: This issue is not about the OCR or archive creation of a specific file(s). Otherwise, please see above regarding OCR tools.
-          required: true
         - label: I have already searched for relevant existing issues and discussions before opening this report.
           required: true
         - label: I have updated the title field above with a concise description.

.github/dependabot.yml

@@ -53,6 +53,7 @@ updates:
       development:
         patterns:
           - "*pytest*"
+          - "black"
           - "ruff"
           - "mkdocs-material"
       django:

.github/workflows/ci.yml

@@ -16,9 +16,9 @@ on:
 env:
   # This is the version of pipenv all the steps will use
   # If changing this, change Dockerfile
-  DEFAULT_PIP_ENV_VERSION: "2024.4.0"
+  DEFAULT_PIP_ENV_VERSION: "2023.12.1"
   # This is the default version of Python to use in most steps which aren't specific
-  DEFAULT_PYTHON_VERSION: "3.11"
+  DEFAULT_PYTHON_VERSION: "3.10"
 
 jobs:
   pre-commit:
@@ -30,7 +30,7 @@ jobs:
       github.repository
 
     name: Linting Checks
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     steps:
       -
         name: Checkout repository
@@ -46,7 +46,7 @@ jobs:
 
   documentation:
     name: "Build & Deploy Documentation"
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     needs:
       - pre-commit
     steps:
@@ -95,12 +95,12 @@ jobs:
 
   tests-backend:
     name: "Backend Tests (Python ${{ matrix.python-version }})"
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     needs:
       - pre-commit
     strategy:
       matrix:
-        python-version: ['3.10', '3.11', '3.12']
+        python-version: ['3.9', '3.10', '3.11']
       fail-fast: false
     steps:
       -
@@ -170,7 +170,7 @@ jobs:
 
   install-frontend-depedendencies:
     name: "Install Frontend Dependencies"
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     needs:
       - pre-commit
     steps:
@@ -201,7 +201,7 @@ jobs:
 
   tests-frontend:
     name: "Frontend Tests (Node ${{ matrix.node-version }} - ${{ matrix.shard-index }}/${{ matrix.shard-count }})"
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     needs:
       - install-frontend-depedendencies
     strategy:
@@ -260,8 +260,8 @@ jobs:
           retention-days: 7
 
   tests-coverage-upload:
-    name: "Upload to Codecov"
-    runs-on: ubuntu-24.04
+    name: "Upload Coverage"
+    runs-on: ubuntu-22.04
     needs:
       - tests-backend
       - tests-frontend
@@ -283,7 +283,7 @@ jobs:
           merge-multiple: true
       -
         name: Upload frontend coverage to Codecov
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v4
         with:
           # not required for public repos, but intermittently fails otherwise
           token: ${{ secrets.CODECOV_TOKEN }}
@@ -299,41 +299,17 @@ jobs:
           path: src/
       -
         name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v4
         with:
           # not required for public repos, but intermittently fails otherwise
           token: ${{ secrets.CODECOV_TOKEN }}
           # future expansion
           flags: backend
           directory: src/
-      -
-        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 dependencies
-        id: cache-frontend-deps
-        uses: actions/cache@v4
-        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: Build frontend and upload analysis
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-        run: cd src-ui && ng build --configuration=production
 
   build-docker-image:
     name: Build Docker image for ${{ github.ref_name }}
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || startsWith(github.ref, 'refs/heads/fix-') || github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/beta' || contains(github.ref, 'beta.rc') || startsWith(github.ref, 'refs/tags/v'))
     concurrency:
       group: ${{ github.workflow }}-build-docker-image-${{ github.ref_name }}
@@ -406,7 +382,7 @@ jobs:
       -
         name: Login to Docker Hub
         uses: docker/login-action@v3
-        # Don't attempt to login if not pushing to Docker Hub
+        # Don't attempt to login is not pushing to Docker Hub
         if: steps.push-other-places.outputs.enable == 'true'
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
@@ -414,7 +390,7 @@ jobs:
       -
         name: Login to Quay.io
         uses: docker/login-action@v3
-        # Don't attempt to login if not pushing to Quay.io
+        # Don't attempt to login is not pushing to Quay.io
         if: steps.push-other-places.outputs.enable == 'true'
         with:
           registry: quay.io
@@ -422,7 +398,7 @@ jobs:
           password: ${{ secrets.QUAY_ROBOT_TOKEN }}
       -
         name: Build and push
-        uses: docker/build-push-action@v6
+        uses: docker/build-push-action@v5
         with:
           context: .
           file: ./Dockerfile
@@ -430,8 +406,6 @@ jobs:
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.docker-meta.outputs.tags }}
           labels: ${{ steps.docker-meta.outputs.labels }}
-          build-args: |
-            PNGX_TAG_VERSION=${{ steps.docker-meta.outputs.version }}
           # Get cache layers from this branch, then dev
           # This allows new branches to get at least some cache benefits, generally from dev
           cache-from: |
@@ -461,7 +435,7 @@ jobs:
     needs:
       - build-docker-image
       - documentation
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     steps:
       -
         name: Checkout
@@ -482,6 +456,12 @@ jobs:
         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: |
@@ -569,7 +549,7 @@ jobs:
 
   publish-release:
     name: "Publish Release"
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     outputs:
       prerelease: ${{ steps.get_version.outputs.prerelease }}
       changelog: ${{ steps.create-release.outputs.body }}
@@ -619,7 +599,7 @@ jobs:
 
   append-changelog:
     name: "Append Changelog"
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     needs:
       - publish-release
     if: needs.publish-release.outputs.prerelease == 'false'
@@ -649,9 +629,7 @@ jobs:
           git checkout ${{ needs.publish-release.outputs.version }}-changelog
           echo -e "# Changelog\n\n${{ needs.publish-release.outputs.changelog }}\n" > changelog-new.md
           echo "Manually linking usernames"
-          sed -i -r 's|@([a-zA-Z0-9_]+) \(\[#|[@\1](https://github.com/\1) ([#|g' changelog-new.md
-          echo "Removing unneeded comment tags"
-          sed -i -r 's|@<!---->|@|g' changelog-new.md
+          sed -i -r 's|@(.+?) \(\[#|[@\1](https://github.com/\1) ([#|ig' changelog-new.md
           CURRENT_CHANGELOG=`tail --lines +2 changelog.md`
           echo -e "$CURRENT_CHANGELOG" >> changelog-new.md
           mv changelog-new.md changelog.md

.github/workflows/cleanup-tags.yml

@@ -21,7 +21,7 @@ jobs:
   cleanup-images:
     name: Cleanup Image Tags for ${{ matrix.primary-name }}
     if: github.repository_owner == 'paperless-ngx'
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
@@ -33,7 +33,7 @@ jobs:
       -
         name: Clean temporary images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/ephemeral@v0.9.0
+        uses: stumpylog/image-cleaner-action/ephemeral@v0.5.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "${{ github.repository_owner }}"
@@ -47,7 +47,7 @@ jobs:
   cleanup-untagged-images:
     name: Cleanup Untagged Images Tags for ${{ matrix.primary-name }}
     if: github.repository_owner == 'paperless-ngx'
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     needs:
       - cleanup-images
     strategy:
@@ -61,7 +61,7 @@ jobs:
       -
         name: Clean untagged images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/untagged@v0.9.0
+        uses: stumpylog/image-cleaner-action/untagged@v0.5.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "${{ github.repository_owner }}"

.github/workflows/codeql-analysis.yml

@@ -23,7 +23,7 @@ on:
 jobs:
   analyze:
     name: Analyze
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     permissions:
       actions: read
       contents: read

.github/workflows/crowdin.yml

@@ -15,14 +15,13 @@ on:
 jobs:
   synchronize-with-crowdin:
     name: Crowdin Sync
-    if: github.repository_owner == 'paperless-ngx'
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
 
     steps:
     - name: Checkout
       uses: actions/checkout@v4
     - name: crowdin action
-      uses: crowdin/github-action@v2
+      uses: crowdin/github-action@v1
       with:
         upload_translations: false
         download_translations: true

.github/workflows/project-actions.yml

@@ -15,7 +15,7 @@ permissions:
 jobs:
   pr_opened_or_reopened:
     name: pr_opened_or_reopened
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-22.04
     permissions:
       # write permission is required for autolabeler
       pull-requests: write

.github/workflows/repo-maintenance.yml

@@ -16,14 +16,13 @@ concurrency:
 jobs:
   stale:
     name: 'Stale'
-    if: github.repository_owner == 'paperless-ngx'
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/stale@v9
         with:
           days-before-stale: 7
           days-before-close: 14
-          any-of-labels: 'stale,cant-reproduce,not a bug'
+          any-of-labels: 'cant-reproduce,not a bug'
           stale-issue-label: stale
           stale-pr-label: stale
           stale-issue-message: >
@@ -32,8 +31,7 @@ jobs:
             for your contributions. See our [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/dev/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
   lock-threads:
     name: 'Lock Old Threads'
-    if: github.repository_owner == 'paperless-ngx'
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
       - uses: dessant/lock-threads@v5
         with:
@@ -58,8 +56,7 @@ jobs:
             See our [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/dev/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
   close-answered-discussions:
     name: 'Close Answered Discussions'
-    if: github.repository_owner == 'paperless-ngx'
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/github-script@v7
         with:
@@ -115,8 +112,7 @@ jobs:
             }
   close-outdated-discussions:
     name: 'Close Outdated Discussions'
-    if: github.repository_owner == 'paperless-ngx'
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/github-script@v7
         with:
@@ -207,8 +203,7 @@ jobs:
             }
   close-unsupported-feature-requests:
     name: 'Close Unsupported Feature Requests'
-    if: github.repository_owner == 'paperless-ngx'
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/github-script@v7
         with:
@@ -217,20 +212,15 @@ jobs:
               return new Promise(resolve => setTimeout(resolve, ms));
             }
 
-            const CUTOFF_MAX_COUNT = 80;
             const CUTOFF_1_DAYS = 180;
             const CUTOFF_1_COUNT = 5;
             const CUTOFF_2_DAYS = 365;
-            const CUTOFF_2_COUNT = 20;
-            const CUTOFF_3_DAYS = 730;
-            const CUTOFF_3_COUNT = 40;
+            const CUTOFF_2_COUNT = 10;
 
             const cutoff1Date = new Date();
             cutoff1Date.setDate(cutoff1Date.getDate() - CUTOFF_1_DAYS);
             const cutoff2Date = new Date();
             cutoff2Date.setDate(cutoff2Date.getDate() - CUTOFF_2_DAYS);
-            const cutoff3Date = new Date();
-            cutoff3Date.setDate(cutoff3Date.getDate() - CUTOFF_3_DAYS);
 
             const query = `query(
                 $owner:String!,
@@ -260,12 +250,9 @@ jobs:
             const result = await github.graphql(query, variables);
 
             for (const discussion of result.repository.discussions.nodes) {
-              const discussionUpdatedDate = new Date(discussion.updatedAt);
-              const discussionCreatedDate = new Date(discussion.createdAt);
-              if ((discussionUpdatedDate < cutoff1Date && discussion.upvoteCount < CUTOFF_MAX_COUNT) ||
-                  (discussionCreatedDate < cutoff1Date && discussion.upvoteCount < CUTOFF_1_COUNT) ||
-                  (discussionCreatedDate < cutoff2Date && discussion.upvoteCount < CUTOFF_2_COUNT) ||
-                  (discussionCreatedDate < cutoff3Date && discussion.upvoteCount < CUTOFF_3_COUNT)) {
+              const discussionDate = new Date(discussion.updatedAt);
+              if ((discussionDate < cutoff1Date && discussion.upvoteCount < CUTOFF_1_COUNT) ||
+                  (discussionDate < cutoff2Date && discussion.upvoteCount < CUTOFF_2_COUNT)) {
                 console.log(`Closing discussion #${discussion.number} (${discussion.id}), last updated at ${discussion.updatedAt} with votes ${discussion.upvoteCount}`);
                 const addCommentMutation = `mutation($discussion:ID!, $body:String!) {
                   addDiscussionComment(input:{discussionId:$discussion, body:$body}) {

.gitignore

@@ -22,7 +22,6 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
-/src/paperless_mail/templates/node_modules
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -66,8 +65,6 @@ target/
 .vscode
 /src-ui/.vscode
 /docs/.vscode
-.vscode-server
-*CommandMarker
 
 # Other stuff that doesn't belong
 .virtualenv
@@ -100,9 +97,3 @@ scripts/nuke
 
 # celery schedule file
 celerybeat-schedule*
-
-# ignore .devcontainer sub folders
-/.devcontainer/consume/
-/.devcontainer/data/
-/.devcontainer/media/
-/.devcontainer/redisdata/

.pre-commit-config.yaml

@@ -5,7 +5,7 @@
 repos:
   # General hooks
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v4.6.0
     hooks:
       - id: check-docstring-first
       - id: check-json
@@ -29,16 +29,15 @@ repos:
       - id: check-case-conflict
       - id: detect-private-key
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.2.6
     hooks:
       - id: codespell
         exclude: "(^src-ui/src/locale/)|(^src-ui/e2e/)|(^src/paperless_mail/tests/samples/)"
         exclude_types:
           - pofile
           - json
-  # See https://github.com/prettier/prettier/issues/15742 for the fork reason
-  - repo: https://github.com/rbubley/mirrors-prettier
-    rev: 'v3.3.3'
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: 'v3.1.0'
     hooks:
       - id: prettier
         types_or:
@@ -46,15 +45,15 @@ repos:
           - ts
           - markdown
         exclude: "(^Pipfile\\.lock$)"
-        additional_dependencies:
-          - prettier@3.3.3
-          - 'prettier-plugin-organize-imports@4.1.0'
   # Python hooks
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.6
+    rev: 'v0.4.1'
     hooks:
       - id: ruff
-      - id: ruff-format
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.4.0
+    hooks:
+      - id: black
   # Dockerfile hooks
   - repo: https://github.com/AleksaC/hadolint-py
     rev: v2.12.0.3
@@ -65,8 +64,6 @@ repos:
     rev: v6.2.1
     hooks:
       - id: beautysh
-        additional_dependencies:
-          - setuptools
         args:
           - "--tab"
   - repo: https://github.com/shellcheck-py/shellcheck-py

.prettierrc

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

.prettierrc.js

@@ -1,19 +0,0 @@
-const config = {
-	// https://prettier.io/docs/en/options.html#semicolons
-	semi: false,
-	// https://prettier.io/docs/en/options.html#quotes
-	singleQuote: true,
-	// https://prettier.io/docs/en/options.html#trailing-commas
-	trailingComma: 'es5',
-	overrides: [
-		{
-			files: ['docs/*.md'],
-			options: {
-				tabWidth: 4,
-			},
-		},
-	],
-	plugins: [require('prettier-plugin-organize-imports')],
-}
-
-module.exports = config

.python-version

@@ -1 +1 @@
-3.10.15
+3.9.18

.ruff.toml

@@ -2,7 +2,7 @@ fix = true
 line-length = 88
 respect-gitignore = true
 src = ["src"]
-target-version = "py310"
+target-version = "py39"
 output-format = "grouped"
 show-fixes = true
 
@@ -31,55 +31,17 @@ extend-select = [
   "PLE",   # https://docs.astral.sh/ruff/rules/#pylint-pl
   "RUF",   # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
   "FLY",   # https://docs.astral.sh/ruff/rules/#flynt-fly
-  "PTH",   # https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
 ]
+# TODO PTH https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
 ignore = ["DJ001", "SIM105", "RUF012"]
 
 [lint.per-file-ignores]
 ".github/scripts/*.py" = ["E501", "INP001", "SIM117"]
 "docker/wait-for-redis.py" = ["INP001", "T201"]
-"src/documents/consumer.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/file_handling.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/management/commands/document_consumer.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/management/commands/document_exporter.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/migrations/0012_auto_20160305_0040.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/migrations/0014_document_checksum.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/migrations/1003_mime_types.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/migrations/1012_fix_archive_files.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/models.py" = ["SIM115", "PTH"]  # TODO PTH Enable & remove
-"src/documents/parsers.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/signals/handlers.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tasks.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_api_app_config.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_api_bulk_download.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_api_documents.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_classifier.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_consumer.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_file_handling.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_management.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_management_consumer.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_management_exporter.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_management_thumbnails.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_migration_archive_files.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_migration_document_pages_count.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_migration_mime_type.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_sanity_check.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_tasks.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/tests/test_views.py" = ["PTH"]  # TODO Enable & remove
-"src/documents/views.py" = ["PTH"]  # TODO Enable & remove
-"src/paperless/checks.py" = ["PTH"]  # TODO Enable & remove
-"src/paperless/settings.py" = ["PTH"]  # TODO Enable & remove
-"src/paperless/tests/test_checks.py" = ["PTH"]  # TODO Enable & remove
-"src/paperless/urls.py" = ["PTH"]  # TODO Enable & remove
-"src/paperless/views.py" = ["PTH"]  # TODO Enable & remove
-"src/paperless_mail/mail.py" = ["PTH"]  # TODO Enable & remove
-"src/paperless_mail/preprocessor.py" = ["PTH"]  # TODO Enable & remove
-"src/paperless_tesseract/parsers.py" = ["PTH"]  # TODO Enable & remove
-"src/paperless_tesseract/tests/test_parser.py" = ["RUF001", "PTH"]  # TODO PTH Enable & remove
-"src/paperless_tika/tests/test_live_tika.py" = ["PTH"]  # TODO Enable & remove
-"src/paperless_tika/tests/test_tika_parser.py" = ["PTH"]  # TODO Enable & remove
 "*/tests/*.py" = ["E501", "SIM117"]
 "*/migrations/*.py" = ["E501", "SIM", "T201"]
+"src/paperless_tesseract/tests/test_parser.py" = ["RUF001"]
+"src/documents/models.py" = ["SIM115"]
 
 [lint.isort]
 force-single-line = true

CODE_OF_CONDUCT.md

@@ -5,7 +5,7 @@
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socioeconomic status,
+identity and expression, level of experience, education, socio-economic status,
 nationality, personal appearance, race, religion, or sexual identity
 and orientation.
 

CONTRIBUTING.md

@@ -11,7 +11,7 @@ If you want to implement something big:
 
 ## Python
 
-Paperless supports python 3.10 - 3.12 at this time. We format Python code with [ruff](https://docs.astral.sh/ruff/formatter/).
+Paperless supports python 3.9 - 3.11. We format Python code with [Black](https://github.com/psf/black).
 
 ## Branches
 
@@ -147,7 +147,7 @@ community members. That said, in an effort to keep the repository organized and
 - Issues, pull requests and discussions that are closed will be locked after 30 days of inactivity.
 - Discussions with a marked answer will be automatically closed.
 - Discussions in the 'General' or 'Support' categories will be closed after 180 days of inactivity.
-- Feature requests that do not meet the following thresholds will be closed: 180 days of inactivity, < 5 "up-votes" after 180 days, < 20 "up-votes" after 1 year or < 80 "up-votes" at 2 years.
+- Feature requests that do not meet the following thresholds will be closed: 5 "up-votes" after 180 days of inactivity or 10 "up-votes" after 365 days.
 
 In all cases, threads can be re-opened by project maintainers and, of course, users can always create a new discussion for related concerns.
 Finally, remember that all information remains searchable and 'closed' feature requests can still serve as inspiration for new features.

Dockerfile

@@ -13,16 +13,6 @@ WORKDIR /src/src-ui
 RUN set -eux \
   && npm update npm -g \
   && npm ci
-
-ARG PNGX_TAG_VERSION=
-# Add the tag to the environment file if its a tagged dev build
-RUN set -eux && \
-case "${PNGX_TAG_VERSION}" in \
-  dev|beta|fix*|feature*) \
-    sed -i -E "s/version: '([0-9\.]+)'/version: '\1 #${PNGX_TAG_VERSION}'/g" /src/src-ui/src/environments/environment.prod.ts \
-    ;; \
-esac
-
 RUN set -eux \
   && ./node_modules/.bin/ng build --configuration production
 
@@ -31,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 docker.io/python:3.12-alpine AS pipenv-base
+FROM --platform=$BUILDPLATFORM docker.io/python:3.11-alpine as pipenv-base
 
 WORKDIR /usr/src/pipenv
 
@@ -39,7 +29,7 @@ COPY Pipfile* ./
 
 RUN set -eux \
   && echo "Installing pipenv" \
-    && python3 -m pip install --no-cache-dir --upgrade pipenv==2024.4.0 \
+    && python3 -m pip install --no-cache-dir --upgrade pipenv==2023.12.1 \
   && echo "Generating requirement.txt" \
     && pipenv requirements > requirements.txt
 
@@ -47,7 +37,7 @@ RUN set -eux \
 # Purpose: The final image
 # Comments:
 #  - Don't leave anything extra in here
-FROM docker.io/python:3.12-slim-bookworm 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/"
@@ -63,7 +53,7 @@ ARG TARGETARCH
 # Can be workflow provided, defaults set for manual building
 ARG JBIG2ENC_VERSION=0.29
 ARG QPDF_VERSION=11.9.0
-ARG GS_VERSION=10.03.1
+ARG GS_VERSION=10.02.1
 
 # Set Python environment variables
 ENV PYTHONDONTWRITEBYTECODE=1 \
@@ -93,6 +83,7 @@ ARG RUNTIME_PACKAGES="\
   icc-profiles-free \
   imagemagick \
   # PostgreSQL
+  libpq5 \
   postgresql-client \
   # MySQL / MariaDB
   mariadb-client \
@@ -138,17 +129,17 @@ RUN set -eux \
         && dpkg --install ./qpdf_${QPDF_VERSION}-1_${TARGETARCH}.deb \
       && echo "Installing Ghostscript ${GS_VERSION}" \
         && curl --fail --silent --show-error --location \
-          --output libgs10_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
+          --output libgs10_${GS_VERSION}.dfsg-2_${TARGETARCH}.deb \
           https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/libgs10_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
         && curl --fail --silent --show-error --location \
-          --output ghostscript_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
+          --output ghostscript_${GS_VERSION}.dfsg-2_${TARGETARCH}.deb \
           https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/ghostscript_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
         && curl --fail --silent --show-error --location \
-          --output libgs10-common_${GS_VERSION}.dfsg-1_all.deb \
+          --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-1_all.deb \
-        && dpkg --install ./libgs10-common_${GS_VERSION}.dfsg-1_all.deb \
-        && dpkg --install ./libgs10_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
-        && dpkg --install ./ghostscript_${GS_VERSION}.dfsg-1_${TARGETARCH}.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 \
@@ -232,22 +223,19 @@ RUN --mount=type=cache,target=/root/.cache/pip/,id=pip-cache \
     && apt-get install --yes --quiet --no-install-recommends ${BUILD_PACKAGES} \
     && python3 -m pip install --no-cache-dir --upgrade wheel \
   && echo "Installing Python requirements" \
-    && curl --fail --silent --show-error --location \
-    --output psycopg_c-3.2.3-cp312-cp312-linux_x86_64.whl \
-    https://github.com/paperless-ngx/builder/releases/download/psycopg-3.2.3/psycopg_c-3.2.3-cp312-cp312-linux_x86_64.whl \
-    && curl --fail --silent --show-error --location \
-    --output psycopg_c-3.2.3-cp312-cp312-linux_aarch64.whl  \
-    https://github.com/paperless-ngx/builder/releases/download/psycopg-3.2.3/psycopg_c-3.2.3-cp312-cp312-linux_aarch64.whl \
-    && python3 -m pip install --default-timeout=1000 --find-links . --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_tab \
+    && python3 -W ignore::RuntimeWarning -m nltk.downloader -d "/usr/share/nltk_data" punkt \
   && echo "Cleaning up image" \
     && apt-get --yes purge ${BUILD_PACKAGES} \
     && apt-get --yes autoremove --purge \
     && apt-get clean --yes \
-    && rm --recursive --force --verbose *.whl \
     && rm --recursive --force --verbose /var/lib/apt/lists/* \
     && rm --recursive --force --verbose /tmp/* \
     && rm --recursive --force --verbose /var/tmp/* \
@@ -271,8 +259,6 @@ RUN set -eux \
     && mkdir --parents --verbose /usr/src/paperless/media \
     && mkdir --parents --verbose /usr/src/paperless/consume \
     && mkdir --parents --verbose /usr/src/paperless/export \
-  && echo "Creating gnupg directory" \
-    && mkdir -m700 --verbose /usr/src/paperless/.gnupg \
   && echo "Adjusting all permissions" \
     && chown --from root:root --changes --recursive paperless:paperless /usr/src/paperless \
   && echo "Collecting static files" \

Pipfile

@@ -7,40 +7,37 @@ name = "pypi"
 dateparser = "~=1.2"
 # WARNING: django does not use semver.
 #          Only patch versions are guaranteed to not introduce breaking changes.
-django = "~=5.1.4"
-django-allauth = {extras = ["mfa", "socialaccount"], version = "*"}
+django = "~=4.2.11"
+django-allauth = "*"
 django-auditlog = "*"
 django-celery-results = "*"
 django-compression-middleware = "*"
 django-cors-headers = "*"
 django-extensions = "*"
-django-filter = "~=24.3"
+django-filter = "~=24.2"
 django-guardian = "*"
 django-multiselectfield = "*"
-django-soft-delete = "*"
-djangorestframework = "~=3.15.2"
+djangorestframework = "==3.14.0"
 djangorestframework-guardian = "*"
 drf-writable-nested = "*"
 bleach = "*"
 celery = {extras = ["redis"], version = "*"}
-channels = "~=4.2"
+channels = "~=4.1"
 channels-redis = "*"
 concurrent-log-handler = "*"
 filelock = "*"
 flower = "*"
 gotenberg-client = "*"
 gunicorn = "*"
-httpx-oauth = "*"
 imap-tools = "*"
 inotifyrecursive = "~=0.3"
-jinja2 = "~=3.1"
 langdetect = "*"
 mysqlclient = "*"
 nltk = "*"
-ocrmypdf = "~=16.8"
+ocrmypdf = "~=15.4"
 pathvalidate = "*"
 pdf2image = "*"
-psycopg = {version = "*", extras = ["c"]}
+psycopg2 = "*"
 python-dateutil = "*"
 python-dotenv = "*"
 python-gnupg = "*"
@@ -49,24 +46,23 @@ python-magic = "*"
 pyzbar = "*"
 rapidfuzz = "*"
 redis = {extras = ["hiredis"], version = "*"}
-scikit-learn = "~=1.6"
+scikit-learn = "~=1.4"
 setproctitle = "*"
 tika-client = "*"
 tqdm = "*"
-# See https://github.com/paperless-ngx/paperless-ngx/issues/5494
 uvicorn = {extras = ["standard"], version = "==0.25.0"}
-watchdog = "~=6.0"
-whitenoise = "~=6.8"
-whoosh = "~=2.7"
+watchdog = "~=4.0"
+whitenoise = "~=6.6"
+whoosh="~=2.7"
 zxing-cpp = {version = "*", platform_machine = "== 'x86_64'"}
 
-
 [dev-packages]
 # Linting
+black = "*"
 pre-commit = "*"
 ruff = "*"
-factory-boy = "*"
 # Testing
+factory-boy = "*"
 pytest = "*"
 pytest-cov = "*"
 pytest-django = "*"
@@ -74,7 +70,6 @@ pytest-httpx = "*"
 pytest-env = "*"
 pytest-sugar = "*"
 pytest-xdist = "*"
-pytest-mock = "*"
 pytest-rerunfailures = "*"
 imagehash = "*"
 daphne = "*"
@@ -97,4 +92,5 @@ types-tqdm = "*"
 types-Markdown = "*"
 types-Pygments = "*"
 types-colorama = "*"
+types-psycopg2 = "*"
 types-setuptools = "*"

README.md

@@ -30,14 +30,14 @@ Thanks to the generous folks at [DigitalOcean](https://m.do.co/c/8d70b916d462),
   - [Translation](#translation)
   - [Feature Requests](#feature-requests)
   - [Bugs](#bugs)
-- [Related Projects](#related-projects)
+- [Affiliated Projects](#affiliated-projects)
 - [Important Note](#important-note)
 
 <p align="right">This project is supported by:<br/>
   <a href="https://m.do.co/c/8d70b916d462" style="padding-top: 4px; display: block;">
     <picture>
       <source media="(prefers-color-scheme: dark)" srcset="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_white.svg" width="140px">
-      <source media="(prefers-color-scheme: light)" srcset="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="140px">
+      <source media="(prefers-color-scheme: light)" srcset="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_black_.svg" width="140px">
       <img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_black_.svg" width="140px">
     </picture>
   </a>
@@ -55,7 +55,7 @@ A full list of [features](https://docs.paperless-ngx.com/#features) and [screens
 
 # 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 the GitHub container registry.
+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:
 
@@ -63,7 +63,7 @@ If you'd like to jump right in, you can configure a `docker compose` environment
 bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
 ```
 
-More details and step-by-step guides for alternative installation methods can be found in [the documentation](https://docs.paperless-ngx.com/setup/#installation).
+Alternatively, you can install the dependencies and setup apache and a database server yourself. The [documentation](https://docs.paperless-ngx.com/setup/#installation) has a step by step guide on how to do it.
 
 Migrating from Paperless-ng is easy, just drop in the new docker image! See the [documentation on migrating](https://docs.paperless-ngx.com/setup/#migrating-to-paperless-ngx) for more details.
 
@@ -93,9 +93,9 @@ Feature requests can be submitted via [GitHub Discussions](https://github.com/pa
 
 For bugs please [open an issue](https://github.com/paperless-ngx/paperless-ngx/issues) or [start a discussion](https://github.com/paperless-ngx/paperless-ngx/discussions) if you have questions.
 
-# Related Projects
+# Affiliated Projects
 
-Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Related-Projects) for a user-maintained list of related projects and software that is compatible with Paperless-ngx.
+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.
 
 # Important Note
 

docker/compose/docker-compose.ci-test.yml

@@ -3,9 +3,10 @@
 # Can be used locally or by the CI to start the necessary containers with the
 # correct networking for the tests
 
+version: "3.7"
 services:
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:8.7
+    image: docker.io/gotenberg/gotenberg:7.10
     hostname: gotenberg
     container_name: gotenberg
     network_mode: host
@@ -19,7 +20,7 @@ services:
       - "--log-level=warn"
       - "--log-format=text"
   tika:
-    image: docker.io/apache/tika:latest
+    image: ghcr.io/paperless-ngx/tika:latest
     hostname: tika
     container_name: tika
     network_mode: host

docker/compose/docker-compose.env

@@ -1,17 +1,26 @@
-###############################################################################
-# Paperless-ngx settings                                                      #
-###############################################################################
-
-# See http://docs.paperless-ngx.com/configuration/ for all available options.
-
 # The UID and GID of the user used to run paperless in the container. Set this
 # to your UID and GID on the host so that you have write access to the
 # consumption directory.
 #USERMAP_UID=1000
 #USERMAP_GID=1000
 
-# See the documentation linked above for all options. A few commonly adjusted settings
-# are provided below.
+# Additional languages to install for text recognition, separated by a
+# whitespace. Note that this is
+# different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the
+# language used for OCR.
+# The container installs English, German, Italian, Spanish and French by
+# default.
+# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
+# for available languages.
+#PAPERLESS_OCR_LANGUAGES=tur ces
+
+###############################################################################
+# Paperless-specific settings                                                 #
+###############################################################################
+
+# All settings defined in the paperless.conf.example can be used here. The
+# Docker setup does not use the configuration file.
+# A few commonly adjusted settings are provided below.
 
 # This is required if you will be exposing Paperless-ngx on a public domain
 # (if doing so please consider security measures such as reverse proxy)
@@ -21,17 +30,13 @@
 # be a very long sequence of random characters. You don't need to remember it.
 #PAPERLESS_SECRET_KEY=change-me
 
-# Use this variable to set a timezone for the Paperless Docker containers. Defaults to UTC.
+# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
 #PAPERLESS_TIME_ZONE=America/Los_Angeles
 
 # The default language to use for OCR. Set this to the language most of your
 # documents are written in.
 #PAPERLESS_OCR_LANGUAGE=eng
 
-# Additional languages to install for text recognition, separated by a whitespace.
-# Note that this is different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines
-# the language used for OCR.
-# The container installs English, German, Italian, Spanish and French by default.
-# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
-# for available languages.
-#PAPERLESS_OCR_LANGUAGES=tur ces
+# Set if accessing paperless via a domain subpath e.g. https://domain.com/PATHPREFIX and using a reverse-proxy like traefik or nginx
+#PAPERLESS_FORCE_SCRIPT_NAME=/PATHPREFIX
+#PAPERLESS_STATIC_URL=/PATHPREFIX/static/ # trailing slash required

docker/compose/docker-compose.mariadb-tika.yml

@@ -30,6 +30,7 @@
 # For more extensive installation and update instructions, refer to the
 # documentation.
 
+version: "3.4"
 services:
   broker:
     image: docker.io/library/redis:7
@@ -38,7 +39,7 @@ services:
       - redisdata:/data
 
   db:
-    image: docker.io/library/mariadb:11
+    image: docker.io/library/mariadb:10
     restart: unless-stopped
     volumes:
       - dbdata:/var/lib/mysql
@@ -77,7 +78,7 @@ services:
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
 
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:8.7
+    image: docker.io/gotenberg/gotenberg:7.10
     restart: unless-stopped
     # The gotenberg chromium route is used to convert .eml files. We do not
     # want to allow external content like tracking pixels or even javascript.
@@ -87,7 +88,7 @@ services:
       - "--chromium-allow-list=file:///tmp/.*"
 
   tika:
-    image: docker.io/apache/tika:latest
+    image: ghcr.io/paperless-ngx/tika:latest
     restart: unless-stopped
 
 volumes:

docker/compose/docker-compose.mariadb.yml

@@ -26,6 +26,7 @@
 # For more extensive installation and update instructions, refer to the
 # documentation.
 
+version: "3.4"
 services:
   broker:
     image: docker.io/library/redis:7
@@ -34,7 +35,7 @@ services:
       - redisdata:/data
 
   db:
-    image: docker.io/library/mariadb:11
+    image: docker.io/library/mariadb:10
     restart: unless-stopped
     volumes:
       - dbdata:/var/lib/mysql

docker/compose/docker-compose.portainer.yml

@@ -19,8 +19,6 @@
 #
 # - Open portainer Stacks list and click 'Add stack'
 # - Paste the contents of this file and assign a name, e.g. 'paperless'
-# - Upload 'docker-compose.env' by clicking on 'Load variables from .env file'
-# - Modify the environment variables as needed
 # - Click 'Deploy the stack' and wait for it to be deployed
 # - Open the list of containers, select paperless_webserver_1
 # - Click 'Console' and then 'Connect' to open the command line inside the container
@@ -30,6 +28,7 @@
 # For more extensive installation and update instructions, refer to the
 # documentation.
 
+version: "3.4"
 services:
   broker:
     image: docker.io/library/redis:7
@@ -38,7 +37,7 @@ services:
       - redisdata:/data
 
   db:
-    image: docker.io/library/postgres:16
+    image: docker.io/library/postgres:15
     restart: unless-stopped
     volumes:
       - pgdata:/var/lib/postgresql/data
@@ -63,8 +62,28 @@ services:
     environment:
       PAPERLESS_REDIS: redis://broker:6379
       PAPERLESS_DBHOST: db
-    env_file:
-      - stack.env
+# The UID and GID of the user used to run paperless in the container. Set this
+# to your UID and GID on the host so that you have write access to the
+# consumption directory.
+      USERMAP_UID: 1000
+      USERMAP_GID: 100
+# Additional languages to install for text recognition, separated by a
+# whitespace. Note that this is
+# different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the
+# language used for OCR.
+# The container installs English, German, Italian, Spanish and French by
+# default.
+# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
+# for available languages.
+      #PAPERLESS_OCR_LANGUAGES: tur ces
+# Adjust this key if you plan to make paperless available publicly. It should
+# be a very long sequence of random characters. You don't need to remember it.
+      #PAPERLESS_SECRET_KEY: change-me
+# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
+      #PAPERLESS_TIME_ZONE: America/Los_Angeles
+# The default language to use for OCR. Set this to the language most of your
+# documents are written in.
+      #PAPERLESS_OCR_LANGUAGE: eng
 
 volumes:
   data:

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

@@ -30,6 +30,7 @@
 # For more extensive installation and update instructions, refer to the
 # documentation.
 
+version: "3.4"
 services:
   broker:
     image: docker.io/library/redis:7
@@ -38,7 +39,7 @@ services:
       - redisdata:/data
 
   db:
-    image: docker.io/library/postgres:16
+    image: docker.io/library/postgres:15
     restart: unless-stopped
     volumes:
       - pgdata:/var/lib/postgresql/data
@@ -71,7 +72,7 @@ services:
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
 
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:8.7
+    image: docker.io/gotenberg/gotenberg:7.10
     restart: unless-stopped
 
     # The gotenberg chromium route is used to convert .eml files. We do not
@@ -82,7 +83,7 @@ services:
       - "--chromium-allow-list=file:///tmp/.*"
 
   tika:
-    image: docker.io/apache/tika:latest
+    image: ghcr.io/paperless-ngx/tika:latest
     restart: unless-stopped
 
 volumes:

docker/compose/docker-compose.postgres.yml

@@ -26,6 +26,7 @@
 # For more extensive installation and update instructions, refer to the
 # documentation.
 
+version: "3.4"
 services:
   broker:
     image: docker.io/library/redis:7
@@ -34,7 +35,7 @@ services:
       - redisdata:/data
 
   db:
-    image: docker.io/library/postgres:16
+    image: docker.io/library/postgres:15
     restart: unless-stopped
     volumes:
       - pgdata:/var/lib/postgresql/data

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

@@ -30,6 +30,7 @@
 # For more extensive installation and update instructions, refer to the
 # documentation.
 
+version: "3.4"
 services:
   broker:
     image: docker.io/library/redis:7
@@ -59,7 +60,7 @@ services:
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
 
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:8.7
+    image: docker.io/gotenberg/gotenberg:7.10
     restart: unless-stopped
 
     # The gotenberg chromium route is used to convert .eml files. We do not
@@ -70,7 +71,7 @@ services:
       - "--chromium-allow-list=file:///tmp/.*"
 
   tika:
-    image: docker.io/apache/tika:latest
+    image: ghcr.io/paperless-ngx/tika:latest
     restart: unless-stopped
 
 volumes:

docker/compose/docker-compose.sqlite.yml

@@ -23,6 +23,7 @@
 # For more extensive installation and update instructions, refer to the
 # documentation.
 
+version: "3.4"
 services:
   broker:
     image: docker.io/library/redis:7

docker/docker-entrypoint.sh

@@ -10,8 +10,8 @@ map_uidgid() {
 	local -r usermap_new_gid=${USERMAP_GID:-${usermap_original_gid:-$usermap_new_uid}}
 	if [[ ${usermap_new_uid} != "${usermap_original_uid}" || ${usermap_new_gid} != "${usermap_original_gid}" ]]; then
 		echo "Mapping UID and GID for paperless:paperless to $usermap_new_uid:$usermap_new_gid"
-		usermod --non-unique --uid "${usermap_new_uid}" paperless
-		groupmod --non-unique --gid "${usermap_new_gid}" paperless
+		usermod -o -u "${usermap_new_uid}" paperless
+		groupmod -o -g "${usermap_new_gid}" paperless
 	fi
 }
 
@@ -42,7 +42,7 @@ custom_container_init() {
 		fi
 
 		# Make sure custom init directory has files in it
-		if [ -n "$(/bin/ls --almost-all "${custom_script_dir}" 2>/dev/null)" ]; then
+		if [ -n "$(/bin/ls -A "${custom_script_dir}" 2>/dev/null)" ]; then
 			echo "[custom-init] files found in ${custom_script_dir} executing"
 			# Loop over files in the directory
 			for SCRIPT in "${custom_script_dir}"/*; do
@@ -86,13 +86,13 @@ initialize() {
 		"${CONSUME_DIR}"; do
 		if [[ ! -d "${dir}" ]]; then
 			echo "Creating directory ${dir}"
-			mkdir --parents --verbose "${dir}"
+			mkdir --parents "${dir}"
 		fi
 	done
 
 	local -r tmp_dir="${PAPERLESS_SCRATCH_DIR:=/tmp/paperless}"
 	echo "Creating directory scratch directory ${tmp_dir}"
-	mkdir --parents --verbose "${tmp_dir}"
+	mkdir --parents "${tmp_dir}"
 
 	set +e
 	echo "Adjusting permissions of paperless files. This may take a while."
@@ -102,7 +102,7 @@ initialize() {
 		"${DATA_DIR}" \
 		"${MEDIA_ROOT_DIR}" \
 		"${CONSUME_DIR}"; do
-		find "${dir}" -not \( -user paperless -and -group paperless \) -exec chown --changes paperless:paperless {} +
+		find "${dir}" -not \( -user paperless -and -group paperless \) -exec chown paperless:paperless {} +
 	done
 	set -e
 
@@ -122,44 +122,33 @@ install_languages() {
 	if [ ${#langs[@]} -eq 0 ]; then
 		return
 	fi
+	apt-get update
 
-	# Build list of packages to install
-	to_install=()
 	for lang in "${langs[@]}"; do
 		pkg="tesseract-ocr-$lang"
 
-		if dpkg --status "$pkg" &>/dev/null; then
+		if dpkg -s "$pkg" &>/dev/null; then
 			echo "Package $pkg already installed!"
 			continue
-		else
-			to_install+=("$pkg")
+		fi
+
+		if ! apt-cache show "$pkg" &>/dev/null; then
+			echo "Package $pkg not found! :("
+			continue
+		fi
+
+		echo "Installing package $pkg..."
+		if ! apt-get -y install "$pkg" &>/dev/null; then
+			echo "Could not install $pkg"
+			exit 1
 		fi
 	done
-
-	# Use apt only when we install packages
-	if [ ${#to_install[@]} -gt 0 ]; then
-		apt-get update
-
-		for pkg in "${to_install[@]}"; do
-
-			if ! apt-cache show "$pkg" &>/dev/null; then
-				echo "Skipped $pkg: Package not found! :("
-				continue
-			fi
-
-			echo "Installing package $pkg..."
-			if ! apt-get --assume-yes install "$pkg" &>/dev/null; then
-				echo "Could not install $pkg"
-				exit 1
-			fi
-		done
-	fi
 }
 
 echo "Paperless-ngx docker container starting..."
 
 gosu_cmd=(gosu paperless)
-if [ "$(id --user)" == "$(id --user paperless)" ]; then
+if [ "$(id -u)" == "$(id -u paperless)" ]; then
 	gosu_cmd=()
 fi
 

docker/docker-prepare.sh

@@ -13,7 +13,7 @@ wait_for_postgres() {
 
 	# Disable warning, host and port can't have spaces
 	# shellcheck disable=SC2086
-	while [ ! "$(pg_isready --host ${host} --port ${port})" ]; do
+	while [ ! "$(pg_isready -h ${host} -p ${port})" ]; do
 
 		if [ $attempt_num -eq $max_attempts ]; then
 			echo "Unable to connect to database."
@@ -25,7 +25,6 @@ wait_for_postgres() {
 		attempt_num=$(("$attempt_num" + 1))
 		sleep 5
 	done
-	echo "Connected to PostgreSQL"
 }
 
 wait_for_mariadb() {
@@ -52,7 +51,6 @@ wait_for_mariadb() {
 		attempt_num=$(("$attempt_num" + 1))
 		sleep 5
 	done
-	echo "Connected to MariaDB"
 }
 
 wait_for_redis() {

docker/env-from-file.sh

@@ -16,7 +16,7 @@ do
 	# Check if it starts with "PAPERLESS_" and ends in "_FILE"
 	if [[ ${env_name} == PAPERLESS_*_FILE ]]; then
 		# This should have been named different..
-		if [[ ${env_name} == "PAPERLESS_OCR_SKIP_ARCHIVE_FILE" || ${env_name} == "PAPERLESS_MODEL_FILE" ]]; then
+		if [[ ${env_name} == "PAPERLESS_OCR_SKIP_ARCHIVE_FILE" ]]; then
 			continue
 		fi
 		# Extract the value of the environment

docker/install_management_commands.sh

@@ -14,9 +14,7 @@ for command in decrypt_documents \
 	document_thumbnails \
 	document_sanity_checker \
 	document_fuzzy_match \
-	manage_superuser \
-	convert_mariadb_uuid \
-	prune_audit_logs;
+	manage_superuser;
 do
 	echo "installing $command..."
 	sed "s/management_command/$command/g" management_script.sh > /usr/local/bin/$command

docker/wait-for-redis.py

@@ -4,7 +4,6 @@ Simple script which attempts to ping the Redis broker as set in the environment
 a certain number of times, waiting a little bit in between
 
 """
-
 import os
 import sys
 import time

docs/administration.md

@@ -19,8 +19,6 @@ Options available to any installation of paperless:
     export. Therefore, incremental backups with `rsync` are entirely
     possible.
 
-    The exporter does not include API tokens and they will need to be re-generated after importing.
-
 !!! caution
 
     You cannot import the export generated with one version of paperless in
@@ -81,8 +79,8 @@ $ docker compose down
 1.  If you pull the image from the docker hub, all you need to do is:
 
     ```shell-session
-    docker compose pull
-    docker compose up
+    $ docker compose pull
+    $ docker compose up
     ```
 
     The Docker Compose files refer to the `latest` version, which is
@@ -91,9 +89,9 @@ $ docker compose down
 1.  If you built the image yourself, do the following:
 
     ```shell-session
-    git pull
-    docker compose build
-    docker compose up
+    $ git pull
+    $ docker compose build
+    $ docker compose up
     ```
 
 Running `docker compose up` will also apply any new database migrations.
@@ -155,7 +153,7 @@ following:
     environment before that, if you use one.
 
     ```shell-session
-    pip install -r requirements.txt
+    $ pip install -r requirements.txt
     ```
 
     !!! note
@@ -168,8 +166,8 @@ following:
 3.  Migrate the database.
 
     ```shell-session
-    cd src
-    python3 manage.py migrate # (1)
+    $ cd src
+    $ python3 manage.py migrate # (1)
     ```
 
     1.  Including `sudo -Hu <paperless_user>` may be required
@@ -187,12 +185,34 @@ For PostgreSQL, refer to [Upgrading a PostgreSQL Cluster](https://www.postgresql
 
 For MariaDB, refer to [Upgrading MariaDB](https://mariadb.com/kb/en/upgrading/)
 
-You may also use the exporter and importer with the `--data-only` flag, after creating a new database with the updated version of PostgreSQL or MariaDB.
+## Downgrading Paperless {#downgrade-paperless}
 
-!!! warning
+Downgrades are possible. However, some updates also contain database
+migrations (these change the layout of the database and may move data).
+In order to move back from a version that applied database migrations,
+you'll have to revert the database migration _before_ downgrading, and
+then downgrade paperless.
 
-    You should not change any settings, especially paths, when doing this or there is a
-    risk of data loss
+This table lists the compatible versions for each database migration
+number.
+
+| Migration number | Version range   |
+| ---------------- | --------------- |
+| 1011             | 1.0.0           |
+| 1012             | 1.1.0 - 1.2.1   |
+| 1014             | 1.3.0 - 1.3.1   |
+| 1016             | 1.3.2 - current |
+
+Execute the following management command to migrate your database:
+
+```shell-session
+$ python3 manage.py migrate documents <migration number>
+```
+
+!!! note
+
+    Some migrations cannot be undone. The command will issue errors if that
+    happens.
 
 ## Management utilities {#management-commands}
 
@@ -241,7 +261,6 @@ document_exporter target [-c] [-d] [-f] [-na] [-nt] [-p] [-sm] [-z]
 
 optional arguments:
 -c,  --compare-checksums
--cj, --compare-json
 -d,  --delete
 -f,  --use-filename-format
 -na, --no-archive
@@ -250,9 +269,6 @@ optional arguments:
 -sm, --split-manifest
 -z,  --zip
 -zn, --zip-name
---data-only
---no-progress-bar
---passphrase
 ```
 
 `target` is a folder to which the data gets written. This includes
@@ -270,8 +286,7 @@ only export changed and added files. Paperless determines whether a file
 has changed by inspecting the file attributes "date/time modified" and
 "size". If that does not work out for you, specify `-c` or
 `--compare-checksums` and paperless will attempt to compare file
-checksums instead. This is slower. The manifest and metadata json files
-are always updated, unless `cj` or `--compare-json` is specified.
+checksums instead. This is slower.
 
 Paperless will not remove any existing files in the export directory. If
 you want paperless to also remove files that do not belong to the
@@ -312,16 +327,6 @@ If `-z` or `--zip` is provided, the export will be a zip file
 in the target directory, named according to the current local date or the
 value set in `-zn` or `--zip-name`.
 
-If `--data-only` is provided, only the database will be exported. This option is intended
-to facilitate database upgrades without needing to clean documents and thumbnails from the media directory.
-
-If `--no-progress-bar` is provided, the progress bar will be hidden, rendering the
-exporter quiet. This option is useful for scripting scenarios, such as when using the
-exporter with `crontab`.
-
-If `--passphrase` is provided, it will be used to encrypt certain fields in the export. This value
-must be provided to import. If this value is lost, the export cannot be imported.
-
 !!! warning
 
     If exporting with the file name format, there may be errors due to
@@ -336,23 +341,15 @@ exporter](#exporter) and imports it into paperless.
 The importer works just like the exporter. You point it at a directory,
 and the script does the rest of the work:
 
-```shell
+```
 document_importer source
 ```
 
-| Option              | Required | Default | Description                                                               |
-| ------------------- | -------- | ------- | ------------------------------------------------------------------------- |
-| source              | Yes      | N/A     | The directory containing an export                                        |
-| `--no-progress-bar` | No       | False   | If provided, the progress bar will be hidden                              |
-| `--data-only`       | No       | False   | If provided, only import data, do not import document files or thumbnails |
-| `--passphrase`      | No       | N/A     | If your export was encrypted with a passphrase, must be provided          |
-
 When you use the provided docker compose script, put the export inside
 the `export` folder in your paperless source directory. Specify
 `../export` as the `source`.
 
-Note that .zip files (as can be generated from the exporter) are not supported. You must unzip them into
-the target directory first.
+Note that .zip files (as can be generated from the exporter) are not supported.
 
 !!! note
 
@@ -362,7 +359,6 @@ the target directory first.
 !!! warning
 
     The importer should be run against a completely empty installation (database and directories) of Paperless-ngx.
-    If using a data only import, only the database must be empty.
 
 ### Document retagger {#retagger}
 
@@ -590,7 +586,7 @@ 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)
 
 ```
@@ -624,12 +620,3 @@ document_fuzzy_match [--ratio] [--processes N]
     If providing the `--delete` option, it is highly recommended to have a backup.
     While every effort has been taken to ensure proper operation, there is always the
     chance of deletion of a file you want to keep.
-
-### Prune history (audit log) entries {#prune-history}
-
-If the audit log is enabled Paperless-ngx keeps an audit log of all changes made to documents. Functionality to automatically remove entries for deleted documents was added but
-entries created prior to this are not removed. This command allows you to prune the audit log of entries that are no longer needed.
-
-```shell
-prune_audit_logs
-```

docs/advanced_usage.md

@@ -25,20 +25,20 @@ documents.
 
 The following algorithms are available:
 
--   **None:** No matching will be performed.
--   **Any:** Looks for any occurrence of any word provided in match in
-    the PDF. If you define the match as `Bank1 Bank2`, it will match
-    documents containing either of these terms.
--   **All:** Requires that every word provided appears in the PDF,
-    albeit not in the order provided.
--   **Exact:** Matches only if the match appears exactly as provided
-    (i.e. preserve ordering) in the PDF.
--   **Regular expression:** Parses the match as a regular expression and
-    tries to find a match within the document.
--   **Fuzzy match:** Uses a partial matching based on locating the tag text
-    inside the document, using a [partial ratio](https://rapidfuzz.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](#automatic-matching).
+- **None:** No matching will be performed.
+- **Any:** Looks for any occurrence of any word provided in match in
+  the PDF. If you define the match as `Bank1 Bank2`, it will match
+  documents containing either of these terms.
+- **All:** Requires that every word provided appears in the PDF,
+  albeit not in the order provided.
+- **Exact:** Matches only if the match appears exactly as provided
+  (i.e. preserve ordering) in the PDF.
+- **Regular expression:** Parses the match as a regular expression and
+  tries to find a match within the document.
+- **Fuzzy match:** 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](#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.
@@ -69,33 +69,33 @@ Paperless tries to hide much of the involved complexity with this
 approach. However, there are a couple caveats you need to keep in mind
 when using this feature:
 
--   Changes to your documents are not immediately reflected by the
-    matching algorithm. The neural network needs to be _trained_ on your
-    documents after changes. Paperless periodically (default: once each
-    hour) checks for changes and does this automatically for you.
--   The Auto matching algorithm only takes documents into account which
-    are NOT placed in your inbox (i.e. have any inbox tags assigned to
-    them). This ensures that the neural network only learns from
-    documents which you have correctly tagged before.
--   The matching algorithm can only work if there is a correlation
-    between the tag, correspondent, document type, or storage path and
-    the document itself. Your bank statements usually contain your bank
-    account number and the name of the bank, so this works reasonably
-    well, However, tags such as "TODO" cannot be automatically
-    assigned.
--   The matching algorithm needs a reasonable number of documents to
-    identify when to assign tags, correspondents, storage paths, and
-    types. If one out of a thousand documents has the correspondent
-    "Very obscure web shop I bought something five years ago", it will
-    probably not assign this correspondent automatically if you buy
-    something from them again. The more documents, the better.
--   Paperless also needs a reasonable amount of negative examples to
-    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" or "Bank", paperless will assign one
-    of these correspondents to ANY new document, if both are set to
-    automatic matching.
+- Changes to your documents are not immediately reflected by the
+  matching algorithm. The neural network needs to be _trained_ on your
+  documents after changes. Paperless periodically (default: once each
+  hour) checks for changes and does this automatically for you.
+- The Auto matching algorithm only takes documents into account which
+  are NOT placed in your inbox (i.e. have any inbox tags assigned to
+  them). This ensures that the neural network only learns from
+  documents which you have correctly tagged before.
+- The matching algorithm can only work if there is a correlation
+  between the tag, correspondent, document type, or storage path and
+  the document itself. Your bank statements usually contain your bank
+  account number and the name of the bank, so this works reasonably
+  well, However, tags such as "TODO" cannot be automatically
+  assigned.
+- The matching algorithm needs a reasonable number of documents to
+  identify when to assign tags, correspondents, storage paths, and
+  types. If one out of a thousand documents has the correspondent
+  "Very obscure web shop I bought something five years ago", it will
+  probably not assign this correspondent automatically if you buy
+  something from them again. The more documents, the better.
+- Paperless also needs a reasonable amount of negative examples to
+  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" or "Bank", paperless will assign one
+  of these correspondents to ANY new document, if both are set to
+  automatic matching.
 
 ## Hooking into the consumption process {#consume-hooks}
 
@@ -187,7 +187,6 @@ variables:
 | `DOCUMENT_THUMBNAIL_PATH`    | Path to the generated thumbnail                |
 | `DOCUMENT_DOWNLOAD_URL`      | URL for document download                      |
 | `DOCUMENT_THUMBNAIL_URL`     | URL for the document thumbnail                 |
-| `DOCUMENT_OWNER`             | Username of the document owner (if any)        |
 | `DOCUMENT_CORRESPONDENT`     | Assigned correspondent (if any)                |
 | `DOCUMENT_TAGS`              | Comma separated list of tags applied (if any)  |
 | `DOCUMENT_ORIGINAL_FILENAME` | Filename of original document                  |
@@ -242,12 +241,12 @@ webserver:
 
 Troubleshooting:
 
--   Monitor the Docker Compose log
-    `cd ~/paperless-ngx; docker compose logs -f`
--   Check your script's permission e.g. in case of permission error
-    `sudo chmod 755 post-consumption-example.sh`
--   Pipe your scripts's output to a log file e.g.
-    `echo "${DOCUMENT_ID}" | tee --append /usr/src/paperless/scripts/post-consumption-example.log`
+- Monitor the Docker Compose log
+  `cd ~/paperless-ngx; docker compose logs -f`
+- Check your script's permission e.g. in case of permission error
+  `sudo chmod 755 post-consumption-example.sh`
+- Pipe your scripts's output to a log file e.g.
+  `echo "${DOCUMENT_ID}" | tee --append /usr/src/paperless/scripts/post-consumption-example.log`
 
 ## File name handling {#file-name-handling}
 
@@ -265,7 +264,7 @@ This variable allows you to configure the filename (folders are allowed)
 using placeholders. For example, configuring this to
 
 ```bash
-PAPERLESS_FILENAME_FORMAT={{ created_year }}/{{ correspondent }}/{{ title }}
+PAPERLESS_FILENAME_FORMAT={created_year}/{correspondent}/{title}
 ```
 
 will create a directory structure as follows:
@@ -298,39 +297,39 @@ will create a directory structure as follows:
     when changing `PAPERLESS_FILENAME_FORMAT` you will need to manually run the
     [`document renamer`](administration.md#renamer) to move any existing documents.
 
-### Placeholders {#filename-format-variables}
+#### Placeholders
 
-Paperless provides the following variables for use within filenames:
+Paperless provides the following placeholders within filenames:
 
--   `{{ asn }}`: The archive serial number of the document, or "none".
--   `{{ correspondent }}`: The name of the correspondent, or "none".
--   `{{ document_type }}`: The name of the document type, or "none".
--   `{{ tag_list }}`: A comma separated list of all tags assigned to the
-    document.
--   `{{ title }}`: The title of the document.
--   `{{ created }}`: The full date (ISO format) the document was created.
--   `{{ created_year }}`: Year created only, formatted as the year with
-    century.
--   `{{ created_year_short }}`: Year created only, formatted as the year
-    without century, zero padded.
--   `{{ created_month }}`: Month created only (number 01-12).
--   `{{ created_month_name }}`: Month created name, as per locale
--   `{{ created_month_name_short }}`: Month created abbreviated name, as per
-    locale
--   `{{ created_day }}`: Day created only (number 01-31).
--   `{{ added }}`: The full date (ISO format) the document was added to
-    paperless.
--   `{{ added_year }}`: Year added only.
--   `{{ added_year_short }}`: Year added only, formatted as the year without
-    century, zero padded.
--   `{{ added_month }}`: Month added only (number 01-12).
--   `{{ added_month_name }}`: Month added name, as per locale
--   `{{ added_month_name_short }}`: Month added abbreviated name, as per
-    locale
--   `{{ 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.
+- `{asn}`: The archive serial number of the document, or "none".
+- `{correspondent}`: The name of the correspondent, or "none".
+- `{document_type}`: The name of the document type, or "none".
+- `{tag_list}`: A comma separated list of all tags assigned to the
+  document.
+- `{title}`: The title of the document.
+- `{created}`: The full date (ISO format) the document was created.
+- `{created_year}`: Year created only, formatted as the year with
+  century.
+- `{created_year_short}`: Year created only, formatted as the year
+  without century, zero padded.
+- `{created_month}`: Month created only (number 01-12).
+- `{created_month_name}`: Month created name, as per locale
+- `{created_month_name_short}`: Month created abbreviated name, as per
+  locale
+- `{created_day}`: Day created only (number 01-31).
+- `{added}`: The full date (ISO format) the document was added to
+  paperless.
+- `{added_year}`: Year added only.
+- `{added_year_short}`: Year added only, formatted as the year without
+  century, zero padded.
+- `{added_month}`: Month added only (number 01-12).
+- `{added_month_name}`: Month added name, as per locale
+- `{added_month_name_short}`: Month added abbreviated name, as per
+  locale
+- `{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.
 
 !!! warning
 
@@ -338,11 +337,6 @@ Paperless provides the following variables for use within filenames:
     you may run into the limits of your operating system's maximum path lengths.
     In that case, files will retain the previous path instead and the issue logged.
 
-!!! tip
-
-    These variables are all simple strings, but the format can be a full template.
-    See [Filename Templates](#filename-templates) for even more advanced formatting.
-
 Paperless will try to conserve the information from your database as
 much as possible. However, some characters that you can use in document
 titles and correspondent names (such as `: \ /` and a couple more) are
@@ -368,7 +362,7 @@ paperless will fall back to using the default naming scheme instead.
     However, keep in mind that inside docker, if files get stored outside of
     the predefined volumes, they will be lost after a restart.
 
-#### Empty placeholders
+##### Empty placeholders
 
 You can affect how empty placeholders are treated by changing the
 [`PAPERLESS_FILENAME_FORMAT_REMOVE_NONE`](configuration.md#PAPERLESS_FILENAME_FORMAT_REMOVE_NONE) setting.
@@ -381,10 +375,10 @@ before empty placeholders are removed as well, empty directories are omitted.
 When a single storage layout is not sufficient for your use case, storage paths allow for more complex
 structure to set precisely where each document is stored in the file system.
 
--   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
+- 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
 
 For example, you could define the following two storage paths:
 
@@ -395,8 +389,8 @@ For example, you could define the following two storage paths:
     the correspondence.
 
 ```
-By Year = {{ created_year }}/{{ correspondent }}/{{ title }}
-Insurances = Insurances/{{ correspondent }}/{{ created_year }}-{{ created_month }}-{{ created_day }} {{ title }}
+By Year = {created_year}/{correspondent}/{title}
+Insurances = Insurances/{correspondent}/{created_year}-{created_month}-{created_day} {title}
 ```
 
 If you then map these storage paths to the documents, you might get the
@@ -423,97 +417,6 @@ Insurances/                             # Insurances
     Defining a storage path is optional. If no storage path is defined for a
     document, the global [`PAPERLESS_FILENAME_FORMAT`](configuration.md#PAPERLESS_FILENAME_FORMAT) is applied.
 
-### Filename Templates {#filename-templates}
-
-The filename formatting uses [Jinja templates](https://jinja.palletsprojects.com/en/3.1.x/templates/) to build the filename.
-This allows for complex logic to be included in the format, including [logical structures](https://jinja.palletsprojects.com/en/3.1.x/templates/#list-of-control-structures)
-and [filters](https://jinja.palletsprojects.com/en/3.1.x/templates/#id11) to manipulate the [variables](#filename-format-variables)
-provided. The template is provided as a string, potentially multiline, and rendered into a single line.
-
-In addition, the entire Document instance is available to be utilized in a more advanced way, as well as some variables which only make sense to be accessed
-with more complex logic.
-
-#### Additional Variables
-
--   `{{ tag_name_list }}`: A list of tag names applied to the document, ordered by the tag name. Note this is a list, not a single string
--   `{{ custom_fields }}`: A mapping of custom field names to their type and value. A user can access the mapping by field name or check if a field is applied by checking its existence in the variable.
-
-!!! tip
-
-    To access a custom field which has a space in the name, use the `get_cf_value` filter.  See the examples below.
-    This helps get fields by name and handle a default value if the named field is not attached to a Document.
-
-#### Examples
-
-This example will construct a path based on the archive serial number range:
-
-```jinja
-somepath/
-{% if document.archive_serial_number >= 0 and document.archive_serial_number <= 200 %}
-  asn-000-200/{{title}}
-{% elif document.archive_serial_number >= 201 and document.archive_serial_number <= 400 %}
-  asn-201-400
-  {% if document.archive_serial_number >= 201 and document.archive_serial_number < 300 %}
-    /asn-2xx
-  {% elif document.archive_serial_number >= 300 and document.archive_serial_number < 400 %}
-    /asn-3xx
-  {% endif %}
-{% endif %}
-/{{ title }}
-```
-
-For a document with an ASN of 205, it would result in `somepath/asn-201-400/asn-2xx/Title.pdf`, but
-a document with an ASN of 355 would be placed in `somepath/asn-201-400/asn-3xx/Title.pdf`.
-
-```jinja
-{% if document.mime_type == "application/pdf" %}
-  pdfs
-{% elif document.mime_type == "image/png" %}
-  pngs
-{% else %}
-  others
-{% endif %}
-/{{ title }}
-```
-
-For a PDF document, it would result in `pdfs/Title.pdf`, but for a PNG document, the path would be `pngs/Title.pdf`.
-
-To use custom fields:
-
-```jinja
-{% if "Invoice" in custom_fields %}
-  invoices/{{ custom_fields.Invoice.value }}
-{% else %}
-  not-invoices/{{ title }}
-{% endif %}
-```
-
-If the document has a custom field named "Invoice" with a value of 123, it would be filed into the `invoices/123.pdf`, but a document without the custom field
-would be filed to `not-invoices/Title.pdf`
-
-If the custom field is named "Invoice Number", you would access the value of it via the `get_cf_value` filter due to quirks of the Django Template Language:
-
-```jinja
-"invoices/{{ custom_fields|get_cf_value('Invoice Number') }}"
-```
-
-You can also use a custom `datetime` filter to format dates:
-
-```jinja
-invoices/
-{{ custom_fields|get_cf_value("Date Field","2024-01-01")|datetime('%Y') }}/
-{{ custom_fields|get_cf_value("Date Field","2024-01-01")|datetime('%m') }}/
-{{ custom_fields|get_cf_value("Date Field","2024-01-01")|datetime('%d') }}/
-Invoice_{{ custom_fields|get_cf_value("Select Field") }}_{{ custom_fields|get_cf_value("Date Field","2024-01-01")|replace("-", "") }}.pdf
-```
-
-This will create a path like `invoices/2022/01/01/Invoice_OptionTwo_20220101.pdf` if the custom field "Date Field" is set to January 1, 2022 and "Select Field" is set to `OptionTwo`.
-
-## Automatic recovery of invalid PDFs {#pdf-recovery}
-
-Paperless will attempt to "clean" certain invalid PDFs with `qpdf` before processing if, for example, the mime_type
-detection is incorrect. This can happen if the PDF is not properly formatted or contains errors.
-
 ## Celery Monitoring {#celery-monitoring}
 
 The monitoring tool
@@ -532,15 +435,15 @@ installation, you can use volumes to accomplish this:
 
 ```yaml
 services:
+  # ...
+  webserver:
+    environment:
+      - PAPERLESS_ENABLE_FLOWER
+    ports:
+      - 5555:5555 # (2)!
     # ...
-    webserver:
-        environment:
-            - PAPERLESS_ENABLE_FLOWER
-        ports:
-            - 5555:5555 # (2)!
-        # ...
-        volumes:
-            - /path/to/my/flowerconfig.py:/usr/src/paperless/src/paperless/flowerconfig.py:ro # (1)!
+    volumes:
+      - /path/to/my/flowerconfig.py:/usr/src/paperless/src/paperless/flowerconfig.py:ro # (1)!
 ```
 
 1. Note the `:ro` tag means the file will be mounted as read only.
@@ -571,11 +474,11 @@ For example, using Docker Compose:
 
 ```yaml
 services:
+  # ...
+  webserver:
     # ...
-    webserver:
-        # ...
-        volumes:
-            - /path/to/my/scripts:/custom-cont-init.d:ro # (1)!
+    volumes:
+      - /path/to/my/scripts:/custom-cont-init.d:ro # (1)!
 ```
 
 1. Note the `:ro` tag means the folder will be mounted as read only. This is for extra security against changes
@@ -585,13 +488,10 @@ services:
 ### Case Sensitivity
 
 The database interface does not provide a method to configure a MySQL
-database to be case-sensitive. A case-**in**sensitive database prevents a user from creating a
+database to be case sensitive. This would prevent a user from creating a
 tag `Name` and `NAME` as they are considered the same.
 
-However, there is a downside to turning on case sensitivity, as it also makes searches case-sensitive,
-so for example a document with the title `Invoice` won't be found when searching for `invoice`.
-
-Per Django documentation, making a database case-sensitive requires manual intervention.
+Per Django documentation, to enable this requires manual intervention.
 To enable case sensitive tables, you can execute the following command
 against each table:
 
@@ -608,8 +508,6 @@ existing tables) with:
     an older system may fix issues that can arise while setting up Paperless-ngx but
     `utf8mb3` can cause issues with consumption (where `utf8mb4` does not).
 
-For more information on this topic, you can refer to [this](https://code.djangoproject.com/ticket/9682) Django issue.
-
 ### Missing timezones
 
 MySQL as well as MariaDB do not have any timezone information by default (though some
@@ -628,16 +526,16 @@ Paperless is able to utilize barcodes for automatically performing some tasks.
 
 At this time, the library utilized for detection of barcodes supports the following types:
 
--   AN-13/UPC-A
--   UPC-E
--   EAN-8
--   Code 128
--   Code 93
--   Code 39
--   Codabar
--   Interleaved 2 of 5
--   QR Code
--   SQ Code
+- AN-13/UPC-A
+- UPC-E
+- EAN-8
+- Code 128
+- Code 93
+- Code 39
+- Codabar
+- Interleaved 2 of 5
+- QR Code
+- SQ Code
 
 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.
@@ -789,59 +687,4 @@ More details about configuration option for various providers can be found in th
 
 ### Disabling Regular Login
 
-Once external auth is set up, 'regular' login can be disabled with the [PAPERLESS_DISABLE_REGULAR_LOGIN](configuration.md#PAPERLESS_DISABLE_REGULAR_LOGIN) setting and / or users can be automatically
-redirected with the [PAPERLESS_REDIRECT_LOGIN_TO_SSO](configuration.md#PAPERLESS_REDIRECT_LOGIN_TO_SSO) setting.
-
-## Decryption of encrypted emails before consumption {#gpg-decryptor}
-
-Paperless-ngx can be configured to decrypt gpg encrypted emails before consumption.
-
-### Requirements
-
-You need a recent version of `gpg-agent >= 2.1.1` installed on your host.
-Your host needs to be setup for decrypting your emails via `gpg-agent`, see this [tutorial](https://www.digitalocean.com/community/tutorials/how-to-use-gpg-to-encrypt-and-sign-messages#encrypt-and-decrypt-messages-with-gpg) for instance.
-Test your setup and make sure that you can encrypt and decrypt files using your key
-
-```
-gpg --encrypt --armor -r person@email.com name_of_file
-gpg --decrypt name_of_file.asc
-```
-
-### Setup
-
-First, enable the [PAPERLESS_ENABLE_GPG_DECRYPTOR environment variable](configuration.md#PAPERLESS_ENABLE_GPG_DECRYPTOR).
-
-Then determine your local `gpg-agent` socket by invoking
-
-```
-gpgconf --list-dir agent-socket
-```
-
-on your host. A possible output is `~/.gnupg/S.gpg-agent`.
-Also find the location of your public keyring.
-
-If using docker, you'll need to add the following volume mounts to your `docker-compose.yml` file:
-
-```yaml
-webserver:
-    volumes:
-        - /home/user/.gnupg/pubring.gpg:/usr/src/paperless/.gnupg/pubring.gpg
-        - <path to gpg-agent socket>:/usr/src/paperless/.gnupg/S.gpg-agent
-```
-
-For a 'bare-metal' installation no further configuration is necessary. If you
-want to use a separate `GNUPG_HOME`, you can do so by configuring the [PAPERLESS_EMAIL_GNUPG_HOME environment variable](configuration.md#PAPERLESS_EMAIL_GNUPG_HOME).
-
-### Troubleshooting
-
--   Make sure, that `gpg-agent` is running on your host machine
--   Make sure, that encryption and decryption works from inside the container using the `gpg` commands from above.
--   Check that all files in `/usr/src/paperless/.gnupg` have correct permissions
-
-```shell
-paperless@9da1865df327:~/.gnupg$ ls -al
-drwx------ 1 paperless paperless   4096 Aug 18 17:52 .
-drwxr-xr-x 1 paperless paperless   4096 Aug 18 17:52 ..
-srw------- 1 paperless paperless      0 Aug 18 17:22 S.gpg-agent
--rw------- 1 paperless paperless 147940 Jul 24 10:23 pubring.gpg
-```
+Once external auth is set up, 'regular' login can be disabled with the [PAPERLESS_DISABLE_REGULAR_LOGIN](configuration.md#PAPERLESS_DISABLE_REGULAR_LOGIN) setting.

docs/api.md

@@ -8,23 +8,22 @@ most of the available filters and ordering fields.
 
 The API provides the following main endpoints:
 
--   `/api/correspondents/`: Full CRUD support.
--   `/api/custom_fields/`: Full CRUD support.
--   `/api/documents/`: Full CRUD support, except POSTing new documents.
-    See [below](#file-uploads).
--   `/api/document_types/`: Full CRUD support.
--   `/api/groups/`: Full CRUD support.
--   `/api/logs/`: Read-Only.
--   `/api/mail_accounts/`: Full CRUD support.
--   `/api/mail_rules/`: Full CRUD support.
--   `/api/profile/`: GET, PATCH
--   `/api/share_links/`: Full CRUD support.
--   `/api/storage_paths/`: Full CRUD support.
--   `/api/tags/`: Full CRUD support.
--   `/api/tasks/`: Read-only.
--   `/api/users/`: Full CRUD support.
--   `/api/workflows/`: Full CRUD support.
--   `/api/search/` GET, see [below](#global-search).
+- `/api/correspondents/`: Full CRUD support.
+- `/api/custom_fields/`: Full CRUD support.
+- `/api/documents/`: Full CRUD support, except POSTing new documents.
+  See below.
+- `/api/document_types/`: Full CRUD support.
+- `/api/groups/`: Full CRUD support.
+- `/api/logs/`: Read-Only.
+- `/api/mail_accounts/`: Full CRUD support.
+- `/api/mail_rules/`: Full CRUD support.
+- `/api/profile/`: GET, PATCH
+- `/api/share_links/`: Full CRUD support.
+- `/api/storage_paths/`: Full CRUD support.
+- `/api/tags/`: Full CRUD support.
+- `/api/tasks/`: Read-only.
+- `/api/users/`: Full CRUD support.
+- `/api/workflows/`: 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
@@ -33,32 +32,31 @@ appending their primary key to the path, e.g. `/api/documents/454/`.
 The objects served by the document endpoint contain the following
 fields:
 
--   `id`: ID of the document. Read-only.
--   `title`: Title of the document.
--   `content`: Plain text content of the document.
--   `tags`: List of IDs of tags assigned to this document, or empty
-    list.
--   `document_type`: Document type of this document, or null.
--   `correspondent`: Correspondent of this document or null.
--   `created`: The date time at which this document was created.
--   `created_date`: The date (YYYY-MM-DD) at which this document was
-    created. Optional. If also passed with created, this is ignored.
--   `modified`: The date at which this document was last edited in
-    paperless. Read-only.
--   `added`: The date at which this document was added to paperless.
-    Read-only.
--   `archive_serial_number`: The identifier of this document in a
-    physical document archive.
--   `original_file_name`: Verbose filename of the original document.
-    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.
--   `page_count`: Number of pages.
--   `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 }`
+- `id`: ID of the document. Read-only.
+- `title`: Title of the document.
+- `content`: Plain text content of the document.
+- `tags`: List of IDs of tags assigned to this document, or empty
+  list.
+- `document_type`: Document type of this document, or null.
+- `correspondent`: Correspondent of this document or null.
+- `created`: The date time at which this document was created.
+- `created_date`: The date (YYYY-MM-DD) at which this document was
+  created. Optional. If also passed with created, this is ignored.
+- `modified`: The date at which this document was last edited in
+  paperless. Read-only.
+- `added`: The date at which this document was added to paperless.
+  Read-only.
+- `archive_serial_number`: The identifier of this document in a
+  physical document archive.
+- `original_file_name`: Verbose filename of the original document.
+  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 }`
 
 !!! note
 
@@ -69,11 +67,11 @@ fields:
 In addition to that, the document endpoint offers these additional
 actions on individual documents:
 
--   `/api/documents/<pk>/download/`: Download the document.
--   `/api/documents/<pk>/preview/`: Display the document inline, without
-    downloading it.
--   `/api/documents/<pk>/thumb/`: Download the PNG thumbnail of a
-    document.
+- `/api/documents/<pk>/download/`: Download the document.
+- `/api/documents/<pk>/preview/`: Display the document inline, without
+  downloading it.
+- `/api/documents/<pk>/thumb/`: Download the PNG thumbnail of a
+  document.
 
 Paperless generates archived PDF/A documents from consumed files and
 stores both the original files as well as the archived files. By
@@ -107,30 +105,30 @@ Access the metadata of a document with an ID `id` at
 
 The endpoint reports the following data:
 
--   `original_checksum`: MD5 checksum of the original document.
--   `original_size`: Size of the original document, in bytes.
--   `original_mime_type`: Mime type of the original document.
--   `media_filename`: Current filename of the document, under which it
-    is stored inside the media directory.
--   `has_archive_version`: True, if this document is archived, false
-    otherwise.
--   `original_metadata`: A list of metadata associated with the original
-    document. See below.
--   `archive_checksum`: MD5 checksum of the archived document, or null.
--   `archive_size`: Size of the archived document in bytes, or null.
--   `archive_metadata`: Metadata associated with the archived document,
-    or null. See below.
+- `original_checksum`: MD5 checksum of the original document.
+- `original_size`: Size of the original document, in bytes.
+- `original_mime_type`: Mime type of the original document.
+- `media_filename`: Current filename of the document, under which it
+  is stored inside the media directory.
+- `has_archive_version`: True, if this document is archived, false
+  otherwise.
+- `original_metadata`: A list of metadata associated with the original
+  document. See below.
+- `archive_checksum`: MD5 checksum of the archived document, or null.
+- `archive_size`: Size of the archived document in bytes, or null.
+- `archive_metadata`: Metadata associated with the archived document,
+  or null. See below.
 
 File metadata is reported as a list of objects in the following form:
 
 ```json
 [
-    {
-        "namespace": "http://ns.adobe.com/pdf/1.3/",
-        "prefix": "pdf",
-        "key": "Producer",
-        "value": "SparklePDF, Fancy edition"
-    }
+  {
+    "namespace": "http://ns.adobe.com/pdf/1.3/",
+    "prefix": "pdf",
+    "key": "Producer",
+    "value": "SparklePDF, Fancy edition"
+  }
 ]
 ```
 
@@ -140,9 +138,9 @@ 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.
--   `/api/documents/<id>/history/`: Retrieve history of changes for a document.
+- `/api/documents/<id>/notes/`: Retrieve notes for a document.
+- `/api/documents/<id>/share_links/`: Retrieve share links for a document.
+- `/api/documents/<id>/history/`: Retrieve history of changes for a document.
 
 ## Authorization
 
@@ -190,52 +188,26 @@ The REST api provides four different forms of authentication.
     [configuration](configuration.md#PAPERLESS_ENABLE_HTTP_REMOTE_USER_API)),
     you can authenticate against the API using Remote User auth.
 
-## Global search
-
-A global search endpoint is available at `/api/search/` and requires a search term
-of > 2 characters e.g. `?query=foo`. This endpoint returns a maximum of 3 results
-across nearly all objects, e.g. documents, tags, saved views, mail rules, etc.
-Results are only included if the requesting user has the appropriate permissions.
-
-Results are returned in the following format:
-
-```json
-{
-  total: number
-  documents: []
-  saved_views: []
-  correspondents: []
-  document_types: []
-  storage_paths: []
-  tags: []
-  users: []
-  groups: []
-  mail_accounts: []
-  mail_rules: []
-  custom_fields: []
-  workflows: []
-}
-```
-
-Global search first searches objects by name (or title for documents) matching the query.
-If the optional `db_only` parameter is set, only document titles will be searched. Otherwise,
-if the amount of documents returned by a simple title string search is < 3, results from the
-search index will also be included.
-
 ## Searching for documents
 
 Full text searching is available on the `/api/documents/` endpoint. Two
 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.md#basic-usage_searching).
--   `/api/documents/?more_like_id=1234`: Search for documents similar to
-    the document with id 1234.
+- `/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.md#basic-usage_searching).
+- `/api/documents/?more_like_id=1234`: Search for documents similar to
+  the document with id 1234.
 
 Pagination works exactly the same as it does for normal requests on this
 endpoint.
 
+Certain limitations apply to full text queries:
+
+- Results are always sorted by search score. The results matching the
+  query best will show up first.
+- Only a small subset of filtering parameters are supported.
+
 Furthermore, each returned document has an additional `__search_hit__`
 attribute with various information about the search results:
 
@@ -268,57 +240,12 @@ attribute with various information about the search results:
 }
 ```
 
--   `score` is an indication how well this document matches the query
-    relative to the other search results.
--   `highlights` is an excerpt from the document content and highlights
-    the search terms with `<span>` tags as shown above.
--   `rank` is the index of the search results. The first result will
-    have rank 0.
-
-### Filtering by custom fields
-
-You can filter documents by their custom field values by specifying the
-`custom_field_query` query parameter. Here are some recipes for common
-use cases:
-
-1. Documents with a custom field "due" (date) between Aug 1, 2024 and
-   Sept 1, 2024 (inclusive):
-
-    `?custom_field_query=["due", "range", ["2024-08-01", "2024-09-01"]]`
-
-2. Documents with a custom field "customer" (text) that equals "bob"
-   (case sensitive):
-
-    `?custom_field_query=["customer", "exact", "bob"]`
-
-3. Documents with a custom field "answered" (boolean) set to `true`:
-
-    `?custom_field_query=["answered", "exact", true]`
-
-4. Documents with a custom field "favorite animal" (select) set to either
-   "cat" or "dog":
-
-    `?custom_field_query=["favorite animal", "in", ["cat", "dog"]]`
-
-5. Documents with a custom field "address" (text) that is empty:
-
-    `?custom_field_query=["OR", ["address", "isnull", true], ["address", "exact", ""]]`
-
-6. Documents that don't have a field called "foo":
-
-    `?custom_field_query=["foo", "exists", false]`
-
-7. Documents that have document links "references" to both document 3 and 7:
-
-    `?custom_field_query=["references", "contains", [3, 7]]`
-
-All field types support basic operations including `exact`, `in`, `isnull`,
-and `exists`. String, URL, and monetary fields support case-insensitive
-substring matching operations including `icontains`, `istartswith`, and
-`iendswith`. Integer, float, and date fields support arithmetic comparisons
-including `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), and `range`.
-Lastly, document link fields support a `contains` operator that behaves
-like a "is superset of" check.
+- `score` is an indication how well this document matches the query
+  relative to the other search results.
+- `highlights` is an excerpt from the document content and highlights
+  the search terms with `<span>` tags as shown above.
+- `rank` is the index of the search results. The first result will
+  have rank 0.
 
 ### `/api/search/autocomplete/`
 
@@ -326,8 +253,8 @@ Get auto completions for a partial search term.
 
 Query parameters:
 
--   `term`: The incomplete term.
--   `limit`: Amount of results. Defaults to 10.
+- `term`: The incomplete term.
+- `limit`: Amount of results. Defaults to 10.
 
 Results returned by the endpoint are ordered by importance of the term
 in the document index. The first result is the term that has the highest
@@ -351,23 +278,19 @@ from there.
 
 The endpoint supports the following optional form fields:
 
--   `title`: Specify a title that the consumer should use for the
-    document.
--   `created`: Specify a DateTime where the document was created (e.g.
-    "2016-04-19" or "2016-04-19 06:15:00+02:00").
--   `correspondent`: Specify the ID of a correspondent that the consumer
-    should use for the document.
--   `document_type`: Similar to correspondent.
--   `storage_path`: Similar to correspondent.
--   `tags`: Similar to correspondent. Specify this multiple times to
-    have multiple tags added to the document.
--   `archive_serial_number`: An optional archive serial number to set.
--   `custom_fields`: An array of custom field ids to assign (with an empty
-    value) to the document.
-
-!!! note
-
-    Sending a `Content-Length` header with correct size is mandatory.
+- `title`: Specify a title that the consumer should use for the
+  document.
+- `created`: Specify a DateTime where the document was created (e.g.
+  "2016-04-19" or "2016-04-19 06:15:00+02:00").
+- `correspondent`: Specify the ID of a correspondent that the consumer
+  should use for the document.
+- `document_type`: Similar to correspondent.
+- `storage_path`: Similar to correspondent.
+- `tags`: Similar to correspondent. Specify this multiple times to
+  have multiple tags added to the document.
+- `archive_serial_number`: An optional archive serial number to set.
+- `custom_fields`: An array of custom field ids to assign (with an empty
+  value) to the document.
 
 The endpoint will immediately return HTTP 200 if the document consumption
 process was started successfully, with the UUID of the consumption task
@@ -433,55 +356,41 @@ a json payload of the format:
 
 The following methods are supported:
 
--   `set_correspondent`
-    -   Requires `parameters`: `{ "correspondent": CORRESPONDENT_ID }`
--   `set_document_type`
-    -   Requires `parameters`: `{ "document_type": DOCUMENT_TYPE_ID }`
--   `set_storage_path`
-    -   Requires `parameters`: `{ "storage_path": STORAGE_PATH_ID }`
--   `add_tag`
-    -   Requires `parameters`: `{ "tag": TAG_ID }`
--   `remove_tag`
-    -   Requires `parameters`: `{ "tag": TAG_ID }`
--   `modify_tags`
-    -   Requires `parameters`: `{ "add_tags": [LIST_OF_TAG_IDS] }` and / or `{ "remove_tags": [LIST_OF_TAG_IDS] }`
--   `delete`
-    -   No `parameters` required
--   `reprocess`
-    -   No `parameters` required
--   `set_permissions`
-    -   Requires `parameters`:
-        -   `"set_permissions": PERMISSIONS_OBJ` (see format [above](#permissions)) and / or
-        -   `"owner": OWNER_ID or null`
-        -   `"merge": true or false` (defaults to false)
-    -   The `merge` flag determines if the supplied permissions will overwrite all existing permissions (including
-        removing them) or be merged with existing permissions.
--   `merge`
-    -   No additional `parameters` required.
-    -   The ordering of the merged document is determined by the list of IDs.
-    -   Optional `parameters`:
-        -   `"metadata_document_id": DOC_ID` apply metadata (tags, correspondent, etc.) from this document to the merged document.
-        -   `"delete_originals": true` to delete the original documents. This requires the calling user being the owner of
-            all documents that are merged.
--   `split`
-    -   Requires `parameters`:
-        -   `"pages": [..]` The list should be a list of pages and/or a ranges, separated by commas e.g. `"[1,2-3,4,5-7]"`
-    -   Optional `parameters`:
-        -   `"delete_originals": true` to delete the original document after consumption. This requires the calling user being the owner of
-            the document.
-    -   The split operation only accepts a single document.
--   `rotate`
-    -   Requires `parameters`:
-        -   `"degrees": DEGREES`. Must be an integer i.e. 90, 180, 270
--   `delete_pages`
-    -   Requires `parameters`:
-        -   `"pages": [..]` The list should be a list of integers e.g. `"[2,3,4]"`
-    -   The delete_pages operation only accepts a single document.
--   `modify_custom_fields`
-    -   Requires `parameters`:
-        -   `"add_custom_fields": { CUSTOM_FIELD_ID: VALUE }`: JSON object consisting of custom field id:value pairs to add to the document, can also be a list of custom field IDs
-            to add with empty values.
-        -   `"remove_custom_fields": [CUSTOM_FIELD_ID]`: custom field ids to remove from the document.
+- `set_correspondent`
+  - Requires `parameters`: `{ "correspondent": CORRESPONDENT_ID }`
+- `set_document_type`
+  - Requires `parameters`: `{ "document_type": DOCUMENT_TYPE_ID }`
+- `set_storage_path`
+  - Requires `parameters`: `{ "storage_path": STORAGE_PATH_ID }`
+- `add_tag`
+  - Requires `parameters`: `{ "tag": TAG_ID }`
+- `remove_tag`
+  - Requires `parameters`: `{ "tag": TAG_ID }`
+- `modify_tags`
+  - Requires `parameters`: `{ "add_tags": [LIST_OF_TAG_IDS] }` and / or `{ "remove_tags": [LIST_OF_TAG_IDS] }`
+- `delete`
+  - No `parameters` required
+- `redo_ocr`
+  - No `parameters` required
+- `set_permissions`
+  - Requires `parameters`:
+    - `"permissions": PERMISSIONS_OBJ` (see format [above](#permissions)) and / or
+    - `"owner": OWNER_ID or null`
+    - `"merge": true or false` (defaults to false)
+  - The `merge` flag determines if the supplied permissions will overwrite all existing permissions (including
+    removing them) or be merged with existing permissions.
+- `merge`
+  - No additional `parameters` required.
+  - The ordering of the merged document is determined by the list of IDs.
+  - Optional `parameters`:
+    - `"metadata_document_id": DOC_ID` apply metadata (tags, correspondent, etc.) from this document to the merged document.
+- `split`
+  - Requires `parameters`:
+    - `"pages": [..]` The list should be a list of pages and/or a ranges, separated by commas e.g. `"[1,2-3,4,5-7]"`
+  - The split operation only accepts a single document.
+- `rotate`
+  - Requires `parameters`:
+    - `"degrees": DEGREES`. Must be an integer i.e. 90, 180, 270
 
 ### Objects
 
@@ -503,16 +412,16 @@ operations, using the endpoint: `/api/bulk_edit_objects/`, which requires a json
 
 The REST API is versioned since Paperless-ngx 1.3.0.
 
--   Versioning ensures that changes to the API don't break older
-    clients.
--   Clients specify the specific version of the API they wish to use
-    with every request and Paperless will handle the request using the
-    specified API version.
--   Even if the underlying data model changes, older API versions will
-    always serve compatible data.
--   If no version is specified, Paperless will serve version 1 to ensure
-    compatibility with older clients that do not request a specific API
-    version.
+- Versioning ensures that changes to the API don't break older
+  clients.
+- Clients specify the specific version of the API they wish to use
+  with every request and Paperless will handle the request using the
+  specified API version.
+- Even if the underlying data model changes, older API versions will
+  always serve compatible data.
+- If no version is specified, Paperless will serve version 1 to ensure
+  compatibility with older clients that do not request a specific API
+  version.
 
 API versions are specified by submitting an additional HTTP `Accept`
 header with every request:
@@ -549,27 +458,19 @@ Initial API version.
 
 #### Version 2
 
--   Added field `Tag.color`. This read/write string field contains a hex
-    color such as `#a6cee3`.
--   Added read-only field `Tag.text_color`. This field contains the text
-    color to use for a specific tag, which is either black or white
-    depending on the brightness of `Tag.color`.
--   Removed field `Tag.colour`.
+- Added field `Tag.color`. This read/write string field contains a hex
+  color such as `#a6cee3`.
+- Added read-only field `Tag.text_color`. This field contains the text
+  color to use for a specific tag, which is either black or white
+  depending on the brightness of `Tag.color`.
+- Removed field `Tag.colour`.
 
 #### Version 3
 
--   Permissions endpoints have been added.
--   The format of the `/api/ui_settings/` has changed.
+- Permissions endpoints have been added.
+- The format of the `/api/ui_settings/` has changed.
 
 #### Version 4
 
--   Consumption templates were refactored to workflows and API endpoints
-    changed as such.
-
-#### Version 5
-
--   Added bulk deletion methods for documents and objects.
-
-#### Version 6
-
--   Moved acknowledge tasks endpoint to be under `/api/tasks/acknowledge/`.
+- Consumption templates were refactored to workflows and API endpoints
+  changed as such.

docs/assets/extra.css

@@ -10,7 +10,7 @@
     --md-hue: 222;
 }
 
-@media (min-width: 768px) {
+@media (min-width: 400px) {
     .grid-left {
         width: 33%;
         float: left;

docs/configuration.md

@@ -8,17 +8,17 @@ common [OCR](#ocr) related settings and some frontend settings. If set, these wi
 preference over the settings via environment variables. If not set, the environment setting
 or applicable default will be utilized instead.
 
--   If you run paperless on docker, `paperless.conf` is not used.
-    Rather, configure paperless by copying necessary options to
-    `docker-compose.env`.
+- If you run paperless on docker, `paperless.conf` is not used.
+  Rather, configure paperless by copying necessary options to
+  `docker-compose.env`.
 
--   If you are running paperless on anything else, paperless will search
-    for the configuration file in these locations and use the first one
-    it finds:
-    -   The environment variable `PAPERLESS_CONFIGURATION_PATH`
-    -   `/path/to/paperless/paperless.conf`
-    -   `/etc/paperless.conf`
-    -   `/usr/local/etc/paperless.conf`
+- If you are running paperless on anything else, paperless will search
+  for the configuration file in these locations and use the first one
+  it finds:
+  - The environment variable `PAPERLESS_CONFIGURATION_PATH`
+  - `/path/to/paperless/paperless.conf`
+  - `/etc/paperless.conf`
+  - `/usr/local/etc/paperless.conf`
 
 ## Required services
 
@@ -38,7 +38,7 @@ matcher.
         `redis://<username>:<password>@<host>:<port>/<DBIndex>`
 
     [More information on securing your Redis
-    Instance](https://redis.io/docs/latest/operate/oss_and_stack/management/security).
+    Instance](https://redis.io/docs/getting-started/#securing-redis).
 
     Defaults to `redis://localhost:6379`.
 
@@ -177,13 +177,13 @@ configure their endpoints, and enable the feature.
 
 #### [`PAPERLESS_TIKA_ENDPOINT=<url>`](#PAPERLESS_TIKA_ENDPOINT) {#PAPERLESS_TIKA_ENDPOINT}
 
-: Set the endpoint URL where Paperless can reach your Tika server.
+: Set the endpoint URL were Paperless can reach your Tika server.
 
     Defaults to "<http://localhost:9998>".
 
 #### [`PAPERLESS_TIKA_GOTENBERG_ENDPOINT=<url>`](#PAPERLESS_TIKA_GOTENBERG_ENDPOINT) {#PAPERLESS_TIKA_GOTENBERG_ENDPOINT}
 
-: Set the endpoint URL where Paperless can reach your Gotenberg server.
+: Set the endpoint URL were Paperless can reach your Gotenberg server.
 
     Defaults to "<http://localhost:3000>".
 
@@ -202,7 +202,7 @@ and watch out for indentation if editing the YAML file.
 
 #### [`PAPERLESS_CONSUMPTION_DIR=<path>`](#PAPERLESS_CONSUMPTION_DIR) {#PAPERLESS_CONSUMPTION_DIR}
 
-: This is where your documents should go to be consumed. Make sure that
+: This where your documents should go to be consumed. Make sure that
 it exists and that the user running the paperless service can
 read/write its contents before you start Paperless.
 
@@ -219,10 +219,10 @@ database, classification model, etc).
 
     Defaults to "../data/", relative to the "src" directory.
 
-#### [`PAPERLESS_EMPTY_TRASH_DIR=<path>`](#PAPERLESS_EMPTY_TRASH_DIR) {#PAPERLESS_EMPTY_TRASH_DIR}
+#### [`PAPERLESS_TRASH_DIR=<path>`](#PAPERLESS_TRASH_DIR) {#PAPERLESS_TRASH_DIR}
 
-: When documents are deleted (e.g. after emptying the trash) the original files will be moved here
-instead of being removed from the filesystem. Only the original version is kept.
+: Instead of removing deleted documents, they are moved to this
+directory.
 
     This must be writeable by the user running paperless. When running
     inside docker, ensure that this path is within a permanent volume
@@ -230,9 +230,7 @@ instead of being removed from the filesystem. Only the original version is kept.
 
     Note that the directory must exist prior to using this setting.
 
-    Defaults to empty (i.e. really delete files).
-
-    This setting was previously named PAPERLESS_TRASH_DIR.
+    Defaults to empty (i.e. really delete documents).
 
 #### [`PAPERLESS_MEDIA_ROOT=<path>`](#PAPERLESS_MEDIA_ROOT) {#PAPERLESS_MEDIA_ROOT}
 
@@ -290,12 +288,6 @@ this folder is no longer needed and can be removed manually.
 
 Defaults to `/usr/share/nltk_data`
 
-#### [`PAPERLESS_MODEL_FILE=<path>`](#PAPERLESS_MODEL_FILE) {#PAPERLESS_MODEL_FILE}
-
-: This is where paperless will store the classification model.
-
-    Defaults to `PAPERLESS_DATA_DIR/classification_model.pickle`.
-
 ## Logging
 
 #### [`PAPERLESS_LOGROTATE_MAX_SIZE=<num>`](#PAPERLESS_LOGROTATE_MAX_SIZE) {#PAPERLESS_LOGROTATE_MAX_SIZE}
@@ -594,32 +586,15 @@ system. See the corresponding
 
 #### [`PAPERLESS_DISABLE_REGULAR_LOGIN=<bool>`](#PAPERLESS_DISABLE_REGULAR_LOGIN) {#PAPERLESS_DISABLE_REGULAR_LOGIN}
 
-: Disables the regular frontend username / password login, i.e. once you have setup SSO. Note that this setting does not disable the Django admin login nor logging in with local credentials via the API. To prevent access to the Django admin, consider blocking `/admin/` in your [web server or reverse proxy configuration](https://github.com/paperless-ngx/paperless-ngx/wiki/Using-a-Reverse-Proxy-with-Paperless-ngx).
-
-    You can optionally also automatically redirect users to the SSO login with [PAPERLESS_REDIRECT_LOGIN_TO_SSO](#PAPERLESS_REDIRECT_LOGIN_TO_SSO)
-
-    Defaults to False
-
-#### [`PAPERLESS_REDIRECT_LOGIN_TO_SSO=<bool>`](#PAPERLESS_REDIRECT_LOGIN_TO_SSO) {#PAPERLESS_REDIRECT_LOGIN_TO_SSO}
-
-: When this setting is enabled users will automatically be redirected (using javascript) to the first SSO provider login. You may still want to disable the frontend login form for clarity.
+: Disables the regular frontend username / password login, i.e. once you have setup SSO. Note that this setting does not disable the Django admin login. To prevent logins directly to Django, consider blocking `/admin/` in your [web server or reverse proxy configuration](https://github.com/paperless-ngx/paperless-ngx/wiki/Using-a-Reverse-Proxy-with-Paperless-ngx).
 
     Defaults to False
 
 #### [`PAPERLESS_ACCOUNT_SESSION_REMEMBER=<bool>`](#PAPERLESS_ACCOUNT_SESSION_REMEMBER) {#PAPERLESS_ACCOUNT_SESSION_REMEMBER}
 
-: If false, sessions will expire at browser close, if true will use `PAPERLESS_SESSION_COOKIE_AGE` for expiration. See the corresponding
+: See the corresponding
 [django-allauth documentation](https://docs.allauth.org/en/latest/account/configuration.html)
 
-    Defaults to True
-
-#### [`PAPERLESS_SESSION_COOKIE_AGE=<int>`](#PAPERLESS_SESSION_COOKIE_AGE) {#PAPERLESS_SESSION_COOKIE_AGE}
-
-: Login session cookie expiration. Applies if `PAPERLESS_ACCOUNT_SESSION_REMEMBER` is enabled. See the corresponding
-[django documentation](https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-SESSION_COOKIE_AGE)
-
-    Defaults to 1209600 (2 weeks)
-
 ## OCR settings {#ocr}
 
 Paperless uses [OCRmyPDF](https://ocrmypdf.readthedocs.io/en/latest/)
@@ -641,8 +616,6 @@ parsing documents.
     Keep in mind that Tesseract uses much more CPU time with multiple
     languages enabled.
 
-    If you are including languages that are not installed by default, you will need to also set [`PAPERLESS_OCR_LANGUAGES`](configuration.md#PAPERLESS_OCR_LANGUAGES) for docker deployments or install the tesseract language packages manually for bare metal installations.
-
     Defaults to "eng".
 
     !!! note
@@ -1113,7 +1086,7 @@ document text will be checked as normal.
 
 : Paperless searches an entire document for dates. The first date
 found will be used as the initial value for the created date. When
-this variable is greater than 0 (or left to its default value),
+this variable is greater than 0 (or left to it's default value),
 paperless will also suggest other dates found in the document, up to
 a maximum of this setting. Note that duplicates will be removed,
 which can result in fewer dates displayed in the frontend than this
@@ -1138,11 +1111,11 @@ This font can be changed here.
 
 #### [`PAPERLESS_IGNORE_DATES=<string>`](#PAPERLESS_IGNORE_DATES) {#PAPERLESS_IGNORE_DATES}
 
-: Paperless parses a document's creation date from filename and file
+: Paperless parses a documents creation date from filename and file
 content. You may specify a comma separated list of dates that should
 be ignored during this process. This is useful for special dates
 (like date of birth) that appear in documents regularly but are very
-unlikely to be the document's creation date.
+unlikely to be the documents creation date.
 
     The date is parsed using the order specified in PAPERLESS_DATE_ORDER
 
@@ -1158,12 +1131,6 @@ within your documents.
     second, and year last order. Characters D, M, or Y can be shuffled
     to meet the required order.
 
-#### [`PAPERLESS_ENABLE_GPG_DECRYPTOR=<bool>`](#PAPERLESS_ENABLE_GPG_DECRYPTOR) {#PAPERLESS_ENABLE_GPG_DECRYPTOR}
-
-: Enable or disable the GPG decryptor for encrypted emails. See [GPG Decryptor](advanced_usage.md#gpg-decryptor) for more information.
-
-    Defaults to false.
-
 ### Polling {#polling}
 
 #### [`PAPERLESS_CONSUMER_POLLING=<num>`](#PAPERLESS_CONSUMER_POLLING) {#PAPERLESS_CONSUMER_POLLING}
@@ -1207,52 +1174,6 @@ consumers working on the same file. Configure this to prevent that.
 
     Defaults to 0.5 seconds.
 
-## Incoming Mail {#incoming_mail}
-
-### Email OAuth {#email_oauth}
-
-#### [`PAPERLESS_OAUTH_CALLBACK_BASE_URL=<str>`](#PAPERLESS_OAUTH_CALLBACK_BASE_URL) {#PAPERLESS_OAUTH_CALLBACK_BASE_URL}
-
-: The base URL for the OAuth callback. This is used to construct the full URL for the OAuth callback. This should be the URL that the Paperless instance is accessible at. If not set, defaults to the `PAPERLESS_URL` setting. At least one of these settings must be set to enable OAuth Email setup.
-
-    Defaults to none (thus will use [PAPERLESS_URL](#PAPERLESS_URL)).
-
-!!! note
-
-    This setting only applies to OAuth Email setup (not to the SSO setup).
-
-#### [`PAPERLESS_GMAIL_OAUTH_CLIENT_ID=<str>`](#PAPERLESS_GMAIL_OAUTH_CLIENT_ID) {#PAPERLESS_GMAIL_OAUTH_CLIENT_ID}
-
-: The OAuth client ID for Gmail. This is required for Gmail OAuth Email setup. See [OAuth Email Setup](usage.md#oauth-email-setup) for more information.
-
-    Defaults to none.
-
-#### [`PAPERLESS_GMAIL_OAUTH_CLIENT_SECRET=<str>`](#PAPERLESS_GMAIL_OAUTH_CLIENT_SECRET) {#PAPERLESS_GMAIL_OAUTH_CLIENT_SECRET}
-
-: The OAuth client secret for Gmail. This is required for Gmail OAuth Email setup. See [OAuth Email Setup](usage.md#oauth-email-setup) for more information.
-
-    Defaults to none.
-
-#### [`PAPERLESS_OUTLOOK_OAUTH_CLIENT_ID=<str>`](#PAPERLESS_OUTLOOK_OAUTH_CLIENT_ID) {#PAPERLESS_OUTLOOK_OAUTH_CLIENT_ID}
-
-: The OAuth client ID for Outlook. This is required for Outlook OAuth Email setup. See [OAuth Email Setup](usage.md#oauth-email-setup) for more information.
-
-    Defaults to none.
-
-#### [`PAPERLESS_OUTLOOK_OAUTH_CLIENT_SECRET=<str>`](#PAPERLESS_OUTLOOK_OAUTH_CLIENT_SECRET) {#PAPERLESS_OUTLOOK_OAUTH_CLIENT_SECRET}
-
-: The OAuth client secret for Outlook. This is required for Outlook OAuth Email setup. See [OAuth Email Setup](usage.md#oauth-email-setup) for more information.
-
-    Defaults to none.
-
-### Encrypted Emails {#encrypted_emails}
-
-#### [`PAPERLESS_EMAIL_GNUPG_HOME=<str>`](#PAPERLESS_EMAIL_GNUPG_HOME) {#PAPERLESS_EMAIL_GNUPG_HOME}
-
-: Optional, sets the `GNUPG_HOME` path to use with GPG decryptor for encrypted emails. See [GPG Decryptor](advanced_usage.md#gpg-decryptor) for more information. If not set, defaults to the default `GNUPG_HOME` path.
-
-    Defaults to <not set>.
-
 ## Barcodes {#barcodes}
 
 #### [`PAPERLESS_CONSUMER_ENABLE_BARCODES=<bool>`](#PAPERLESS_CONSUMER_ENABLE_BARCODES) {#PAPERLESS_CONSUMER_ENABLE_BARCODES}
@@ -1291,12 +1212,6 @@ change this.
 
     Defaults to "PATCHT"
 
-#### [`PAPERLESS_CONSUMER_BARCODE_RETAIN_SPLIT_PAGES=<bool>`](#PAPERLESS_CONSUMER_BARCODE_RETAIN_SPLIT_PAGES) {#PAPERLESS_CONSUMER_BARCODE_RETAIN_SPLIT_PAGES}
-
-: If set to true, all pages that are split by a barcode (such as PATCHT) will be kept.
-
-    Defaults to false.
-
 #### [`PAPERLESS_CONSUMER_ENABLE_ASN_BARCODE=<bool>`](#PAPERLESS_CONSUMER_ENABLE_ASN_BARCODE) {#PAPERLESS_CONSUMER_ENABLE_ASN_BARCODE}
 
 : Enables the detection of barcodes in the scanned document and
@@ -1327,7 +1242,7 @@ barcode.
 
 : Defines the upscale factor used in barcode detection.
 Improves the detection of small barcodes, i.e. with a value of 1.5 by
-upscaling the document before the detection process. Upscaling will
+upscaling the document beforce the detection process. Upscaling will
 only take place if value is bigger than 1.0. Otherwise upscaling will
 not be performed to save resources. Try using in combination with
 PAPERLESS_CONSUMER_BARCODE_DPI set to a value higher than default.
@@ -1344,15 +1259,6 @@ combination with PAPERLESS_CONSUMER_BARCODE_UPSCALE bigger than 1.0.
 
     Defaults to "300"
 
-#### [`PAPERLESS_CONSUMER_BARCODE_MAX_PAGES=<int>`](#PAPERLESS_CONSUMER_BARCODE_MAX_PAGES) {#PAPERLESS_CONSUMER_BARCODE_MAX_PAGES}
-
-: Because barcode detection is a computationally-intensive operation, this setting
-limits the detection of barcodes to a number of first pages. If your scanner has
-a limit for the number of pages that can be scanned it would be sensible to set this
-as the limit here.
-
-    Defaults to "0", allowing all pages to be checked for barcodes.
-
 #### [`PAPERLESS_CONSUMER_ENABLE_TAG_BARCODE=<bool>`](#PAPERLESS_CONSUMER_ENABLE_TAG_BARCODE) {#PAPERLESS_CONSUMER_ENABLE_TAG_BARCODE}
 
 : Enables the detection of barcodes in the scanned document and
@@ -1370,7 +1276,7 @@ assigns or creates tags if a properly formatted barcode is detected.
 
 : Defines a dictionary of filter regex and substitute expressions.
 
-    Syntax: `{"<regex>": "<substitute>" [,...]]}`
+    Syntax: {"<regex>": "<substitute>" [,...]]}
 
     A barcode is considered for tagging if the barcode text matches
     at least one of the provided <regex> pattern.
@@ -1382,20 +1288,20 @@ assigns or creates tags if a properly formatted barcode is detected.
 
     Defaults to:
 
-    `{"TAG:(.*)": "\\g<1>"}` which defines
+    {"TAG:(.*)": "\\g<1>"} which defines
     - a regex TAG:(.*) which includes barcodes beginning with TAG:
       followed by any text that gets stored into match group #1 and
-    - a substitute `\\g<1>` that replaces the original barcode text
+    - a substitute \\g<1> that replaces the original barcode text
       by the content in match group #1.
     Consequently, the tag is the barcode text without its TAG: prefix.
 
     More examples:
 
-    `{"ASN12.*": "JOHN", "ASN13.*": "SMITH"}` for example maps
+    {"ASN12.*": "JOHN", "ASN13.*": "SMITH"} for example maps
     - ASN12nnnn barcodes to the tag JOHN and
     - ASN13nnnn barcodes to the tag SMITH.
 
-    `{"T-J": "JOHN", "T-S": "SMITH", "T-D": "DOE"}` directly maps
+    {"T-J": "JOHN", "T-S": "SMITH", "T-D": "DOE"} directly maps
     - T-J barcodes to the tag JOHN,
     - T-S barcodes to the tag SMITH and
     - T-D barcodes to the tag DOE.
@@ -1448,20 +1354,6 @@ processing. This only has an effect if
 
     Defaults to false.
 
-## Trash
-
-#### [`PAPERLESS_EMPTY_TRASH_DELAY=<num>`](#PAPERLESS_EMPTY_TRASH_DELAY) {#PAPERLESS_EMPTY_TRASH_DELAY}
-
-: Sets how long in days documents remain in the 'trash' before they are permanently deleted.
-
-    Defaults to 30 days, minimum of 1 day.
-
-#### [`PAPERLESS_EMPTY_TRASH_TASK_CRON=<cron expression>`](#PAPERLESS_EMPTY_TRASH_TASK_CRON) {#PAPERLESS_EMPTY_TRASH_TASK_CRON}
-
-: Configures the schedule to empty the trash of expired deleted documents.
-
-    Defaults to `0 1 * * *`, once per day.
-
 ## Binaries
 
 There are a few external software packages that Paperless expects to
@@ -1523,7 +1415,7 @@ one pod).
 actual user ID on the host system, which you can get by executing
 
     ``` shell-session
-    id -u
+    $ id -u
     ```
 
     Paperless will change ownership on its folders to this user, so you
@@ -1538,7 +1430,7 @@ actual user ID on the host system, which you can get by executing
 actual group ID on the host system, which you can get by executing
 
     ``` shell-session
-    id -g
+    $ id -g
     ```
 
     Paperless will change ownership on its folders to this group, so you
@@ -1561,7 +1453,7 @@ specified as "chi-tra".
     PAPERLESS_OCR_LANGUAGES=tur ces chi-tra
     ```
 
-    Make sure it's a space-separated list when using several values.
+    Make sure it's a space separated list when using several values.
 
     To actually use these languages, also set the default OCR language
     of paperless:
@@ -1592,7 +1484,7 @@ started by the container.
 
 ## Frontend Settings
 
-#### [`PAPERLESS_APP_TITLE=<str>`](#PAPERLESS_APP_TITLE) {#PAPERLESS_APP_TITLE}
+#### [`PAPERLESS_APP_TITLE=<bool>`](#PAPERLESS_APP_TITLE) {#PAPERLESS_APP_TITLE}
 
 : If set, overrides the default name "Paperless-ngx"
 

docs/development.md

@@ -6,23 +6,23 @@ on Paperless-ngx.
 Check out the source from GitHub. The repository is organized in the
 following way:
 
--   `main` always represents the latest release and will only see
-    changes when a new release is made.
--   `dev` contains the code that will be in the next release.
--   `feature-X` contains bigger changes that will be in some release, but
-    not necessarily the next one.
+- `main` always represents the latest release and will only see
+  changes when a new release is made.
+- `dev` contains the code that will be in the next release.
+- `feature-X` contains bigger changes that will be in some release, but
+  not necessarily the next one.
 
 When making functional changes to Paperless-ngx, _always_ make your changes
 on the `dev` branch.
 
 Apart from that, the folder structure is as follows:
 
--   `docs/` - Documentation.
--   `src-ui/` - Code of the front end.
--   `src/` - Code of the back end.
--   `scripts/` - Various scripts that help with different parts of
-    development.
--   `docker/` - Files required to build the docker image.
+- `docs/` - Documentation.
+- `src-ui/` - Code of the front end.
+- `src/` - Code of the back end.
+- `scripts/` - Various scripts that help with different parts of
+  development.
+- `docker/` - Files required to build the docker image.
 
 ## Contributing to Paperless-ngx
 
@@ -47,7 +47,7 @@ early on.
 Once installed, hooks will run when you commit. If the formatting isn't
 quite right or a linter catches something, the commit will be rejected.
 You'll need to look at the output and fix the issue. Some hooks, such
-as the Python linting and formatting tool `ruff`, will format failing
+as the Python formatting tool `black`, will format failing
 files, so all you need to do is `git add` those files again
 and retry your commit.
 
@@ -69,23 +69,27 @@ first-time setup.
 3.  Create `consume` and `media` directories:
 
     ```bash
-    mkdir -p consume media
+    $ mkdir -p consume media
     ```
 
 4.  Install the Python dependencies:
 
     ```bash
-    pipenv install --dev
+    $ pipenv install --dev
     ```
 
     !!! note
 
         Using a virtual environment is highly recommended. You can spawn one via `pipenv shell`.
+        Make sure you're using Python 3.10.x or lower. Otherwise you might
+        get issues with building dependencies. You can use
+        [pyenv](https://github.com/pyenv/pyenv) to install a specific
+        Python version.
 
 5.  Install pre-commit hooks:
 
     ```bash
-    pre-commit install
+    $ pre-commit install
     ```
 
 6.  Apply migrations and create a superuser for your development instance:
@@ -93,23 +97,23 @@ first-time setup.
     ```bash
     # src/
 
-    python3 manage.py migrate
-    python3 manage.py createsuperuser
+    $ python3 manage.py migrate
+    $ python3 manage.py createsuperuser
     ```
 
 7.  You can now either ...
 
-    -   install redis or
+    - install redis or
 
-    -   use the included `scripts/start_services.sh` to use docker to fire
-        up a redis instance (and some other services such as tika,
-        gotenberg and a database server) or
+    - use the included `scripts/start_services.sh` to use docker to fire
+      up a redis instance (and some other services such as tika,
+      gotenberg and a database server) or
 
-    -   spin up a bare redis container
+    - spin up a bare redis container
 
-        ```
-        docker run -d -p 6379:6379 --restart unless-stopped redis:latest
-        ```
+      ```
+      $ docker run -d -p 6379:6379 --restart unless-stopped redis:latest
+      ```
 
 8.  Continue with either back-end or front-end development – or both :-).
 
@@ -122,9 +126,9 @@ work well for development, but you can use whatever you want.
 Configure the IDE to use the `src/`-folder as the base source folder.
 Configure the following launch configurations in your IDE:
 
--   `python3 manage.py runserver`
--   `python3 manage.py document_consumer`
--   `celery --app paperless worker -l DEBUG` (or any other log level)
+- `python3 manage.py runserver`
+- `python3 manage.py document_consumer`
+- `celery --app paperless worker -l DEBUG` (or any other log level)
 
 To start them all:
 
@@ -150,11 +154,11 @@ $ ng build --configuration production
 
 ### Testing
 
--   Run `pytest` in the `src/` directory to execute all tests. This also
-    generates a HTML coverage report. When runnings test, `paperless.conf`
-    is loaded as well. However, the tests rely on the default
-    configuration. This is not ideal. But for now, make sure no settings
-    except for DEBUG are overridden when testing.
+- Run `pytest` in the `src/` directory to execute all tests. This also
+  generates a HTML coverage report. When runnings test, `paperless.conf`
+  is loaded as well. However, the tests rely on the default
+  configuration. This is not ideal. But for now, make sure no settings
+  except for DEBUG are overridden when testing.
 
 !!! note
 
@@ -176,7 +180,7 @@ The front end is built using AngularJS. In order to get started, you need Node.j
 1.  Install the Angular CLI. You might need sudo privileges to perform this command:
 
     ```bash
-    npm install -g @angular/cli
+    $ npm install -g @angular/cli
     ```
 
 2.  Make sure that it's on your path.
@@ -184,13 +188,13 @@ The front end is built using AngularJS. In order to get started, you need Node.j
 3.  Install all necessary modules:
 
     ```bash
-    npm install
+    $ npm install
     ```
 
 4.  You can launch a development server by running:
 
     ```bash
-    ng serve
+    $ ng serve
     ```
 
     This will automatically update whenever you save. However, in-place
@@ -245,14 +249,14 @@ these parts have to be translated separately.
 
 ### Front end localization
 
--   The AngularJS front end does localization according to the [Angular
-    documentation](https://angular.io/guide/i18n).
--   The source language of the project is "en_US".
--   The source strings end up in the file `src-ui/messages.xlf`.
--   The translated strings need to be placed in the
-    `src-ui/src/locale/` folder.
--   In order to extract added or changed strings from the source files,
-    call `ng extract-i18n`.
+- The AngularJS front end does localization according to the [Angular
+  documentation](https://angular.io/guide/i18n).
+- The source language of the project is "en_US".
+- The source strings end up in the file `src-ui/messages.xlf`.
+- The translated strings need to be placed in the
+  `src-ui/src/locale/` folder.
+- In order to extract added or changed strings from the source files,
+  call `ng extract-i18n`.
 
 Adding new languages requires adding the translated files in the
 `src-ui/src/locale/` folder and adjusting a couple files.
@@ -298,18 +302,18 @@ A majority of the strings that appear in the back end appear only when
 the admin is used. However, some of these are still shown on the front
 end (such as error messages).
 
--   The django application does localization according to the [Django
-    documentation](https://docs.djangoproject.com/en/3.1/topics/i18n/translation/).
--   The source language of the project is "en_US".
--   Localization files end up in the folder `src/locale/`.
--   In order to extract strings from the application, call
-    `python3 manage.py makemessages -l en_US`. This is important after
-    making changes to translatable strings.
--   The message files need to be compiled for them to show up in the
-    application. Call `python3 manage.py compilemessages` to do this.
-    The generated files don't get committed into git, since these are
-    derived artifacts. The build pipeline takes care of executing this
-    command.
+- The django application does localization according to the [Django
+  documentation](https://docs.djangoproject.com/en/3.1/topics/i18n/translation/).
+- The source language of the project is "en_US".
+- Localization files end up in the folder `src/locale/`.
+- In order to extract strings from the application, call
+  `python3 manage.py makemessages -l en_US`. This is important after
+  making changes to translatable strings.
+- The message files need to be compiled for them to show up in the
+  application. Call `python3 manage.py compilemessages` to do this.
+  The generated files don't get committed into git, since these are
+  derived artifacts. The build pipeline takes care of executing this
+  command.
 
 Adding new languages requires adding the translated files in the
 `src/locale/`-folder and adjusting the file
@@ -335,13 +339,13 @@ If you want to build the documentation locally, this is how you do it:
 1.  Have an active pipenv shell (`pipenv shell`) and install Python dependencies:
 
     ```bash
-    pipenv install --dev
+    $ pipenv install --dev
     ```
 
 2.  Build the documentation
 
     ```bash
-    mkdocs build --config-file mkdocs.yml
+    $ mkdocs build --config-file mkdocs.yml
     ```
 
     _alternatively..._
@@ -352,7 +356,7 @@ If you want to build the documentation locally, this is how you do it:
     something.
 
     ```bash
-    mkdocs serve
+    $ mkdocs serve
     ```
 
 ## Building the Docker image
@@ -360,10 +364,10 @@ If you want to build the documentation locally, this is how you do it:
 The docker image is primarily built by the GitHub actions workflow, but
 it can be faster when developing to build and tag an image locally.
 
-Make sure you have the `docker-buildx` package installed. Building the image works as with any image:
+Building the image works as with any image:
 
 ```
-docker build --file Dockerfile --tag paperless:local .
+docker build --file Dockerfile --tag paperless:local --progress simple .
 ```
 
 ## Extending Paperless-ngx
@@ -378,10 +382,10 @@ base code.
 Paperless-ngx uses parsers to add documents. A parser is
 responsible for:
 
--   Retrieving the content from the original
--   Creating a thumbnail
--   _optional:_ Retrieving a created date from the original
--   _optional:_ Creating an archived document from the original
+- Retrieving the content from the original
+- Creating a thumbnail
+- _optional:_ Retrieving a created date 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
@@ -439,37 +443,14 @@ def myparser_consumer_declaration(sender, **kwargs):
     }
 ```
 
--   `parser` is a reference to a class that extends `DocumentParser`.
--   `weight` is used whenever two or more parsers are able to parse a
-    file: The parser with the higher weight wins. This can be used to
-    override the parsers provided by Paperless-ngx.
--   `mime_types` is a dictionary. The keys are the mime types your
-    parser supports and the value is the default file extension that
-    Paperless-ngx should use when storing files and serving them for
-    download. We could guess that from the file extensions, but some
-    mime types have many extensions associated with them and the Python
-    methods responsible for guessing the extension do not always return
-    the same value.
-
-## Using Visual Studio Code devcontainer
-
-Another easy way to get started with development is to use Visual Studio
-Code devcontainers. This approach will create a preconfigured development
-environment with all of the required tools and dependencies.
-[Learn more about devcontainers](https://code.visualstudio.com/docs/devcontainers/containers).
-The .devcontainer/vscode/tasks.json and .devcontainer/vscode/launch.json files
-contain more information about the specific tasks and launch configurations (see the
-non-standard "description" field).
-
-To get started:
-
-1. Clone the repository on your machine and open the Paperless-ngx folder in VS Code.
-
-2. VS Code will prompt you with "Reopen in container". Do so and wait for the environment to start.
-
-3. Initialize the project by running the task **Project Setup: Run all Init Tasks**. This
-   will initialize the database tables and create a superuser. Then you can compile the front end
-   for production or run the frontend in debug mode.
-
-4. The project is ready for debugging, start either run the fullstack debug or individual debug
-   processes. Yo spin up the project without debugging run the task **Project Start: Run all Services**
+- `parser` is a reference to a class that extends `DocumentParser`.
+- `weight` is used whenever two or more parsers are able to parse a
+  file: The parser with the higher weight wins. This can be used to
+  override the parsers provided by Paperless-ngx.
+- `mime_types` is a dictionary. The keys are the mime types your
+  parser supports and the value is the default file extension that
+  Paperless-ngx should use when storing files and serving them for
+  download. We could guess that from the file extensions, but some
+  mime types have many extensions associated with them and the Python
+  methods responsible for guessing the extension do not always return
+  the same value.

docs/faq.md

@@ -40,28 +40,28 @@ system. On Linux, chances are high that this location is
 You can always drag those files out of that folder to use them
 elsewhere. Here are a couple notes about that.
 
--   Paperless-ngx never modifies your original documents. It keeps
-    checksums of all documents and uses a scheduled sanity checker to
-    check that they remain the same.
--   By default, paperless uses the internal ID of each document as its
-    filename. This might not be very convenient for export. However, you
-    can adjust the way files are stored in paperless by
-    [configuring the filename format](advanced_usage.md#file-name-handling).
--   [The exporter](administration.md#exporter) is
-    another easy way to get your files out of paperless with reasonable
-    file names.
+- Paperless-ngx never modifies your original documents. It keeps
+  checksums of all documents and uses a scheduled sanity checker to
+  check that they remain the same.
+- By default, paperless uses the internal ID of each document as its
+  filename. This might not be very convenient for export. However, you
+  can adjust the way files are stored in paperless by
+  [configuring the filename format](advanced_usage.md#file-name-handling).
+- [The exporter](administration.md#exporter) is
+  another easy way to get your files out of paperless with reasonable
+  file names.
 
 ## _What file types does paperless-ngx support?_
 
 **A:** Currently, the following files are supported:
 
--   PDF documents, PNG images, JPEG images, TIFF images, GIF images and
-    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](https://docs.paperless-ngx.com/configuration#tika)),
-    Paperless also supports various Office documents (.docx, .doc, odt,
-    .ppt, .pptx, .odp, .xls, .xlsx, .ods).
+- PDF documents, PNG images, JPEG images, TIFF images, GIF images and
+  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](https://docs.paperless-ngx.com/configuration#tika)),
+  Paperless also supports various Office documents (.docx, .doc, odt,
+  .ppt, .pptx, .odp, .xls, .xlsx, .ods).
 
 Paperless-ngx determines the type of a file by inspecting its content.
 The file extensions do not matter.
@@ -127,16 +127,8 @@ ASGI-enabled web server as well that processes WebSocket connections,
 and configure Apache to redirect WebSocket connections to this server.
 Multiple options for ASGI servers exist:
 
--   `gunicorn` with `uvicorn` as the worker implementation (the default
-    of paperless)
--   `daphne` as a standalone server, which is the reference
-    implementation for ASGI.
--   `uvicorn` as a standalone server
-
-## _What about the Redis licensing change and using one of the open source forks_?
-
-Currently (October 2024), forks of Redis such as Valkey or Redirect are not officially supported by our upstream
-libraries, so using one of these to replace Redis is not officially supported.
-
-However, they do claim to be compatible with the Redis protocol and will likely work, but we will
-not be updating from using Redis as the broker officially just yet.
+- `gunicorn` with `uvicorn` as the worker implementation (the default
+  of paperless)
+- `daphne` as a standalone server, which is the reference
+  implementation for ASGI.
+- `uvicorn` as a standalone server

docs/setup.md

@@ -2,11 +2,10 @@
 
 You can go multiple routes to setup and run Paperless:
 
--   [Use the script to setup a Docker install](#docker_script)
--   [Use the Docker compose templates](#docker)
--   [Build the Docker image yourself](#docker_build)
--   [Install Paperless-ngx directly on your system manually ("bare metal")](#bare_metal)
--   A user-maintained list of commercial hosting providers can be found [in the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Related-Projects)
+- [Use the easy install docker script](#docker_script)
+- [Pull the image from Docker Hub](#docker_hub)
+- [Build the Docker image yourself](#docker_build)
+- [Install Paperless directly on your system manually (bare metal)](#bare_metal)
 
 The Docker routes are quick & easy. These are the recommended routes.
 This configures all the stuff from the above automatically so that it
@@ -18,19 +17,24 @@ The bare metal route is complicated to setup but makes it easier should
 you want to contribute some code back. You need to configure and run the
 above mentioned components yourself.
 
-### Use the Installation Script {#docker_script}
+### Docker using the Installation Script {#docker_script}
 
-Paperless provides an interactive installation script to setup a Docker Compose
-installation. The script asks for a couple configuration options, and will then create the
-necessary configuration files, pull the docker image, start Paperless-ngx and create your superuser
-account. The script essentially automatically performs the steps described in [Docker setup](#docker).
+Paperless provides an interactive installation script. This script will
+ask you for a couple configuration options, download and create the
+necessary configuration files, pull the docker image, start paperless
+and create your user account. This script essentially performs all the
+steps described in [Docker setup](#docker_hub) automatically.
 
-1.  Make sure that Docker and Docker Compose are [installed](https://docs.docker.com/engine/install/){:target="\_blank"}.
+1.  Make sure that Docker and Docker Compose are installed.
+
+    !!! tip
+
+        See the Docker installation instructions at https://docs.docker.com/engine/install/
 
 2.  Download and run the installation script:
 
     ```shell-session
-    bash -c "$(curl --location --silent --show-error 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
@@ -38,46 +42,83 @@ account. The script essentially automatically performs the steps described in [D
         macOS users will need to install e.g. [gnu-sed](https://formulae.brew.sh/formula/gnu-sed) with support
         for running as `sed`.
 
-### Use Docker Compose {#docker}
+### From GHCR / Docker Hub {#docker_hub}
 
-1.  Make sure that Docker and Docker Compose are [installed](https://docs.docker.com/engine/install/){:target="\_blank"}.
+1.  Login with your user and create a folder in your home-directory to have a place for your
+    configuration files and consumption directory.
+
+    ```shell-session
+    $ mkdir -v ~/paperless-ngx
+    ```
 
 2.  Go to the [/docker/compose directory on the project
-    page](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose){:target="\_blank"}
-    and download one of the `docker-compose.*.yml` files, depending on which database backend
-    you want to use. Place the files in a local directory and rename it `docker-compose.yml`. Download the
-    `docker-compose.env` file and the `.env` file as well in the same directory.
-
-    If you want to enable optional support for Office and other documents, download a
-    file with `-tika` in the file name.
+    page](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose)
+    and download one of the `docker-compose.*.yml` files,
+    depending on which database backend you want to use. Rename this
+    file to `docker-compose.yml`. If you want to enable
+    optional support for Office documents, download a file with
+    `-tika` in the file name. Download the
+    `docker-compose.env` file and the `.env` file as well and store them
+    in the same directory.
 
     !!! tip
 
         For new installations, it is recommended to use PostgreSQL as the
         database backend.
 
-3.  Modify `docker-compose.yml` as needed. For example, you may want to change the paths to the
-    consumption, media etc. directories to use 'bind mounts'.
-    Find the line that specifies where to mount the directory, e.g.:
+3.  Install [Docker](https://docs.docker.com/engine/install/) and
+    [Docker Compose](https://docs.docker.com/compose/install/).
+
+    !!! warning
+
+        If you want to use the included `docker-compose.*.yml` file, you
+        need to have at least Docker version **17.09.0** and Docker Compose
+        version **v2**. To check do: `docker compose version` or `docker -v`
+
+        See the [Docker installation guide](https://docs.docker.com/engine/install/) on how to install the current
+        version of Docker for your operating system or Linux distribution of
+        choice. To get the latest version of Docker Compose, follow the
+        [Docker Compose installation guide](https://docs.docker.com/compose/install/linux/) if your package repository
+        doesn't include it.
+
+4.  Modify `docker-compose.yml` to your preferences. You may want to
+    change the path to the consumption directory. Find the line that
+    specifies where to mount the consumption directory:
 
     ```yaml
     - ./consume:/usr/src/paperless/consume
     ```
 
-    Replace the part _before_ the colon with a local directory of your choice:
+    Replace the part BEFORE the colon with a local directory of your
+    choice:
 
     ```yaml
     - /home/jonaswinkler/paperless-inbox:/usr/src/paperless/consume
     ```
 
-    You may also want to change the default port that the webserver will
-    use from the default (8000) to something else, e.g. for port 8010:
+    Don't change the part after the colon or paperless won't find your
+    documents.
+
+    You may also need to change the default port that the webserver will
+    use from the default (8000):
 
     ```yaml
     ports:
-        - 8010:8000
+      - 8000:8000
     ```
 
+    Replace the part BEFORE the colon with a port of your choice:
+
+    ```yaml
+    ports:
+      - 8010:8000
+    ```
+
+    Don't change the part after the colon or edit other lines that
+    refer to port 8000. Modifying the part before the colon will map
+    requests on another port to the webserver running on the default
+    port.
+
     **Rootless**
 
     !!! warning
@@ -87,11 +128,11 @@ account. The script essentially automatically performs the steps described in [D
     If you want to run Paperless as a rootless container, you will need
     to do the following in your `docker-compose.yml`:
 
-    -   set the `user` running the container to map to the `paperless`
-        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.md#docker).
+    - set the `user` running the container to map to the `paperless`
+      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.md#docker).
 
     Your entry for Paperless should contain something like:
 
@@ -101,16 +142,21 @@ account. The script essentially automatically performs the steps described in [D
     >   user: <user_id>
     > ```
 
-4.  Modify `docker-compose.env` with any configuration options you'd like.
-    See the [configuration documentation](configuration.md) for all options.
-
-    You may also need to set `USERMAP_UID` and `USERMAP_GID` to
+5.  Modify `docker-compose.env`, following the comments in the file. The
+    most important change is to set `USERMAP_UID` and `USERMAP_GID` to
     the uid and gid of your user on the host system. Use `id -u` and
-    `id -g` to get these. This ensures that both the container and the host
-    user have write access to the consumption directory. If your UID
+    `id -g` to get these.
+
+    This ensures that both the docker container and you on the host
+    machine have write access to the consumption directory. If your UID
     and GID on the host system is 1000 (the default for the first normal
     user on most systems), it will work out of the box without any
-    modifications. Run `id "username"` to check.
+    modifications. `id "username"` to check.
+
+    !!! note
+
+        You can copy any setting from the file `paperless.conf.example` and
+        paste it here. Have a look at [configuration](configuration.md) to see what's available.
 
     !!! note
 
@@ -127,30 +173,33 @@ account. The script essentially automatically performs the steps described in [D
         [`PAPERLESS_CONSUMER_POLLING`](configuration.md#PAPERLESS_CONSUMER_POLLING), which will disable inotify. See
         [here](configuration.md#polling).
 
-5.  Run `docker compose pull`. This will pull the image from the GitHub container registry
-    by default but you can change the image to pull from Docker Hub by changing the `image`
-    line to `image: paperlessngx/paperless-ngx:latest`.
+6.  Run `docker compose pull`. This will pull the image.
 
-6.  To be able to login, you will need a "superuser". To create it,
+7.  To be able to login, you will need a super user. To create it,
     execute the following command:
 
     ```shell-session
-    docker compose run --rm webserver createsuperuser
+    $ docker compose run --rm webserver createsuperuser
     ```
 
     or using docker exec from within the container:
 
     ```shell-session
-    python3 manage.py createsuperuser
+    $ python3 manage.py createsuperuser
     ```
 
-    This will guide you through the superuser setup.
+    This will prompt you to set a username, an optional e-mail address
+    and finally a password (at least 8 characters).
 
-7.  Run `docker compose up -d`. This will create and start the necessary containers.
+8.  Run `docker compose up -d`. This will create and start the necessary containers.
 
-8.  Congratulations! Your Paperless-ngx instance should now be accessible at `http://127.0.0.1:8000`
-    (or similar, depending on your configuration). Use the superuser credentials you have
-    created in the previous step to login.
+9.  The default `docker-compose.yml` exports the webserver on your local
+    port
+
+    8000\. If you did not change this, you should now be able to visit
+    your Paperless instance at `http://127.0.0.1:8000` or your servers
+    IP-Address:8000. Use the login credentials you have created with the
+    previous step.
 
 ### Build the Docker image yourself {#docker_build}
 
@@ -172,7 +221,7 @@ account. The script essentially automatically performs the steps described in [D
 
     ```yaml
     webserver:
-        image: ghcr.io/paperless-ngx/paperless-ngx:latest
+      image: ghcr.io/paperless-ngx/paperless-ngx:latest
     ```
 
     and replace it with a line that instructs Docker Compose to build
@@ -180,15 +229,15 @@ account. The script essentially automatically performs the steps described in [D
 
     ```yaml
     webserver:
-        build:
-            context: .
+      build:
+        context: .
     ```
 
-4.  Follow the [Docker setup](#docker) above except when asked to run
-    `docker compose pull` to pull the image, run
+4.  Follow steps 3 to 8 of [Docker Setup](#docker_hub). When asked to run
+    `docker compose pull` to pull the image, do
 
     ```shell-session
-    docker compose build
+    $ docker compose build
     ```
 
     instead to build the image.
@@ -200,48 +249,44 @@ a minimal installation of Debian/Buster, which is the current stable
 release at the time of writing. Windows is not and will never be
 supported.
 
-Paperless requires Python 3. At this time, 3.10 - 3.12 are tested versions.
-Newer versions may work, but some dependencies may not fully support newer versions.
-Support for older Python versions may be dropped as they reach end of life or as newer versions
-are released, dependency support is confirmed, etc.
-
 1.  Install dependencies. Paperless requires the following packages.
 
-    -   `python3`
-    -   `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
-    -   `gnupg` for handling encrypted documents
-    -   `libpq-dev` for PostgreSQL
-    -   `libmagic-dev` for mime type detection
-    -   `mariadb-client` for MariaDB compile time
-    -   `libzbar0` for barcode detection
-    -   `poppler-utils` for barcode detection
+    - `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
+    - `gnupg` for handling encrypted documents
+    - `libpq-dev` for PostgreSQL
+    - `libmagic-dev` for mime type detection
+    - `mariadb-client` for MariaDB compile time
+    - `mime-support` for mime type detection
+    - `libzbar0` for barcode detection
+    - `poppler-utils` for barcode detection
 
     Use this list for your preferred package management:
 
     ```
-    python3 python3-pip python3-dev imagemagick fonts-liberation gnupg libpq-dev default-libmysqlclient-dev pkg-config libmagic-dev 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
     recognition.
 
-    -   `unpaper`
-    -   `ghostscript`
-    -   `icc-profiles-free`
-    -   `qpdf`
-    -   `liblept5`
-    -   `libxml2`
-    -   `pngquant` (suggested for certain PDF image optimizations)
-    -   `zlib1g`
-    -   `tesseract-ocr` >= 4.0.0 for OCR
-    -   `tesseract-ocr` language packs (`tesseract-ocr-eng`,
-        `tesseract-ocr-deu`, etc)
+    - `unpaper`
+    - `ghostscript`
+    - `icc-profiles-free`
+    - `qpdf`
+    - `liblept5`
+    - `libxml2`
+    - `pngquant` (suggested for certain PDF image optimizations)
+    - `zlib1g`
+    - `tesseract-ocr` >= 4.0.0 for OCR
+    - `tesseract-ocr` language packs (`tesseract-ocr-eng`,
+      `tesseract-ocr-deu`, etc)
 
     Use this list for your preferred package management:
 
@@ -251,21 +296,11 @@ are released, dependency support is confirmed, etc.
 
     On Raspberry Pi, these libraries are required as well:
 
-    -   `libatlas-base-dev`
-    -   `libxslt1-dev`
-    -   `mime-support`
+    - `libatlas-base-dev`
+    - `libxslt1-dev`
 
-    You will also need these for installing some of the python dependencies:
-
-    -   `build-essential`
-    -   `python3-setuptools`
-    -   `python3-wheel`
-
-    Use this list for your preferred package management:
-
-    ```
-    build-essential python3-setuptools python3-wheel
-    ```
+    You will also need `build-essential`, `python3-setuptools` and
+    `python3-wheel` for installing some of the python dependencies.
 
 2.  Install `redis` >= 6.0 and configure it to start automatically.
 
@@ -311,33 +346,33 @@ are released, dependency support is confirmed, etc.
     needs. Required settings for getting
     paperless running are:
 
-    -   [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS) should point to your redis server, such as
-        <redis://localhost:6379>.
-    -   [`PAPERLESS_DBENGINE`](configuration.md#PAPERLESS_DBENGINE) optional, and should be one of `postgres`,
-        `mariadb`, or `sqlite`
-    -   [`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`](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`](configuration.md#PAPERLESS_DATA_DIR) and
-        [`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`](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`](configuration.md#PAPERLESS_URL) if you are behind a reverse proxy. This should
-        point to your domain. Please see
-        [configuration](configuration.md) for more
-        information.
+    - [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS) should point to your redis server, such as
+      <redis://localhost:6379>.
+    - [`PAPERLESS_DBENGINE`](configuration.md#PAPERLESS_DBENGINE) optional, and should be one of `postgres`,
+      `mariadb`, or `sqlite`
+    - [`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`](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`](configuration.md#PAPERLESS_DATA_DIR) and
+      [`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`](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`](configuration.md#PAPERLESS_URL) if you are behind a reverse proxy. This should
+      point to your domain. Please see
+      [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`](configuration.md#PAPERLESS_OCR_LANGUAGE) to the language most of your
-        documents are written in.
-    -   Set [`PAPERLESS_TIME_ZONE`](configuration.md#PAPERLESS_TIME_ZONE) to your local time zone.
+    - Set [`PAPERLESS_OCR_LANGUAGE`](configuration.md#PAPERLESS_OCR_LANGUAGE) to the language most of your
+      documents are written in.
+    - Set [`PAPERLESS_TIME_ZONE`](configuration.md#PAPERLESS_TIME_ZONE) to your local time zone.
 
     !!! warning
 
@@ -345,9 +380,9 @@ are released, dependency support is confirmed, etc.
 
 7.  Create the following directories if they are missing:
 
-    -   `/opt/paperless/media`
-    -   `/opt/paperless/data`
-    -   `/opt/paperless/consume`
+    - `/opt/paperless/media`
+    - `/opt/paperless/data`
+    - `/opt/paperless/consume`
 
     Adjust as necessary if you configured different folders.
     Ensure that the paperless user has write permissions for every one
@@ -365,7 +400,8 @@ are released, dependency support is confirmed, etc.
     sudo chown paperless:paperless /opt/paperless/consume
     ```
 
-8.  Install python requirements from the `requirements.txt` file.
+8.  Install python requirements from the `requirements.txt` file. It is
+    up to you if you wish to use a virtual environment or not. First you should update your pip, so it gets the actual packages.
 
     ```shell-session
     sudo -Hu paperless pip3 install -r requirements.txt
@@ -374,12 +410,6 @@ are released, dependency support is confirmed, etc.
     This will install all python dependencies in the home directory of
     the new paperless user.
 
-    !!! tip
-
-        It is up to you if you wish to use a virtual environment or not for the Python
-        dependencies.  This is an alternative to the above and may require adjusting
-        the example scripts to utilize the virtual environment paths
-
 9.  Go to `/opt/paperless/src`, and execute the following commands:
 
     ```bash
@@ -490,7 +520,8 @@ are released, dependency support is confirmed, etc.
 15. Optional: If using the NLTK machine learning processing (see
     [`PAPERLESS_ENABLE_NLTK`](configuration.md#PAPERLESS_ENABLE_NLTK) for details),
     download the NLTK data for the Snowball
-    Stemmer, Stopwords and Punkt tokenizer to `/usr/share/nltk_data`. Refer to the [NLTK
+    Stemmer, Stopwords and Punkt tokenizer to your
+    `PAPERLESS_DATA_DIR/nltk`. Refer to the [NLTK
     instructions](https://www.nltk.org/data.html) for details on how to
     download the data.
 
@@ -536,29 +567,29 @@ 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.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)
-    for details on
-    how to move your data from SQLite to PostgreSQL. Both work fine with
-    paperless. However, if you already have a database server running
-    for other services, you might as well use it for paperless as well.
--   The task scheduler of paperless, which is used to execute periodic
-    tasks such as email checking and maintenance, requires a
-    [redis](https://redis.io/) message broker instance. The
-    Docker Compose route takes care of that.
--   The layout of the folder structure for your documents and data
-    remains the same, so you can just plug your old docker volumes into
-    paperless-ngx and expect it to find everything where it should be.
+- 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)
+  for details on
+  how to move your data from SQLite to PostgreSQL. Both work fine with
+  paperless. However, if you already have a database server running
+  for other services, you might as well use it for paperless as well.
+- The task scheduler of paperless, which is used to execute periodic
+  tasks such as email checking and maintenance, requires a
+  [redis](https://redis.io/) message broker instance. The
+  Docker Compose route takes care of that.
+- The layout of the folder structure for your documents and data
+  remains the same, so you can just plug your old docker volumes into
+  paperless-ngx and expect it to find everything where it should be.
 
 Migration to paperless-ngx is then performed in a few simple steps:
 
 1.  Stop paperless.
 
     ```bash
-    cd /path/to/current/paperless
-    docker compose down
+    $ cd /path/to/current/paperless
+    $ docker compose down
     ```
 
 2.  Do a backup for two purposes: If something goes wrong, you still
@@ -582,7 +613,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
         names of your volumes with
 
         ``` shell-session
-        docker volume ls | grep _data
+        $ docker volume ls | grep _data
         ```
 
         and adjust the project name in the `.env` file so that it matches
@@ -593,7 +624,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
     after you migrated your existing SQLite database.
 
 5.  Adjust `docker-compose.yml` and `docker-compose.env` to your needs.
-    See [Docker setup](#docker) details on
+    See [Docker setup](#docker_hub) details on
     which edits are advised.
 
 6.  [Update paperless.](administration.md#updating)
@@ -603,7 +634,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
     the search index:
 
     ```shell-session
-    docker compose run --rm webserver document_index reindex
+    $ docker compose run --rm webserver document_index reindex
     ```
 
     This will migrate your database and create the search index. After
@@ -612,7 +643,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
 8.  Start paperless-ngx.
 
     ```bash
-    docker compose up -d
+    $ docker compose up -d
     ```
 
     This will run paperless in the background and automatically start it
@@ -635,37 +666,24 @@ commands as well.
 1.  Stop and remove the paperless container
 2.  If using an external database, stop the container
 3.  Update Redis configuration
-
-    1. If `REDIS_URL` is already set, change it to [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS)
-       and continue to step 4.
-
-    1. 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)
-
-    1. Set the environment variable [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS) so it points to
-       the new Redis container
-
+    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`](configuration.md#PAPERLESS_REDIS) so it points to
+    the new Redis container
 4.  Update user mapping
-
-    1. If set, change the environment variable `PUID` to `USERMAP_UID`
-
-    1. If set, change the environment variable `PGID` to `USERMAP_GID`
-
+    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
-
-    1. Set the environment variable [`PAPERLESS_DATA_DIR`](configuration.md#PAPERLESS_DATA_DIR) to `/config`
-
+    a) Set the environment variable [`PAPERLESS_DATA_DIR`](configuration.md#PAPERLESS_DATA_DIR) to `/config`
 6.  Update media paths
-
-    1. Set the environment variable [`PAPERLESS_MEDIA_ROOT`](configuration.md#PAPERLESS_MEDIA_ROOT) to
-       `/data/media`
-
+    a) Set the environment variable [`PAPERLESS_MEDIA_ROOT`](configuration.md#PAPERLESS_MEDIA_ROOT) to
+    `/data/media`
 7.  Update timezone
-
-    1. Set the environment variable [`PAPERLESS_TIME_ZONE`](configuration.md#PAPERLESS_TIME_ZONE) to the same
-       value as `TZ`
-
+    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
     if preferred.
@@ -673,8 +691,95 @@ commands as well.
 
 ## Moving data from SQLite to PostgreSQL or MySQL/MariaDB {#sqlite_to_psql}
 
-The best way to migrate between database types is to perform an [export](administration.md#exporter) and then
-[import](administration.md#importer) into a clean installation of Paperless-ngx.
+Moving your data from SQLite to PostgreSQL or MySQL/MariaDB is done via
+executing a series of django management commands as below. The commands
+below use PostgreSQL, but are applicable to MySQL/MariaDB with the
+
+!!! warning
+
+    Make sure that your SQLite database is migrated to the latest version.
+    Starting paperless will make sure that this is the case. If your try to
+    load data from an old database schema in SQLite into a newer database
+    schema in PostgreSQL, you will run into trouble.
+
+!!! warning
+
+    On some database fields, PostgreSQL enforces predefined limits on
+    maximum length, whereas SQLite does not. The fields in question are the
+    title of documents (128 characters), names of document types, tags and
+    correspondents (128 characters), and filenames (1024 characters). If you
+    have data in these fields that surpasses these limits, migration to
+    PostgreSQL is not possible and will fail with an error.
+
+!!! warning
+
+    MySQL is case insensitive by default, treating values like "Name" and
+    "NAME" as identical. See [MySQL caveats](advanced_usage.md#mysql-caveats) for details.
+
+!!! warning
+
+    MySQL also enforces limits on maximum lengths, but does so differently than
+    PostgreSQL.  It may not be possible to migrate to MySQL due to this.
+
+!!! warning
+
+    Using mariadb version 10.4+ is recommended. Using the `utf8mb3` character set on
+    an older system may fix issues that can arise while setting up Paperless-ngx but
+    `utf8mb3` can cause issues with consumption (where `utf8mb4` does not).
+
+1.  Stop paperless, if it is running.
+
+2.  Tell paperless to use PostgreSQL:
+
+    a) With docker, copy the provided `docker-compose.postgres.yml`
+    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.md) for
+    details.
+
+3.  Open a shell and initialize the database:
+
+    a) With docker, run the following command to open a shell within
+    the paperless container:
+
+        ``` shell-session
+        $ cd /path/to/paperless
+        $ docker compose run --rm webserver /bin/bash
+        ```
+
+        This will launch the container and initialize the PostgreSQL
+        database.
+
+    b) Without docker, remember to activate any virtual environment,
+    switch to the `src` directory and create the database schema:
+
+        ``` shell-session
+        $ cd /path/to/paperless/src
+        $ python3 manage.py migrate
+        ```
+
+        This will not copy any data yet.
+
+4.  Dump your data from SQLite:
+
+    ```shell-session
+    $ python3 manage.py dumpdata --database=sqlite --exclude=contenttypes --exclude=auth.Permission > data.json
+    ```
+
+5.  Load your data into PostgreSQL:
+
+    ```shell-session
+    $ python3 manage.py loaddata data.json
+    ```
+
+6.  If operating inside Docker, you may exit the shell now.
+
+    ```shell-session
+    $ exit
+    ```
+
+7.  Start paperless.
 
 ## Moving back to Paperless
 
@@ -713,30 +818,30 @@ Paperless runs on Raspberry Pi. However, some things are rather slow on
 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`](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`](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`](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`](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`](configuration.md#PAPERLESS_WEBSERVER_WORKERS) to 1. This will save some memory.
--   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.
+- Stick with SQLite to save some resources.
+- 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`](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`](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`](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`](configuration.md#PAPERLESS_WEBSERVER_WORKERS) to 1. This will save some memory.
+- 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.md).
 

docs/troubleshooting.md

@@ -4,27 +4,27 @@
 
 Check for the following issues:
 
--   Ensure that the directory you're putting your documents in is the
-    folder paperless is watching. With docker, this setting is performed
-    in the `docker-compose.yml` file. Without Docker, look at the
-    `CONSUMPTION_DIR` setting. Don't adjust this setting if you're
-    using docker.
+- Ensure that the directory you're putting your documents in is the
+  folder paperless is watching. With docker, this setting is performed
+  in the `docker-compose.yml` file. Without Docker, look at the
+  `CONSUMPTION_DIR` setting. Don't adjust this setting if you're
+  using docker.
 
--   Ensure that redis is up and running. Paperless does its task
-    processing asynchronously, and for documents to arrive at the task
-    processor, it needs redis to run.
+- Ensure that redis is up and running. Paperless does its task
+  processing asynchronously, and for documents to arrive at the task
+  processor, it needs redis to run.
 
--   Ensure that the task processor is running. Docker does this
-    automatically. Manually invoke the task processor by executing
+- Ensure that the task processor is running. Docker does this
+  automatically. Manually invoke the task processor by executing
 
-    ```shell-session
-    celery --app paperless worker
-    ```
+  ```shell-session
+  $ celery --app paperless worker
+  ```
 
--   Look at the output of paperless and inspect it for any errors.
+- Look at the output of paperless and inspect it for any errors.
 
--   Go to the admin interface, and check if there are failed tasks. If
-    so, the tasks will contain an error message.
+- Go to the admin interface, and check if there are failed tasks. If
+  so, the tasks will contain an error message.
 
 ## Consumer warns `OCR for XX failed`
 
@@ -78,12 +78,12 @@ Ensure that `chown` is possible on these directories.
 This indicates that the Auto matching algorithm found no documents to
 learn from. This may have two reasons:
 
--   You don't use the Auto matching algorithm: The error can be safely
-    ignored in this case.
--   You are using the Auto matching algorithm: The classifier explicitly
-    excludes documents with Inbox tags. Verify that there are documents
-    in your archive without inbox tags. The algorithm will only learn
-    from documents not in your inbox.
+- You don't use the Auto matching algorithm: The error can be safely
+  ignored in this case.
+- You are using the Auto matching algorithm: The classifier explicitly
+  excludes documents with Inbox tags. Verify that there are documents
+  in your archive without inbox tags. The algorithm will only learn
+  from documents not in your inbox.
 
 ## UserWarning in sklearn on every single document
 
@@ -127,10 +127,10 @@ change in the `docker-compose.yml` file:
 # The gotenberg chromium route is used to convert .eml files. We do not
 # want to allow external content like tracking pixels or even javascript.
 command:
-    - 'gotenberg'
-    - '--chromium-disable-javascript=true'
-    - '--chromium-allow-list=file:///tmp/.*'
-    - '--api-timeout=60'
+  - 'gotenberg'
+  - '--chromium-disable-javascript=true'
+  - '--chromium-allow-list=file:///tmp/.*'
+  - '--api-timeout=60'
 ```
 
 ## Permission denied errors in the consumption directory
@@ -353,20 +353,6 @@ ways from the original. As the logs indicate, if you encounter this error you ca
 `PAPERLESS_OCR_USER_ARGS: '{"continue_on_soft_render_error": true}'` to try to 'force'
 processing documents with this issue.
 
-## Logs show "possible incompatible database column" when deleting documents {#convert-uuid-field}
-
-You may see errors when deleting documents like:
-
-```
-Data too long for column 'transaction_id' at row 1
-```
-
-This error can occur in installations which have upgraded from a version of Paperless-ngx that used Django 4 (Paperless-ngx versions prior to v2.13.0) with a MariaDB/MySQL database. Due to the backawards-incompatible change in Django 5, the column "documents_document.transaction_id" will need to be re-created, which can be done with a one-time run of the following management command:
-
-```shell-session
-$ python3 manage.py convert_mariadb_uuid
-```
-
 ## 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

@@ -10,37 +10,37 @@ and provides many utilities for finding and managing your documents.
 Paperless essentially consists of two different parts for managing your
 documents:
 
--   The _consumer_ watches a specified folder and adds all documents in
-    that folder to paperless.
--   The _web server_ provides a UI that you use to manage and search for
-    your scanned documents.
+- The _consumer_ watches a specified folder and adds all documents in
+  that folder to paperless.
+- The _web server_ provides a UI that you use to manage and search for
+  your scanned documents.
 
 Each document has a couple of fields that you can assign to them:
 
--   A _Document_ is a piece of paper that sometimes contains valuable
-    information.
--   The _correspondent_ of a document is the person, institution or
-    company that a document either originates from, or is sent to.
--   A _tag_ is a label that you can assign to documents. Think of labels
-    as more powerful folders: Multiple documents can be grouped together
-    with a single tag, however, a single document can also have multiple
-    tags. This is not possible with folders. The reason folders are not
-    implemented in paperless is simply that tags are much more versatile
-    than folders.
--   A _document type_ is used to demarcate the type of a document such
-    as letter, bank statement, invoice, contract, etc. It is used to
-    identify what a document is about.
--   The _date added_ of a document is the date the document was scanned
-    into paperless. You cannot and should not change this date.
--   The _date created_ of a document is the date the document was
-    initially issued. This can be the date you bought a product, the
-    date you signed a contract, or the date a letter was sent to you.
--   The _archive serial number_ (short: ASN) of a document is the
-    identifier of the document in your physical document binders. See
-    [recommended workflow](#usage-recommended-workflow) below.
--   The _content_ of a document is the text that was OCR'ed from the
-    document. This text is fed into the search engine and is used for
-    matching tags, correspondents and document types.
+- A _Document_ is a piece of paper that sometimes contains valuable
+  information.
+- The _correspondent_ of a document is the person, institution or
+  company that a document either originates from, or is sent to.
+- A _tag_ is a label that you can assign to documents. Think of labels
+  as more powerful folders: Multiple documents can be grouped together
+  with a single tag, however, a single document can also have multiple
+  tags. This is not possible with folders. The reason folders are not
+  implemented in paperless is simply that tags are much more versatile
+  than folders.
+- A _document type_ is used to demarcate the type of a document such
+  as letter, bank statement, invoice, contract, etc. It is used to
+  identify what a document is about.
+- The _date added_ of a document is the date the document was scanned
+  into paperless. You cannot and should not change this date.
+- The _date created_ of a document is the date the document was
+  initially issued. This can be the date you bought a product, the
+  date you signed a contract, or the date a letter was sent to you.
+- The _archive serial number_ (short: ASN) of a document is the
+  identifier of the document in your physical document binders. See
+  [recommended workflow](#usage-recommended-workflow) below.
+- The _content_ of a document is the text that was OCR'ed from the
+  document. This text is fed into the search engine and is used for
+  matching tags, correspondents and document types.
 
 ## Adding documents to paperless
 
@@ -109,10 +109,10 @@ process.
 
 ### Mobile upload {#usage-mobile_upload}
 
-Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Related-Projects) for a user-maintained list of related projects and
+Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Affiliated-Projects) for a user-maintained list of affiliated projects and
 software (e.g. for mobile devices) that is compatible with Paperless-ngx.
 
-### Email {#usage-email}
+### IMAP (Email) {#usage-email}
 
 You can tell paperless-ngx to consume documents from your email
 accounts. This is a very flexible and powerful feature, if you regularly
@@ -136,27 +136,26 @@ These rules perform the following:
 
 Paperless will check all emails only once and completely ignore messages
 that do not match your filters. It will also only perform the rule action
-on e-mails that it has consumed documents from. The filename attachment
-patterns can include wildcards and multiple patterns separated by a comma.
+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:
 
--   **Delete:** Immediately deletes mail that paperless has consumed
-    documents from. Use with caution.
--   **Mark as read:** Mark consumed mail as read. Paperless will not
-    consume documents from already read mails. If you read a mail before
-    paperless sees it, it will be ignored.
--   **Flag:** Sets the 'important' flag on mails with consumed
-    documents. Paperless will not consume flagged mails.
--   **Move to folder:** Moves consumed mails out of the way so that
-    paperless won't consume them again.
--   **Add custom Tag:** Adds a custom tag to mails with consumed
-    documents (the IMAP standard calls these "keywords"). Paperless
-    will not consume mails already tagged. Not all mail servers support
-    this feature!
+- **Delete:** Immediately deletes mail that paperless has consumed
+  documents from. Use with caution.
+- **Mark as read:** Mark consumed mail as read. Paperless will not
+  consume documents from already read mails. If you read a mail before
+  paperless sees it, it will be ignored.
+- **Flag:** Sets the 'important' flag on mails with consumed
+  documents. Paperless will not consume flagged mails.
+- **Move to folder:** Moves consumed mails out of the way so that
+  paperless won't consume them again.
+- **Add custom Tag:** Adds a custom tag to mails with consumed
+  documents (the IMAP standard calls these "keywords"). Paperless
+  will not consume mails already tagged. Not all mail servers support
+  this feature!
 
-    -   **Apple Mail support:** Apple Mail clients allow differently colored tags. For this to work use `apple:<color>` (e.g. _apple:green_) as a custom tag. Available colors are _red_, _orange_, _yellow_, _blue_, _green_, _violet_ and _grey_.
+  - **Apple Mail support:** Apple Mail clients allow differently colored tags. For this to work use `apple:<color>` (e.g. _apple:green_) as a custom tag. Available colors are _red_, _orange_, _yellow_, _blue_, _green_, _violet_ and _grey_.
 
 !!! warning
 
@@ -200,14 +199,6 @@ different means. These are as follows:
 Paperless is set up to check your mails every 10 minutes. This can be
 configured via [`PAPERLESS_EMAIL_TASK_CRON`](configuration.md#PAPERLESS_EMAIL_TASK_CRON)
 
-#### OAuth Email Setup
-
-Paperless-ngx supports OAuth2 authentication for Gmail and Outlook email accounts. To set up an email account with OAuth2, you will need to create a 'developer' app with the respective provider and obtain the client ID and client secret and set the appropriate [configuration variables](configuration.md#email_oauth). You will also need to set either [`PAPERLESS_OAUTH_CALLBACK_BASE_URL`](configuration.md#PAPERLESS_OAUTH_CALLBACK_BASE_URL) or [`PAPERLESS_URL`](configuration.md#PAPERLESS_URL) to the correct value for the OAuth2 flow to work correctly.
-
-Specific instructions for setting up the required 'developer' app with Google or Microsoft are beyond the scope of this documentation, but you can find user-maintained instructions in [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Email-OAuth-App-Setup) or by searching the web.
-
-Once setup, navigating to the email settings page in Paperless-ngx will allow you to add an email account for Gmail or Outlook using OAuth2. After authenticating, you will be presented with the newly-created account where you will need to enter and save your email address. After this, the account will work as any other email account in Paperless-ngx and refreshing tokens will be handled automatically.
-
 ### REST API
 
 You can also submit a document using the REST API, see [POSTing documents](api.md#file-uploads)
@@ -246,13 +237,9 @@ Settings > Users & Groups, assuming the user has access. If a user is designated
 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).
 
-!!! tip
+!!! note
 
-    By default, new users are not granted any permissions, except those inherited from any group(s) of which they are a member.
-
-#### Superusers
-
-Superusers can access all parts of the front and backend application as well as any and all objects.
+    Superusers can access all parts of the front and backend application as well as any and all objects.
 
 #### Admin Status
 
@@ -261,29 +248,29 @@ as well as accessing the Django backend.
 
 #### Detailed Explanation of Global Permissions {#global-permissions}
 
-Global permissions define what areas of the app and API endpoints users can access. For example, they
+Global permissions define what areas of the app and API endpoints the user can access. For example, they
 determine if a user can create, edit, delete or view _any_ documents, but individual documents themselves
 still have "object-level" permissions.
 
-| Type          | Details                                                                                                                                                                  |
-| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| AppConfig     | _Change_ or higher permissions grants access to the "Application Configuration" area.                                                                                    |
-| Correspondent | Add, edit, delete or view Correspondents.                                                                                                                                |
-| CustomField   | Add, edit, delete or view Custom Fields.                                                                                                                                 |
-| Document      | Add, edit, delete or view Documents.                                                                                                                                     |
-| DocumentType  | Add, edit, delete or view Document Types.                                                                                                                                |
-| Group         | Add, edit, delete or view Groups.                                                                                                                                        |
-| MailAccount   | Add, edit, delete or view Mail Accounts.                                                                                                                                 |
-| MailRule      | Add, edit, delete or view Mail Rules.                                                                                                                                    |
-| Note          | Add, edit, delete or view Notes.                                                                                                                                         |
-| PaperlessTask | View or dismiss (_Change_) File Tasks.                                                                                                                                   |
-| SavedView     | Add, edit, delete or view Saved Views.                                                                                                                                   |
-| ShareLink     | Add, delete or view Share Links.                                                                                                                                         |
-| StoragePath   | Add, edit, delete or view Storage Paths.                                                                                                                                 |
-| Tag           | Add, edit, delete or view Tags.                                                                                                                                          |
-| UISettings    | Add, edit, delete or view the UI settings that are used by the web app.<br/>:warning: **Users that will access the web UI must be granted at least _View_ permissions.** |
-| User          | Add, edit, delete or view Users.                                                                                                                                         |
-| Workflow      | Add, edit, delete or view Workflows.<br/>Note that Workflows are global, in other words all users who can access workflows have access to the same set of them.          |
+| Type          | Details                                                                                                                                                                                             |
+| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| AppConfig     | _Change_ or higher permissions grants access to the "Application Configuration" area.                                                                                                               |
+| Correspondent | Grants global permissions to add, edit, delete or view Correspondents.                                                                                                                              |
+| CustomField   | Grants global permissions to add, edit, delete or view Custom Fields.                                                                                                                               |
+| Document      | Grants global permissions to add, edit, delete or view Documents.                                                                                                                                   |
+| DocumentType  | Grants global permissions to add, edit, delete or view Document Types.                                                                                                                              |
+| Group         | Grants global permissions to add, edit, delete or view Groups.                                                                                                                                      |
+| MailAccount   | Grants global permissions to add, edit, delete or view Mail Accounts.                                                                                                                               |
+| MailRule      | Grants global permissions to add, edit, delete or view Mail Rules.                                                                                                                                  |
+| Note          | Grants global permissions to add, edit, delete or view Notes.                                                                                                                                       |
+| PaperlessTask | Grants global permissions to view or dismiss (_Change_) File Tasks.                                                                                                                                 |
+| SavedView     | Grants global permissions to add, edit, delete or view Saved Views.                                                                                                                                 |
+| ShareLink     | Grants global permissions to add, delete or view Share Links.                                                                                                                                       |
+| StoragePath   | Grants global permissions to add, edit, delete or view Storage Paths.                                                                                                                               |
+| Tag           | Grants global permissions to add, edit, delete or view Tags.                                                                                                                                        |
+| UISettings    | Grants global permissions to add, edit, delete or view the UI settings that are used by the web app.<br/>Users expected to access the web UI should usually be granted at least _View_ permissions. |
+| User          | Grants global permissions to add, edit, delete or view Users.                                                                                                                                       |
+| Workflow      | Grants global permissions to add, edit, delete or view Workflows.<br/>Note that Workflows are global, in other words all users who can access workflows have access to the same set of them.        |
 
 #### Detailed Explanation of Object Permissions {#object-permissions}
 
@@ -299,12 +286,6 @@ In order to enable the password reset feature you will need to setup an SMTP bac
 [`PAPERLESS_EMAIL_HOST`](configuration.md#PAPERLESS_EMAIL_HOST). If your installation does not have
 [`PAPERLESS_URL`](configuration.md#PAPERLESS_URL) set, the reset link included in emails will use the server host.
 
-### Two-factor authentication
-
-Users can enable two-factor authentication (2FA) for their accounts from the 'My Profile' dialog. Opening the dropdown reveals a QR code that can be scanned by a 2FA app (e.g. Google Authenticator) to generate a code. The code must then be entered in the dialog to enable 2FA. If the code is accepted and 2FA is enabled, the user will be shown a set of 10 recovery codes that can be used to login in the event that the 2FA device is lost or unavailable. These codes should be stored securely and cannot be retrieved again. Once enabled, users will be required to enter a code from their 2FA app when logging in.
-
-Should a user lose access to their 2FA device and all recovery codes, a superuser can disable 2FA for the user from the 'Users & Groups' management screen.
-
 ## Workflows
 
 !!! note
@@ -322,8 +303,6 @@ fields and permissions, which will be merged.
 
 ### Workflow Triggers
 
-#### Types
-
 Currently, there are three events that correspond to workflow trigger 'types':
 
 1. **Consumption Started**: _before_ a document is consumed, so events can include filters by source (mail, consumption
@@ -333,10 +312,8 @@ Currently, there are three events that correspond to workflow trigger 'types':
    be used for filtering.
 3. **Document Updated**: when a document is updated. Similar to 'added' events, triggers can include filtering by content matching,
    tags, doc type, or correspondent.
-4. **Scheduled**: a scheduled trigger that can be used to run workflows at a specific time. The date used can be either the document
-   added, created, updated date or you can specify a (date) custom field. You can also specify a day offset from the date.
 
-The following flow diagram illustrates the three document trigger types:
+The following flow diagram illustrates the three trigger types:
 
 ```mermaid
 flowchart TD
@@ -370,88 +347,62 @@ flowchart TD
 
 Workflows 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 workflow source.
--   Content matching (`Added` and `Updated` triggers only). Filter document content using the matching settings.
--   Tags (`Added` and `Updated` triggers only). Filter for documents with any of the specified tags
--   Document type (`Added` and `Updated` triggers only). Filter documents with this doc type
--   Correspondent (`Added` and `Updated` triggers only). Filter documents with this correspondent
+- 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 workflow source.
+- Content matching (`Added` and `Updated` triggers only). Filter document content using the matching settings.
+- Tags (`Added` and `Updated` triggers only). Filter for documents with any of the specified tags
+- Document type (`Added` and `Updated` triggers only). Filter documents with this doc type
+- Correspondent (`Added` and `Updated` triggers only). Filter documents with this correspondent
 
 ### Workflow Actions
 
-#### Types
+There are currently two types of workflow actions, "Assignment", which can assign:
 
-The following workflow action types are available:
+- Title, see [title placeholders](usage.md#title-placeholders) below
+- Tags, correspondent, document type and storage path
+- Document owner
+- View and / or edit permissions to users or groups
+- Custom fields. Note that no value for the field will be set
 
-##### Assignment
+and "Removal" actions, which can remove either all of or specific sets of the following:
 
-"Assignment" actions can assign:
+- Tags, correspondents, document types or storage paths
+- Document owner
+- View and / or edit permissions
+- Custom fields
 
--   Title, see [workflow placeholders](usage.md#workflow-placeholders) below
--   Tags, correspondent, document type and storage path
--   Document owner
--   View and / or edit permissions to users or groups
--   Custom fields. Note that no value for the field will be set
+#### Title placeholders
 
-##### Removal
-
-"Removal" actions can remove either all of or specific sets of the following:
-
--   Tags, correspondents, document types or storage paths
--   Document owner
--   View and / or edit permissions
--   Custom fields
-
-##### Email
-
-"Email" actions can send documents via email. This action requires a mail server to be [configured](configuration.md#email-sending). You can specify:
-
--   The recipient email address(es) separated by commas
--   The subject and body of the email, which can include placeholders, see [placeholders](usage.md#workflow-placeholders) below
--   Whether to include the document as an attachment
-
-##### Webhook
-
-"Webhook" actions send a POST request to a specified URL. You can specify:
-
--   The URL to send the request to
--   The request body as text or as key-value pairs, which can include placeholders, see [placeholders](usage.md#workflow-placeholders) below.
--   The request headers as key-value pairs
-
-#### Workflow placeholders
-
-Some workflow text can include placeholders but the available options differ depending on the type of
-workflow trigger. This is because at the time of consumption (when the text is to be set), no automatic tags etc. have been
+Workflow titles can include placeholders but the available options differ depending on the type of
+workflow trigger. 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 with any trigger type:
 
--   `{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
--   `{added_time}`: added time in HH:MM format
--   `{original_filename}`: original file name without extension
--   `{filename}`: current file name without extension
+- `{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
+- `{added_time}`: added time in HH:MM format
+- `{original_filename}`: original file name without extension
 
 The following placeholders are only available for "added" or "updated" triggers
 
--   `{created}`: created datetime
--   `{created_year}`: created year
--   `{created_year_short}`: created year
--   `{created_month}`: created month
--   `{created_month_name}`: created month name
--   `{created_month_name_short}`: created month short name
--   `{created_day}`: created day
--   `{created_time}`: created time in HH:MM format
--   `{doc_url}`: URL to the document in the web UI. Requires the `PAPERLESS_URL` setting to be set.
+- `{created}`: created datetime
+- `{created_year}`: created year
+- `{created_year_short}`: created year
+- `{created_month}`: created month
+- `{created_month_name}`: created month name
+- `{created_month_name_short}`: created month short name
+- `{created_day}`: created day
+- `{created_time}`: created time in HH:MM format
 
 ### Workflow permissions
 
@@ -470,12 +421,13 @@ to optionally attach data to documents which does not fit in the existing set of
 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 from the dropdown. 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".
+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
+    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
@@ -486,24 +438,23 @@ Multiple fields may be attached to a document but the same field name cannot be
 
 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`: [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) and a number with exactly two decimals, e.g. USD12.30
--   `Document Link`: reference(s) to other document(s) displayed as links, automatically creates a symmetrical link in reverse
--   `Select`: a pre-defined list of strings from which the user can choose
+- `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`: [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) and a number with exactly two decimals, e.g. USD12.30
+- `Document Link`: reference(s) to other document(s) displayed as links, automatically creates a symmetrical link in reverse
 
 ## Share Links
 
 Paperless-ngx added the ability 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.
+- 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
 
@@ -511,16 +462,15 @@ Paperless-ngx added the ability to create shareable links to files in version 2.
 
 ## PDF Actions
 
-Paperless-ngx supports four basic editing operations for PDFs (these operations currently cannot be performed on non-PDF files):
+Paperless-ngx supports 3 basic editing operations for PDFs (these operations cannot be performed on non-PDF files):
 
--   Merging documents: available when selecting multiple documents for 'bulk editing'.
--   Rotating documents: available when selecting multiple documents for 'bulk editing' and from an individual document's details page.
--   Splitting documents: available from an individual document's details page.
--   Deleting pages: available from an individual document's details page.
+- Merging documents: available when selecting multiple documents for 'bulk editing'
+- Rotating documents: available when selecting multiple documents for 'bulk editing' and from an individual document's details page.
+- Splitting documents: available from an individual document's details page
 
 !!! important
 
-    Note that rotation and deleting pages alter the Paperless-ngx _original_ file, which would, for example, invalidate a digital signature.
+    Note that rotation alters the Paperless-ngx _original_ file, which would, for example, invalidate a digital signature.
 
 ## Document History
 
@@ -528,15 +478,6 @@ As of version 2.7, Paperless-ngx automatically records all changes to a document
 Changes to documents are visible under the "History" tab. Note that certain changes such as those made by workflows, record the 'actor'
 as "System".
 
-## Document Trash
-
-When you first delete a document it is moved to the 'trash' until either it is explicitly deleted or it is automatically removed after a set amount of time has passed.
-You can set how long documents remain in the trash before being automatically deleted with [`PAPERLESS_EMPTY_TRASH_DELAY`](configuration.md#PAPERLESS_EMPTY_TRASH_DELAY), which defaults
-to 30 days. Until the file is actually deleted (e.g. the trash is emptied), all files and database content remains intact and can be restored at any point up until that time.
-
-Additionally you may configure a directory where deleted files are moved to when they the trash is emptied with [`PAPERLESS_EMPTY_TRASH_DIR`](configuration.md#PAPERLESS_EMPTY_TRASH_DIR).
-Note that the empty trash directory only stores the original file, the archive file and all database information is permanently removed once a document is fully deleted.
-
 ## Best practices {#basic-searching}
 
 Paperless offers a couple tools that help you organize your document
@@ -594,31 +535,21 @@ the system.
 Here are a couple examples of tags and types that you could use in your
 collection.
 
--   An `inbox` tag for newly added documents that you haven't manually
-    edited yet.
--   A tag `car` for everything car related (repairs, registration,
-    insurance, etc)
--   A tag `todo` for documents that you still need to do something with,
-    such as reply, or perform some task online.
--   A tag `bank account x` for all bank statement related to that
-    account.
--   A tag `mail` for anything that you added to paperless via its mail
-    processing capabilities.
--   A tag `missing_metadata` when you still need to add some metadata to
-    a document, but can't or don't want to do this right now.
+- An `inbox` tag for newly added documents that you haven't manually
+  edited yet.
+- A tag `car` for everything car related (repairs, registration,
+  insurance, etc)
+- A tag `todo` for documents that you still need to do something with,
+  such as reply, or perform some task online.
+- A tag `bank account x` for all bank statement related to that
+  account.
+- A tag `mail` for anything that you added to paperless via its mail
+  processing capabilities.
+- A tag `missing_metadata` when you still need to add some metadata to
+  a document, but can't or don't want to do this right now.
 
 ## Searching {#basic-usage_searching}
 
-### Global search
-
-The top search bar in the web UI performs a "global" search of the various
-objects Paperless-ngx uses, including documents, tags, workflows, etc. Only
-objects for which the user has appropriate permissions are returned. For
-documents, if there are < 3 results, "advanced" search results (which use
-the document index) will also be included. This can be disabled under settings.
-
-### Document searches
-
 Paperless offers an extensive searching mechanism that is designed to
 allow you to quickly find a document you're looking for (for example,
 that thing that just broke and you bought a couple months ago, that
@@ -674,12 +605,6 @@ language](https://whoosh.readthedocs.io/en/latest/querylang.html). For
 details on what date parsing utilities are available, see [Date
 parsing](https://whoosh.readthedocs.io/en/latest/dates.html#parsing-date-queries).
 
-## Keyboard shortcuts / hotkeys
-
-A list of available hotkeys can be shown on any page using <kbd>Shift</kbd> +
-<kbd>?</kbd>. The help dialog shows only the keys that are currently available
-based on which area of Paperless-ngx you are using.
-
 ## The recommended workflow {#usage-recommended-workflow}
 
 Once you have familiarized yourself with paperless and are ready to use
@@ -694,8 +619,8 @@ The following diagram shows how easy it is to manage your documents.
 
 ### Preparations in paperless
 
--   Create an inbox tag that gets assigned to all new documents.
--   Create a TODO tag.
+- Create an inbox tag that gets assigned to all new documents.
+- Create a TODO tag.
 
 ### Processing of the physical documents
 
@@ -769,78 +694,78 @@ Some documents require attention and require you to act on the document.
 You may take two different approaches to handle these documents based on
 how regularly you intend to scan documents and use paperless.
 
--   If you scan and process your documents in paperless regularly,
-    assign a TODO tag to all scanned documents that you need to process.
-    Create a saved view on the dashboard that shows all documents with
-    this tag.
--   If you do not scan documents regularly and use paperless solely for
-    archiving, create a physical todo box next to your physical inbox
-    and put documents you need to process in the TODO box. When you
-    performed the task associated with the document, move it to the
-    inbox.
+- If you scan and process your documents in paperless regularly,
+  assign a TODO tag to all scanned documents that you need to process.
+  Create a saved view on the dashboard that shows all documents with
+  this tag.
+- If you do not scan documents regularly and use paperless solely for
+  archiving, create a physical todo box next to your physical inbox
+  and put documents you need to process in the TODO box. When you
+  performed the task associated with the document, move it to the
+  inbox.
 
 ## Architecture
 
 Paperless-ngx consists of the following components:
 
--   **The webserver:** This serves the administration pages, the API,
-    and the new frontend. This is the main tool you'll be using to interact
-    with paperless. You may start the webserver directly with
+- **The webserver:** This serves the administration pages, the API,
+  and the new frontend. This is the main tool you'll be using to interact
+  with paperless. You may start the webserver directly with
 
-    ```shell-session
-    cd /path/to/paperless/src/
-    gunicorn -c ../gunicorn.conf.py paperless.wsgi
-    ```
+  ```shell-session
+  $ cd /path/to/paperless/src/
+  $ gunicorn -c ../gunicorn.conf.py paperless.wsgi
+  ```
 
-    or by any other means such as Apache `mod_wsgi`.
+  or by any other means such as Apache `mod_wsgi`.
 
--   **The consumer:** This is what watches your consumption folder for
-    documents. However, the consumer itself does not really consume your
-    documents. Now it notifies a task processor that a new file is ready
-    for consumption. I suppose it should be named differently. This was
-    also used to check your emails, but that's now done elsewhere as
-    well.
+- **The consumer:** This is what watches your consumption folder for
+  documents. However, the consumer itself does not really consume your
+  documents. Now it notifies a task processor that a new file is ready
+  for consumption. I suppose it should be named differently. This was
+  also used to check your emails, but that's now done elsewhere as
+  well.
 
-    Start the consumer with the management command `document_consumer`:
+  Start the consumer with the management command `document_consumer`:
 
-    ```shell-session
-    cd /path/to/paperless/src/
-    python3 manage.py document_consumer
-    ```
+  ```shell-session
+  $ cd /path/to/paperless/src/
+  $ python3 manage.py document_consumer
+  ```
 
--   **The task processor:** Paperless relies on [Celery - Distributed
-    Task Queue](https://docs.celeryq.dev/en/stable/index.html) for doing
-    most of the heavy lifting. This is a task queue that accepts tasks
-    from multiple sources and processes these in parallel. It also comes
-    with a scheduler that executes certain commands periodically.
+- **The task processor:** Paperless relies on [Celery - Distributed
+  Task Queue](https://docs.celeryq.dev/en/stable/index.html) for doing
+  most of the heavy lifting. This is a task queue that accepts tasks
+  from multiple sources and processes these in parallel. It also comes
+  with a scheduler that executes certain commands periodically.
 
-    This task processor is responsible for:
+  This task processor is responsible for:
 
-    -   Consuming documents. When the consumer finds new documents, it
-        notifies the task processor to start a consumption task.
-    -   The task processor also performs the consumption of any
-        documents you upload through the web interface.
-    -   Consuming emails. It periodically checks your configured
-        accounts for new emails and notifies the task processor to
-        consume the attachment of an email.
-    -   Maintaining the search index and the automatic matching
-        algorithm. These are things that paperless needs to do from time
-        to time in order to operate properly.
+  - Consuming documents. When the consumer finds new documents, it
+    notifies the task processor to start a consumption task.
+  - The task processor also performs the consumption of any
+    documents you upload through the web interface.
+  - Consuming emails. It periodically checks your configured
+    accounts for new emails and notifies the task processor to
+    consume the attachment of an email.
+  - Maintaining the search index and the automatic matching
+    algorithm. These are things that paperless needs to do from time
+    to time in order to operate properly.
 
-    This allows paperless to process multiple documents from your
-    consumption folder in parallel! On a modern multi core system, this
-    makes the consumption process with full OCR blazingly fast.
+  This allows paperless to process multiple documents from your
+  consumption folder in parallel! On a modern multi core system, this
+  makes the consumption process with full OCR blazingly fast.
 
-    The task processor comes with a built-in admin interface that you
-    can use to check whenever any of the tasks fail and inspect the
-    errors (i.e., wrong email credentials, errors during consuming a
-    specific file, etc).
+  The task processor comes with a built-in admin interface that you
+  can use to check whenever any of the tasks fail and inspect the
+  errors (i.e., wrong email credentials, errors during consuming a
+  specific file, etc).
 
--   A [redis](https://redis.io/) message broker: This is a really
-    lightweight service that is responsible for getting the tasks from
-    the webserver and the consumer to the task scheduler. These run in a
-    different process (maybe even on different machines!), and
-    therefore, this is necessary.
+- A [redis](https://redis.io/) message broker: This is a really
+  lightweight service that is responsible for getting the tasks from
+  the webserver and the consumer to the task scheduler. These run in a
+  different process (maybe even on different machines!), and
+  therefore, this is necessary.
 
--   Optional: A database server. Paperless supports PostgreSQL, MariaDB
-    and SQLite for storing its data.
+- Optional: A database server. Paperless supports PostgreSQL, MariaDB
+  and SQLite for storing its data.

gunicorn.conf.py

@@ -37,11 +37,11 @@ def worker_int(worker):
     id2name = {th.ident: th.name for th in threading.enumerate()}
     code = []
     for threadId, stack in sys._current_frames().items():
-        code.append(f"\n# Thread: {id2name.get(threadId, '')}({threadId})")
+        code.append("\n# Thread: %s(%d)" % (id2name.get(threadId, ""), threadId))
         for filename, lineno, name, line in traceback.extract_stack(stack):
-            code.append(f'File: "{filename}", line {lineno}, in {name}')
+            code.append('File: "%s", line %d, in %s' % (filename, lineno, name))
             if line:
-                code.append(f"  {line.strip()}")
+                code.append("  %s" % (line.strip()))
     worker.log.debug("\n".join(code))
 
 

install-paperless-ngx.sh

@@ -330,13 +330,8 @@ SECRET_KEY=$(LC_ALL=C tr -dc 'a-zA-Z0-9!#$%&()*+,-./:;<=>?@[\]^_`{|}~' < /dev/ur
 
 DEFAULT_LANGUAGES=("deu eng fra ita spa")
 
-# OCR_LANG requires underscores, replace dashes if the user gave them with underscores
-readonly ocr_langs=${OCR_LANGUAGE//-/_}
-# OCR_LANGS (the install version) uses dashes, not underscores, so convert underscore to dash and plus to space
-install_langs=${OCR_LANGUAGE//_/-}    # First convert any underscores to dashes
-install_langs=${install_langs//+/ }    # Then convert plus signs to spaces
-
-read -r -a install_langs_array <<< "${install_langs}"
+_split_langs="${OCR_LANGUAGE//+/ }"
+read -r -a OCR_LANGUAGES_ARRAY <<< "${_split_langs}"
 
 {
 	if [[ ! $URL == "" ]] ; then
@@ -349,10 +344,10 @@ read -r -a install_langs_array <<< "${install_langs}"
 		echo "USERMAP_GID=$USERMAP_GID"
 	fi
 	echo "PAPERLESS_TIME_ZONE=$TIME_ZONE"
-	echo "PAPERLESS_OCR_LANGUAGE=$ocr_langs"
+	echo "PAPERLESS_OCR_LANGUAGE=$OCR_LANGUAGE"
 	echo "PAPERLESS_SECRET_KEY='$SECRET_KEY'"
-	if [[ ! ${DEFAULT_LANGUAGES[*]} =~ ${install_langs_array[*]} ]] ; then
-		echo "PAPERLESS_OCR_LANGUAGES=${install_langs_array[*]}"
+	if [[ ! ${DEFAULT_LANGUAGES[*]} =~ ${OCR_LANGUAGES_ARRAY[*]} ]] ; then
+		echo "PAPERLESS_OCR_LANGUAGES=${OCR_LANGUAGES_ARRAY[*]}"
 	fi
 } > docker-compose.env
 

mkdocs.yml

@@ -6,12 +6,6 @@ theme:
     text: Roboto
     code: Roboto Mono
   palette:
-    # Palette toggle for automatic mode
-    - media: "(prefers-color-scheme)"
-      toggle:
-        icon: material/brightness-auto
-        name: Switch to light mode
-
     # Palette toggle for light mode
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -24,7 +18,7 @@ theme:
       scheme: slate
       toggle:
         icon: material/brightness-4
-        name: Switch to system preference
+        name: Switch to light mode
   features:
     - navigation.tabs
     - navigation.top
@@ -55,9 +49,6 @@ markdown_extensions:
         - name: mermaid
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_code_format
-  - pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:material.extensions.emoji.to_svg
 strict: true
 nav:
     - index.md

paperless-ngx.code-workspace

@@ -31,11 +31,6 @@
 			"**/.venv": true,
 			"**/.coverage": true,
 			"**/coverage.json": true
-		},
-		"python.defaultInterpreterPath": ".venv/bin/python3",
-	},
-	"extensions": {
-		"recommendations": ["ms-python.python", "charliermarsh.ruff", "editorconfig.editorconfig"],
-		"unwantedRecommendations": ["ms-python.black-formatter"]
+		}
 	}
 }

paperless.conf.example

@@ -19,7 +19,7 @@
 
 #PAPERLESS_CONSUMPTION_DIR=../consume
 #PAPERLESS_DATA_DIR=../data
-#PAPERLESS_EMPTY_TRASH_DIR=
+#PAPERLESS_TRASH_DIR=
 #PAPERLESS_MEDIA_ROOT=../media
 #PAPERLESS_STATICDIR=../static
 #PAPERLESS_FILENAME_FORMAT=

scripts/post-consumption-example.sh

@@ -14,7 +14,6 @@ following additional information about it:
 * Thumbnail Path: ${DOCUMENT_THUMBNAIL_PATH}
 * Download URL: ${DOCUMENT_DOWNLOAD_URL}
 * Thumbnail URL: ${DOCUMENT_THUMBNAIL_URL}
-* Owner Name: ${DOCUMENT_OWNER}
 * Correspondent: ${DOCUMENT_CORRESPONDENT}
 * Tags: ${DOCUMENT_TAGS}
 

scripts/start_services.sh

@@ -3,4 +3,4 @@
 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 docker.io/apache/tika:latest
+docker run -p 9998:9998 -d ghcr.io/paperless-ngx/tika:latest

src-ui/.eslintrc.json

@@ -11,7 +11,8 @@
       ],
       "parserOptions": {
         "project": [
-          "tsconfig.json"
+          "tsconfig.json",
+          "e2e/tsconfig.json"
         ],
         "createDefaultProgram": true
       },

src-ui/angular.json

@@ -33,7 +33,6 @@
           "it-IT": "src/locale/messages.it_IT.xlf",
           "ja-JP": "src/locale/messages.ja_JP.xlf",
           "lb-LU": "src/locale/messages.lb_LU.xlf",
-          "ko-KR": "src/locale/messages.ko_KR.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",
@@ -52,11 +51,8 @@
       },
       "architect": {
         "build": {
-          "builder": "@angular-builders/custom-webpack:browser",
+          "builder": "@angular-devkit/build-angular:browser",
           "options": {
-            "customWebpackConfig": {
-                "path": "./extra-webpack.config.ts"
-            },
             "outputPath": "dist/paperless-ui",
             "outputHashing": "none",
             "index": "src/index.html",
@@ -70,8 +66,8 @@
               "src/assets",
               "src/manifest.webmanifest",
               {
-                "glob": "{pdf.worker.min.mjs,pdf.min.mjs}",
-                "input": "node_modules/pdfjs-dist/legacy/build/",
+                "glob": "{pdf.worker.min.js,pdf.min.js}",
+                "input": "node_modules/pdfjs-dist/build/",
                 "output": "/assets/js/"
               }
             ],
@@ -80,7 +76,9 @@
             ],
             "scripts": [],
             "allowedCommonJsDependencies": [
-              "ng2-pdf-viewer",
+              "pdfjs-dist",
+              "pdfjs-dist/web/pdf_viewer",
+              "filesize",
               "file-saver"
             ],
             "vendorChunk": true,
@@ -128,7 +126,7 @@
           "defaultConfiguration": ""
         },
         "serve": {
-          "builder": "@angular-builders/custom-webpack:dev-server",
+          "builder": "@angular-devkit/build-angular:dev-server",
           "options": {
             "buildTarget": "paperless-ui:build:en-US"
           },
@@ -139,7 +137,7 @@
           }
         },
         "extract-i18n": {
-          "builder": "@angular-builders/custom-webpack:extract-i18n",
+          "builder": "@angular-devkit/build-angular:extract-i18n",
           "options": {
             "buildTarget": "paperless-ui:build"
           }

src-ui/e2e/admin/settings.spec.ts

@@ -1,7 +1,6 @@
-import { expect, test } from '@playwright/test'
-import path from 'node:path'
+import { test, expect } from '@playwright/test'
 
-const REQUESTS_HAR = path.join(__dirname, 'requests/api-settings.har')
+const REQUESTS_HAR = 'e2e/admin/requests/api-settings.har'
 
 test('should activate / deactivate save button when settings change', async ({
   page,
@@ -34,3 +33,24 @@ test('should apply appearance changes when set', async ({ page }) => {
   await page.getByLabel('Enable dark mode').click()
   await expect(page.locator('html')).toHaveAttribute('data-bs-theme', /dark/)
 })
+
+test('should toggle saved view options when set & saved', async ({ page }) => {
+  await page.routeFromHAR(REQUESTS_HAR, { notFound: 'fallback' })
+  await page.goto('/settings/savedviews')
+  await page.getByLabel('Show on dashboard').first().click()
+  await page.getByLabel('Show in sidebar').first().click()
+  const updatePromise = page.waitForRequest((request) => {
+    if (!request.url().includes('8')) return true // skip other saved views
+    const data = request.postDataJSON()
+    const isValid =
+      data['show_on_dashboard'] === true && data['show_in_sidebar'] === true
+    return (
+      isValid &&
+      request.method() === 'PATCH' &&
+      request.url().includes('/api/saved_views/')
+    )
+  })
+  await page.getByRole('button', { name: 'Save' }).scrollIntoViewIfNeeded()
+  await page.getByRole('button', { name: 'Save' }).click()
+  await updatePromise
+})

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

@@ -1,16 +1,15 @@
-import { expect, test } from '@playwright/test'
-import path from 'node:path'
+import { test, expect } from '@playwright/test'
 
-const REQUESTS_HAR1 = path.join(__dirname, 'requests/api-dashboard1.har')
-const REQUESTS_HAR2 = path.join(__dirname, 'requests/api-dashboard2.har')
-const REQUESTS_HAR3 = path.join(__dirname, 'requests/api-dashboard3.har')
-const REQUESTS_HAR4 = path.join(__dirname, 'requests/api-dashboard4.har')
+const REQUESTS_HAR1 = 'e2e/dashboard/requests/api-dashboard1.har'
+const REQUESTS_HAR2 = 'e2e/dashboard/requests/api-dashboard2.har'
+const REQUESTS_HAR3 = 'e2e/dashboard/requests/api-dashboard3.har'
+const REQUESTS_HAR4 = 'e2e/dashboard/requests/api-dashboard4.har'
 
 test('dashboard inbox link', async ({ page }) => {
   await page.routeFromHAR(REQUESTS_HAR1, { notFound: 'fallback' })
   await page.goto('/dashboard')
   await page.getByRole('link', { name: 'Documents in inbox' }).click()
-  await expect(page).toHaveURL(/tags__id__in=9/)
+  await expect(page).toHaveURL(/tags__id__all=9/)
   await expect(page.locator('pngx-document-list')).toHaveText(/8 documents/)
 })
 

src-ui/e2e/dashboard/requests/api-dashboard1.har

@@ -236,7 +236,7 @@
           "content": {
             "size": -1,
             "mimeType": "application/json",
-            "text": "{\"documents_total\":61,\"documents_inbox\":8,\"inbox_tags\":[9],\"document_file_type_counts\":[{\"mime_type\":\"application/pdf\",\"mime_type_count\":57},{\"mime_type\":\"text/plain\",\"mime_type_count\":3},{\"mime_type\":\"text/csv\",\"mime_type_count\":1}],\"character_count\":2407053}"
+            "text": "{\"documents_total\":61,\"documents_inbox\":8,\"inbox_tag\":9,\"document_file_type_counts\":[{\"mime_type\":\"application/pdf\",\"mime_type_count\":57},{\"mime_type\":\"text/plain\",\"mime_type_count\":3},{\"mime_type\":\"text/csv\",\"mime_type_count\":1}],\"character_count\":2407053}"
           },
           "headersSize": -1,
           "bodySize": -1,
@@ -250,7 +250,7 @@
         "time": 0.609,
         "request": {
           "method": "GET",
-          "url": "http://localhost:8000/api/documents/?page=1&page_size=10&ordering=-created&truncate_content=true&tags__id__in=9",
+          "url": "http://localhost:8000/api/documents/?page=1&page_size=10&ordering=-created&truncate_content=true&tags__id__all=9",
           "httpVersion": "HTTP/1.1",
           "cookies": [],
           "headers": [
@@ -284,7 +284,7 @@
               "value": "true"
             },
             {
-              "name": "tags__id__in",
+              "name": "tags__id__all",
               "value": "9"
             }
           ],
@@ -468,7 +468,7 @@
         "time": 0.951,
         "request": {
           "method": "GET",
-          "url": "http://localhost:8000/api/documents/?page=1&page_size=50&ordering=-created&truncate_content=true&tags__id__in=9",
+          "url": "http://localhost:8000/api/documents/?page=1&page_size=50&ordering=-created&truncate_content=true&tags__id__all=9",
           "httpVersion": "HTTP/1.1",
           "cookies": [],
           "headers": [
@@ -502,7 +502,7 @@
               "value": "true"
             },
             {
-              "name": "tags__id__in",
+              "name": "tags__id__all",
               "value": "9"
             }
           ],

src-ui/e2e/dashboard/requests/api-dashboard2.har

@@ -236,7 +236,7 @@
           "content": {
             "size": -1,
             "mimeType": "application/json",
-            "text": "{\"documents_total\":61,\"documents_inbox\":8,\"inbox_tags\":[9],\"document_file_type_counts\":[{\"mime_type\":\"application/pdf\",\"mime_type_count\":57},{\"mime_type\":\"text/plain\",\"mime_type_count\":3},{\"mime_type\":\"text/csv\",\"mime_type_count\":1}],\"character_count\":2407053}"
+            "text": "{\"documents_total\":61,\"documents_inbox\":8,\"inbox_tag\":9,\"document_file_type_counts\":[{\"mime_type\":\"application/pdf\",\"mime_type_count\":57},{\"mime_type\":\"text/plain\",\"mime_type_count\":3},{\"mime_type\":\"text/csv\",\"mime_type_count\":1}],\"character_count\":2407053}"
           },
           "headersSize": -1,
           "bodySize": -1,
@@ -250,7 +250,7 @@
         "time": 0.622,
         "request": {
           "method": "GET",
-          "url": "http://localhost:8000/api/documents/?page=1&page_size=10&ordering=-created&truncate_content=true&tags__id__in=9",
+          "url": "http://localhost:8000/api/documents/?page=1&page_size=10&ordering=-created&truncate_content=true&tags__id__all=9",
           "httpVersion": "HTTP/1.1",
           "cookies": [],
           "headers": [
@@ -284,7 +284,7 @@
               "value": "true"
             },
             {
-              "name": "tags__id__in",
+              "name": "tags__id__all",
               "value": "9"
             }
           ],

src-ui/e2e/dashboard/requests/api-dashboard3.har

@@ -236,7 +236,7 @@
           "content": {
             "size": -1,
             "mimeType": "application/json",
-            "text": "{\"documents_total\":61,\"documents_inbox\":8,\"inbox_tags\":[9],\"document_file_type_counts\":[{\"mime_type\":\"application/pdf\",\"mime_type_count\":57},{\"mime_type\":\"text/plain\",\"mime_type_count\":3},{\"mime_type\":\"text/csv\",\"mime_type_count\":1}],\"character_count\":2407053}"
+            "text": "{\"documents_total\":61,\"documents_inbox\":8,\"inbox_tag\":9,\"document_file_type_counts\":[{\"mime_type\":\"application/pdf\",\"mime_type_count\":57},{\"mime_type\":\"text/plain\",\"mime_type_count\":3},{\"mime_type\":\"text/csv\",\"mime_type_count\":1}],\"character_count\":2407053}"
           },
           "headersSize": -1,
           "bodySize": -1,

src-ui/e2e/dashboard/requests/api-dashboard4.har

@@ -236,7 +236,7 @@
           "content": {
             "size": -1,
             "mimeType": "application/json",
-            "text": "{\"documents_total\":61,\"documents_inbox\":8,\"inbox_tags\":[9],\"document_file_type_counts\":[{\"mime_type\":\"application/pdf\",\"mime_type_count\":57},{\"mime_type\":\"text/plain\",\"mime_type_count\":3},{\"mime_type\":\"text/csv\",\"mime_type_count\":1}],\"character_count\":2407053}"
+            "text": "{\"documents_total\":61,\"documents_inbox\":8,\"inbox_tag\":9,\"document_file_type_counts\":[{\"mime_type\":\"application/pdf\",\"mime_type_count\":57},{\"mime_type\":\"text/plain\",\"mime_type_count\":3},{\"mime_type\":\"text/csv\",\"mime_type_count\":1}],\"character_count\":2407053}"
           },
           "headersSize": -1,
           "bodySize": -1,

src-ui/e2e/document-detail/document-detail.spec.ts

@@ -1,8 +1,7 @@
-import { expect, test } from '@playwright/test'
-import path from 'node:path'
+import { test, expect } from '@playwright/test'
 
-const REQUESTS_HAR = path.join(__dirname, 'requests/api-document-detail.har')
-const REQUESTS_HAR2 = path.join(__dirname, 'requests/api-document-detail2.har')
+const REQUESTS_HAR = 'e2e/document-detail/requests/api-document-detail.har'
+const REQUESTS_HAR2 = 'e2e/document-detail/requests/api-document-detail2.har'
 
 test('should activate / deactivate save button when changes are saved', async ({
   page,
@@ -72,7 +71,7 @@ test('should show a mobile preview', async ({ page }) => {
   await page.setViewportSize({ width: 400, height: 1000 })
   await expect(page.getByRole('tab', { name: 'Preview' })).toBeVisible()
   await page.getByRole('tab', { name: 'Preview' }).click()
-  await page.waitForSelector('pdf-viewer')
+  await page.waitForSelector('pngx-pdf-viewer')
 })
 
 test('should show a list of notes', async ({ page }) => {

src-ui/e2e/document-list/document-list.spec.ts

@@ -1,12 +1,11 @@
-import { expect, test } from '@playwright/test'
-import path from 'node:path'
+import { test, expect } from '@playwright/test'
 
-const REQUESTS_HAR1 = path.join(__dirname, 'requests/api-document-list1.har')
-const REQUESTS_HAR2 = path.join(__dirname, 'requests/api-document-list2.har')
-const REQUESTS_HAR3 = path.join(__dirname, 'requests/api-document-list3.har')
-const REQUESTS_HAR4 = path.join(__dirname, 'requests/api-document-list4.har')
-const REQUESTS_HAR5 = path.join(__dirname, 'requests/api-document-list5.har')
-const REQUESTS_HAR6 = path.join(__dirname, 'requests/api-document-list6.har')
+const REQUESTS_HAR1 = 'e2e/document-list/requests/api-document-list1.har'
+const REQUESTS_HAR2 = 'e2e/document-list/requests/api-document-list2.har'
+const REQUESTS_HAR3 = 'e2e/document-list/requests/api-document-list3.har'
+const REQUESTS_HAR4 = 'e2e/document-list/requests/api-document-list4.har'
+const REQUESTS_HAR5 = 'e2e/document-list/requests/api-document-list5.har'
+const REQUESTS_HAR6 = 'e2e/document-list/requests/api-document-list6.har'
 
 test('basic filtering', async ({ page }) => {
   await page.routeFromHAR(REQUESTS_HAR1, { notFound: 'fallback' })
@@ -46,8 +45,8 @@ test('basic filtering', async ({ page }) => {
 test('text filtering', async ({ page }) => {
   await page.routeFromHAR(REQUESTS_HAR2, { notFound: 'fallback' })
   await page.goto('/documents')
-  await page.getByRole('main').getByRole('combobox').click()
-  await page.getByRole('main').getByRole('combobox').fill('test')
+  await page.getByRole('textbox').click()
+  await page.getByRole('textbox').fill('test')
   await expect(page.locator('pngx-document-list')).toHaveText(/32 documents/)
   await expect(page).toHaveURL(/title_content=test/)
   await page.getByRole('button', { name: 'Title & content' }).click()
@@ -60,12 +59,12 @@ test('text filtering', async ({ page }) => {
   await expect(page.locator('pngx-document-list')).toHaveText(/26 documents/)
   await page.getByRole('button', { name: 'Advanced search' }).click()
   await page.getByRole('button', { name: 'ASN' }).click()
-  await page.getByRole('main').getByRole('combobox').nth(1).fill('1123')
+  await page.getByRole('textbox').fill('1123')
   await expect(page).toHaveURL(/archive_serial_number=1123/)
   await expect(page.locator('pngx-document-list')).toHaveText(/one document/i)
   await page.locator('select').selectOption('greater')
-  await page.getByRole('main').getByRole('combobox').nth(1).click()
-  await page.getByRole('main').getByRole('combobox').nth(1).fill('1123')
+  await page.getByRole('textbox').click()
+  await page.getByRole('textbox').fill('1123')
   await expect(page).toHaveURL(/archive_serial_number__gt=1123/)
   await expect(page.locator('pngx-document-list')).toHaveText(/5 documents/)
   await page.locator('select').selectOption('less')
@@ -85,8 +84,13 @@ test('date filtering', async ({ page }) => {
   await page.getByRole('button', { name: 'Dates' }).click()
   await page.getByRole('menuitem', { name: 'Last 3 months' }).first().click()
   await expect(page.locator('pngx-document-list')).toHaveText(/one document/i)
-  await page.getByRole('menuitem', { name: 'Last 3 months' }).first().click()
-  await page.getByLabel('Datesselected').getByRole('button').first().click()
+  await page.getByRole('button', { name: 'Dates Clear selected' }).click()
+  await page.getByRole('button', { name: 'Dates' }).click()
+  await page
+    .getByRole('menuitem', { name: 'After mm/dd/yyyy' })
+    .getByRole('button')
+    .first()
+    .click()
   await page.getByRole('combobox', { name: 'Select month' }).selectOption('12')
   await page.getByRole('combobox', { name: 'Select year' }).selectOption('2022')
   await page.getByText('11', { exact: true }).click()
@@ -135,11 +139,11 @@ test('sorting', async ({ page }) => {
 test('change views', async ({ page }) => {
   await page.routeFromHAR(REQUESTS_HAR5, { notFound: 'fallback' })
   await page.goto('/documents')
-  await page.locator('.btn-group > label').first().click()
+  await page.locator('.btn-group label').first().click()
   await expect(page.locator('pngx-document-list table')).toBeVisible()
-  await page.locator('label:nth-child(4)').first().click()
+  await page.locator('.btn-group label').nth(1).click()
   await expect(page.locator('pngx-document-card-small').first()).toBeAttached()
-  await page.locator('label:nth-child(6)').click()
+  await page.locator('.btn-group label').nth(2).click()
   await expect(page.locator('pngx-document-card-large').first()).toBeAttached()
 })
 

src-ui/e2e/permissions/global-permissions.spec.ts

@@ -1,7 +1,6 @@
-import { expect, test } from '@playwright/test'
-import path from 'node:path'
+import { test, expect } from '@playwright/test'
 
-const REQUESTS_HAR = path.join(__dirname, 'requests/api-global-permissions.har')
+const REQUESTS_HAR = 'e2e/permissions/requests/api-global-permissions.har'
 
 test('should not allow user to edit settings', async ({ page }) => {
   await page.routeFromHAR(REQUESTS_HAR, { notFound: 'fallback' })

src-ui/extra-webpack.config.ts

@@ -1,24 +0,0 @@
-import {
-  CustomWebpackBrowserSchema,
-  TargetOptions,
-} from '@angular-builders/custom-webpack'
-import * as webpack from 'webpack'
-const { codecovWebpackPlugin } = require('@codecov/webpack-plugin')
-
-export default (
-  config: webpack.Configuration,
-  options: CustomWebpackBrowserSchema,
-  targetOptions: TargetOptions
-) => {
-  if (config.plugins) {
-    config.plugins.push(
-      codecovWebpackPlugin({
-        enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
-        bundleName: 'paperless-ngx',
-        uploadToken: process.env.CODECOV_TOKEN,
-      })
-    )
-  }
-
-  return config
-}

src-ui/jest.config.js

@@ -7,6 +7,7 @@ module.exports = {
     'abstract-name-filter-service',
     'abstract-paperless-service',
   ],
+  coveragePathIgnorePatterns: ['/src/app/components/common/pdf-viewer/*'],
   transformIgnorePatterns: [`<rootDir>/node_modules/(?!.*\\.mjs$|lodash-es)`],
   moduleNameMapper: {
     '^src/(.*)': '<rootDir>/src/$1',

src-ui/package.json

@@ -11,63 +11,58 @@
   },
   "private": true,
   "dependencies": {
-    "@angular/cdk": "^19.0.2",
-    "@angular/common": "~19.0.3",
-    "@angular/compiler": "~19.0.3",
-    "@angular/core": "~19.0.3",
-    "@angular/forms": "~19.0.3",
-    "@angular/localize": "~19.0.3",
-    "@angular/platform-browser": "~19.0.3",
-    "@angular/platform-browser-dynamic": "~19.0.3",
-    "@angular/router": "~19.0.3",
-    "@ng-bootstrap/ng-bootstrap": "^18.0.0",
-    "@ng-select/ng-select": "^14.1.0",
+    "@angular/cdk": "^17.3.2",
+    "@angular/common": "~17.3.2",
+    "@angular/compiler": "~17.3.2",
+    "@angular/core": "~17.3.2",
+    "@angular/forms": "~17.3.2",
+    "@angular/localize": "~17.3.2",
+    "@angular/platform-browser": "~17.3.2",
+    "@angular/platform-browser-dynamic": "~17.3.2",
+    "@angular/router": "~17.3.2",
+    "@ng-bootstrap/ng-bootstrap": "^16.0.0",
+    "@ng-select/ng-select": "^12.0.7",
     "@ngneat/dirty-check-forms": "^3.0.3",
     "@popperjs/core": "^2.11.8",
     "bootstrap": "^5.3.3",
     "file-saver": "^2.0.5",
     "mime-names": "^1.0.0",
-    "ng2-pdf-viewer": "^10.4.0",
     "ngx-bootstrap-icons": "^1.9.3",
     "ngx-color": "^9.0.0",
-    "ngx-cookie-service": "^19.0.0",
+    "ngx-cookie-service": "^17.1.0",
     "ngx-file-drop": "^16.0.0",
-    "ngx-ui-tour-ng-bootstrap": "^16.0.0",
+    "ngx-filesize": "^3.0.3",
+    "ngx-ui-tour-ng-bootstrap": "^14.0.2",
+    "pdfjs-dist": "^3.11.174",
     "rxjs": "^7.8.1",
-    "tslib": "^2.8.1",
-    "utif": "^3.1.0",
-    "uuid": "^11.0.2",
-    "zone.js": "^0.15.0"
+    "tslib": "^2.6.2",
+    "uuid": "^9.0.1",
+    "zone.js": "^0.14.4"
   },
   "devDependencies": {
-    "@angular-builders/custom-webpack": "^19.0.0-beta.0",
-    "@angular-builders/jest": "^19.0.0-beta.1",
-    "@angular-devkit/build-angular": "^19.0.4",
-    "@angular-devkit/core": "^19.0.4",
-    "@angular-devkit/schematics": "^19.0.4",
-    "@angular-eslint/builder": "19.0.0",
-    "@angular-eslint/eslint-plugin": "19.0.0",
-    "@angular-eslint/eslint-plugin-template": "19.0.0",
-    "@angular-eslint/schematics": "19.0.0",
-    "@angular-eslint/template-parser": "19.0.0",
-    "@angular/cli": "~19.0.4",
-    "@angular/compiler-cli": "~19.0.3",
-    "@codecov/webpack-plugin": "^1.2.1",
-    "@playwright/test": "^1.48.2",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.8.6",
-    "@typescript-eslint/eslint-plugin": "^8.12.2",
-    "@typescript-eslint/parser": "^8.12.2",
-    "@typescript-eslint/utils": "^8.0.0",
-    "eslint": "^9.14.0",
+    "@angular-builders/jest": "17.0.2",
+    "@angular-devkit/build-angular": "~17.3.2",
+    "@angular-eslint/builder": "17.3.0",
+    "@angular-eslint/eslint-plugin": "17.3.0",
+    "@angular-eslint/eslint-plugin-template": "17.3.0",
+    "@angular-eslint/schematics": "17.3.0",
+    "@angular-eslint/template-parser": "17.3.0",
+    "@angular/cli": "~17.3.2",
+    "@angular/compiler-cli": "~17.3.2",
+    "@playwright/test": "^1.42.1",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.2",
+    "@typescript-eslint/eslint-plugin": "^7.4.0",
+    "@typescript-eslint/parser": "^7.4.0",
+    "concurrently": "^8.2.2",
+    "eslint": "^8.57.0",
     "jest": "29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "jest-preset-angular": "^14.4.2",
+    "jest-preset-angular": "^14.0.0",
     "jest-websocket-mock": "^2.5.0",
     "patch-package": "^8.0.0",
-    "prettier-plugin-organize-imports": "^4.1.0",
     "ts-node": "~10.9.1",
-    "typescript": "^5.5.4"
-  },
-  "typings": "./src/typings.d.ts"
+    "typescript": "^5.3.3",
+    "wait-on": "^7.2.0"
+  }
 }

src-ui/setup-jest.ts

@@ -1,10 +1,9 @@
-import '@angular/localize/init'
 import { jest } from '@jest/globals'
-import { setupZoneTestEnv } from 'jest-preset-angular/setup-env/zone'
-import { TextDecoder, TextEncoder } from 'util'
 if (process.env.NODE_ENV === 'test') {
-  setupZoneTestEnv()
+  require('jest-preset-angular/setup-jest')
 }
+import '@angular/localize/init'
+import { TextEncoder, TextDecoder } from 'util'
 global.TextEncoder = TextEncoder
 global.TextDecoder = TextDecoder
 
@@ -25,7 +24,6 @@ import localeFr from '@angular/common/locales/fr'
 import localeHu from '@angular/common/locales/hu'
 import localeIt from '@angular/common/locales/it'
 import localeJa from '@angular/common/locales/ja'
-import localeKo from '@angular/common/locales/ko'
 import localeLb from '@angular/common/locales/lb'
 import localeNl from '@angular/common/locales/nl'
 import localeNo from '@angular/common/locales/no'
@@ -57,7 +55,6 @@ registerLocaleData(localeFr)
 registerLocaleData(localeHu)
 registerLocaleData(localeIt)
 registerLocaleData(localeJa)
-registerLocaleData(localeKo)
 registerLocaleData(localeLb)
 registerLocaleData(localeNl)
 registerLocaleData(localeNo)
@@ -88,7 +85,6 @@ const mock = () => {
   }
 }
 
-Object.defineProperty(window, 'open', { value: jest.fn() })
 Object.defineProperty(window, 'localStorage', { value: mock() })
 Object.defineProperty(window, 'sessionStorage', { value: mock() })
 Object.defineProperty(window, 'getComputedStyle', {

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

@@ -1,33 +1,31 @@
 import { NgModule } from '@angular/core'
-import { RouterModule, Routes } from '@angular/router'
-import { ConfigComponent } from './components/admin/config/config.component'
-import { LogsComponent } from './components/admin/logs/logs.component'
-import { SettingsComponent } from './components/admin/settings/settings.component'
-import { TasksComponent } from './components/admin/tasks/tasks.component'
-import { TrashComponent } from './components/admin/trash/trash.component'
-import { UsersAndGroupsComponent } from './components/admin/users-groups/users-groups.component'
+import { Routes, RouterModule } from '@angular/router'
 import { AppFrameComponent } from './components/app-frame/app-frame.component'
 import { DashboardComponent } from './components/dashboard/dashboard.component'
-import { DocumentAsnComponent } from './components/document-asn/document-asn.component'
 import { DocumentDetailComponent } from './components/document-detail/document-detail.component'
 import { DocumentListComponent } from './components/document-list/document-list.component'
 import { CorrespondentListComponent } from './components/manage/correspondent-list/correspondent-list.component'
-import { CustomFieldsComponent } from './components/manage/custom-fields/custom-fields.component'
 import { DocumentTypeListComponent } from './components/manage/document-type-list/document-type-list.component'
-import { MailComponent } from './components/manage/mail/mail.component'
-import { SavedViewsComponent } from './components/manage/saved-views/saved-views.component'
-import { StoragePathListComponent } from './components/manage/storage-path-list/storage-path-list.component'
+import { LogsComponent } from './components/admin/logs/logs.component'
+import { SettingsComponent } from './components/admin/settings/settings.component'
 import { TagListComponent } from './components/manage/tag-list/tag-list.component'
-import { WorkflowsComponent } from './components/manage/workflows/workflows.component'
 import { NotFoundComponent } from './components/not-found/not-found.component'
-import { DirtyDocGuard } from './guards/dirty-doc.guard'
+import { DocumentAsnComponent } from './components/document-asn/document-asn.component'
 import { DirtyFormGuard } from './guards/dirty-form.guard'
-import { DirtySavedViewGuard } from './guards/dirty-saved-view.guard'
+import { StoragePathListComponent } from './components/manage/storage-path-list/storage-path-list.component'
+import { TasksComponent } from './components/admin/tasks/tasks.component'
 import { PermissionsGuard } from './guards/permissions.guard'
+import { DirtyDocGuard } from './guards/dirty-doc.guard'
+import { DirtySavedViewGuard } from './guards/dirty-saved-view.guard'
 import {
   PermissionAction,
   PermissionType,
 } from './services/permissions.service'
+import { WorkflowsComponent } from './components/manage/workflows/workflows.component'
+import { MailComponent } from './components/manage/mail/mail.component'
+import { UsersAndGroupsComponent } from './components/admin/users-groups/users-groups.component'
+import { CustomFieldsComponent } from './components/manage/custom-fields/custom-fields.component'
+import { ConfigComponent } from './components/admin/config/config.component'
 
 export const routes: Routes = [
   { path: '', redirectTo: 'dashboard', pathMatch: 'full' },
@@ -146,17 +144,6 @@ export const routes: Routes = [
           requireAdmin: true,
         },
       },
-      {
-        path: 'trash',
-        component: TrashComponent,
-        canActivate: [PermissionsGuard],
-        data: {
-          requiredPermission: {
-            action: PermissionAction.Delete,
-            type: PermissionType.Document,
-          },
-        },
-      },
       // redirect old paths
       {
         path: 'settings/mail',
@@ -166,10 +153,6 @@ export const routes: Routes = [
         path: 'settings/usersgroups',
         redirectTo: '/usersgroups',
       },
-      {
-        path: 'settings/savedviews',
-        redirectTo: '/savedviews',
-      },
       {
         path: 'settings',
         component: SettingsComponent,
@@ -260,17 +243,6 @@ export const routes: Routes = [
           },
         },
       },
-      {
-        path: 'savedviews',
-        component: SavedViewsComponent,
-        canActivate: [PermissionsGuard],
-        data: {
-          requiredPermission: {
-            action: PermissionAction.View,
-            type: PermissionType.SavedView,
-          },
-        },
-      },
     ],
   },
 

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

@@ -1,31 +1,26 @@
-import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
-import { provideHttpClientTesting } from '@angular/common/http/testing'
+import { HttpClientTestingModule } from '@angular/common/http/testing'
 import {
   ComponentFixture,
-  fakeAsync,
   TestBed,
+  fakeAsync,
   tick,
 } from '@angular/core/testing'
-import { Router, RouterModule } from '@angular/router'
-import { NgbModalModule } from '@ng-bootstrap/ng-bootstrap'
-import { allIcons, NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
-import { NgxFileDropModule } from 'ngx-file-drop'
-import { TourNgBootstrapModule, TourService } from 'ngx-ui-tour-ng-bootstrap'
+import { Router } from '@angular/router'
+import { RouterTestingModule } from '@angular/router/testing'
+import { TourService, TourNgBootstrapModule } from 'ngx-ui-tour-ng-bootstrap'
 import { Subject } from 'rxjs'
 import { routes } from './app-routing.module'
 import { AppComponent } from './app.component'
 import { ToastsComponent } from './components/common/toasts/toasts.component'
-import { FileDropComponent } from './components/file-drop/file-drop.component'
-import { DirtySavedViewGuard } from './guards/dirty-saved-view.guard'
-import { PermissionsGuard } from './guards/permissions.guard'
 import {
   ConsumerStatusService,
   FileStatus,
 } from './services/consumer-status.service'
-import { HotKeyService } from './services/hot-key.service'
 import { PermissionsService } from './services/permissions.service'
+import { ToastService, Toast } from './services/toast.service'
 import { SettingsService } from './services/settings.service'
-import { Toast, ToastService } from './services/toast.service'
+import { FileDropComponent } from './components/file-drop/file-drop.component'
+import { NgxFileDropModule } from 'ngx-file-drop'
 
 describe('AppComponent', () => {
   let component: AppComponent
@@ -36,25 +31,16 @@ describe('AppComponent', () => {
   let toastService: ToastService
   let router: Router
   let settingsService: SettingsService
-  let hotKeyService: HotKeyService
 
   beforeEach(async () => {
     TestBed.configureTestingModule({
+      declarations: [AppComponent, ToastsComponent, FileDropComponent],
+      providers: [],
       imports: [
+        HttpClientTestingModule,
         TourNgBootstrapModule,
-        RouterModule.forRoot(routes),
+        RouterTestingModule.withRoutes(routes),
         NgxFileDropModule,
-        NgbModalModule,
-        AppComponent,
-        ToastsComponent,
-        FileDropComponent,
-        NgxBootstrapIconsModule.pick(allIcons),
-      ],
-      providers: [
-        PermissionsGuard,
-        DirtySavedViewGuard,
-        provideHttpClient(withInterceptorsFromDi()),
-        provideHttpClientTesting(),
       ],
     }).compileComponents()
 
@@ -64,7 +50,6 @@ describe('AppComponent', () => {
     settingsService = TestBed.inject(SettingsService)
     toastService = TestBed.inject(ToastService)
     router = TestBed.inject(Router)
-    hotKeyService = TestBed.inject(HotKeyService)
     fixture = TestBed.createComponent(AppComponent)
     component = fixture.componentInstance
   })
@@ -154,20 +139,4 @@ describe('AppComponent', () => {
     fileStatusSubject.next(new FileStatus())
     expect(toastSpy).toHaveBeenCalled()
   })
-
-  it('should support hotkeys', () => {
-    const addShortcutSpy = jest.spyOn(hotKeyService, 'addShortcut')
-    const routerSpy = jest.spyOn(router, 'navigate')
-    // prevent actual navigation
-    routerSpy.mockReturnValue(new Promise(() => {}))
-    jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
-    component.ngOnInit()
-    expect(addShortcutSpy).toHaveBeenCalled()
-    document.dispatchEvent(new KeyboardEvent('keydown', { key: 'h' }))
-    expect(routerSpy).toHaveBeenCalledWith(['/dashboard'])
-    document.dispatchEvent(new KeyboardEvent('keydown', { key: 'd' }))
-    expect(routerSpy).toHaveBeenCalledWith(['/documents'])
-    document.dispatchEvent(new KeyboardEvent('keydown', { key: 's' }))
-    expect(routerSpy).toHaveBeenCalledWith(['/settings'])
-  })
 })

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

@@ -1,31 +1,22 @@
-import { Component, OnDestroy, OnInit, Renderer2 } from '@angular/core'
-import { Router, RouterOutlet } from '@angular/router'
-import { TourNgBootstrapModule, TourService } from 'ngx-ui-tour-ng-bootstrap'
-import { first, Subscription } from 'rxjs'
-import { ToastsComponent } from './components/common/toasts/toasts.component'
-import { FileDropComponent } from './components/file-drop/file-drop.component'
+import { SettingsService } from './services/settings.service'
 import { SETTINGS_KEYS } from './data/ui-settings'
+import { Component, OnDestroy, OnInit, Renderer2 } from '@angular/core'
+import { Router } from '@angular/router'
+import { Subscription, first } from 'rxjs'
 import { ConsumerStatusService } from './services/consumer-status.service'
-import { HotKeyService } from './services/hot-key.service'
+import { ToastService } from './services/toast.service'
+import { TasksService } from './services/tasks.service'
+import { TourService } from 'ngx-ui-tour-ng-bootstrap'
 import {
   PermissionAction,
   PermissionsService,
   PermissionType,
 } from './services/permissions.service'
-import { SettingsService } from './services/settings.service'
-import { TasksService } from './services/tasks.service'
-import { ToastService } from './services/toast.service'
 
 @Component({
   selector: 'pngx-root',
   templateUrl: './app.component.html',
   styleUrls: ['./app.component.scss'],
-  imports: [
-    FileDropComponent,
-    ToastsComponent,
-    TourNgBootstrapModule,
-    RouterOutlet,
-  ],
 })
 export class AppComponent implements OnInit, OnDestroy {
   newDocumentSubscription: Subscription
@@ -40,11 +31,8 @@ export class AppComponent implements OnInit, OnDestroy {
     private tasksService: TasksService,
     public tourService: TourService,
     private renderer: Renderer2,
-    private permissionsService: PermissionsService,
-    private hotKeyService: HotKeyService
+    private permissionsService: PermissionsService
   ) {
-    let anyWindow = window as any
-    anyWindow.pdfWorkerSrc = 'assets/js/pdf.worker.min.mjs'
     this.settings.updateAppearanceSettings()
   }
 
@@ -135,36 +123,6 @@ export class AppComponent implements OnInit, OnDestroy {
         }
       })
 
-    this.hotKeyService
-      .addShortcut({ keys: 'h', description: $localize`Dashboard` })
-      .subscribe(() => {
-        this.router.navigate(['/dashboard'])
-      })
-    if (
-      this.permissionsService.currentUserCan(
-        PermissionAction.View,
-        PermissionType.Document
-      )
-    ) {
-      this.hotKeyService
-        .addShortcut({ keys: 'd', description: $localize`Documents` })
-        .subscribe(() => {
-          this.router.navigate(['/documents'])
-        })
-    }
-    if (
-      this.permissionsService.currentUserCan(
-        PermissionAction.Change,
-        PermissionType.UISettings
-      )
-    ) {
-      this.hotKeyService
-        .addShortcut({ keys: 's', description: $localize`Settings` })
-        .subscribe(() => {
-          this.router.navigate(['/settings'])
-        })
-    }
-
     const prevBtnTitle = $localize`Prev`
     const nextBtnTitle = $localize`Next`
     const endBtnTitle = $localize`End`
@@ -173,7 +131,7 @@ export class AppComponent implements OnInit, OnDestroy {
       [
         {
           anchorId: 'tour.dashboard',
-          content: $localize`The dashboard can be used to show saved views, such as an 'Inbox'. Views are found under Manage > Saved Views once you have created some.`,
+          content: $localize`The dashboard can be used to show saved views, such as an 'Inbox'. Those settings are found under Settings > Saved Views once you have created some.`,
           route: '/dashboard',
           delayAfterNavigation: 500,
           isOptional: false,
@@ -235,7 +193,7 @@ export class AppComponent implements OnInit, OnDestroy {
         },
         {
           anchorId: 'tour.settings',
-          content: $localize`Check out the settings for various tweaks to the web app.`,
+          content: $localize`Check out the settings for various tweaks to the web app and toggle settings for saved views.`,
           route: '/settings',
           backdropConfig: {
             offset: 0,

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

@@ -0,0 +1,531 @@
+import { BrowserModule } from '@angular/platform-browser'
+import { APP_INITIALIZER, NgModule } from '@angular/core'
+import { AppRoutingModule } from './app-routing.module'
+import { AppComponent } from './app.component'
+import {
+  NgbDateAdapter,
+  NgbDateParserFormatter,
+  NgbModule,
+} from '@ng-bootstrap/ng-bootstrap'
+import { HttpClientModule, HTTP_INTERCEPTORS } from '@angular/common/http'
+import { DocumentListComponent } from './components/document-list/document-list.component'
+import { DocumentDetailComponent } from './components/document-detail/document-detail.component'
+import { DashboardComponent } from './components/dashboard/dashboard.component'
+import { TagListComponent } from './components/manage/tag-list/tag-list.component'
+import { DocumentTypeListComponent } from './components/manage/document-type-list/document-type-list.component'
+import { CorrespondentListComponent } from './components/manage/correspondent-list/correspondent-list.component'
+import { LogsComponent } from './components/admin/logs/logs.component'
+import { SettingsComponent } from './components/admin/settings/settings.component'
+import { FormsModule, ReactiveFormsModule } from '@angular/forms'
+import { DatePipe, registerLocaleData } from '@angular/common'
+import { NotFoundComponent } from './components/not-found/not-found.component'
+import { ConfirmDialogComponent } from './components/common/confirm-dialog/confirm-dialog.component'
+import { CorrespondentEditDialogComponent } from './components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component'
+import { TagEditDialogComponent } from './components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component'
+import { DocumentTypeEditDialogComponent } from './components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component'
+import { TagComponent } from './components/common/tag/tag.component'
+import { ClearableBadgeComponent } from './components/common/clearable-badge/clearable-badge.component'
+import { PageHeaderComponent } from './components/common/page-header/page-header.component'
+import { AppFrameComponent } from './components/app-frame/app-frame.component'
+import { ToastsComponent } from './components/common/toasts/toasts.component'
+import { FilterEditorComponent } from './components/document-list/filter-editor/filter-editor.component'
+import { FilterableDropdownComponent } from './components/common/filterable-dropdown/filterable-dropdown.component'
+import { ToggleableDropdownButtonComponent } from './components/common/filterable-dropdown/toggleable-dropdown-button/toggleable-dropdown-button.component'
+import { DatesDropdownComponent } from './components/common/dates-dropdown/dates-dropdown.component'
+import { DocumentCardLargeComponent } from './components/document-list/document-card-large/document-card-large.component'
+import { DocumentCardSmallComponent } from './components/document-list/document-card-small/document-card-small.component'
+import { BulkEditorComponent } from './components/document-list/bulk-editor/bulk-editor.component'
+import { NgxFileDropModule } from 'ngx-file-drop'
+import { TextComponent } from './components/common/input/text/text.component'
+import { SelectComponent } from './components/common/input/select/select.component'
+import { CheckComponent } from './components/common/input/check/check.component'
+import { UrlComponent } from './components/common/input/url/url.component'
+import { PasswordComponent } from './components/common/input/password/password.component'
+import { SaveViewConfigDialogComponent } from './components/document-list/save-view-config-dialog/save-view-config-dialog.component'
+import { TagsComponent } from './components/common/input/tags/tags.component'
+import { IfPermissionsDirective } from './directives/if-permissions.directive'
+import { SortableDirective } from './directives/sortable.directive'
+import { CookieService } from 'ngx-cookie-service'
+import { CsrfInterceptor } from './interceptors/csrf.interceptor'
+import { SavedViewWidgetComponent } from './components/dashboard/widgets/saved-view-widget/saved-view-widget.component'
+import { StatisticsWidgetComponent } from './components/dashboard/widgets/statistics-widget/statistics-widget.component'
+import { UploadFileWidgetComponent } from './components/dashboard/widgets/upload-file-widget/upload-file-widget.component'
+import { WidgetFrameComponent } from './components/dashboard/widgets/widget-frame/widget-frame.component'
+import { WelcomeWidgetComponent } from './components/dashboard/widgets/welcome-widget/welcome-widget.component'
+import { YesNoPipe } from './pipes/yes-no.pipe'
+import { FileSizePipe } from './pipes/file-size.pipe'
+import { FilterPipe } from './pipes/filter.pipe'
+import { DocumentTitlePipe } from './pipes/document-title.pipe'
+import { MetadataCollapseComponent } from './components/document-detail/metadata-collapse/metadata-collapse.component'
+import { SelectDialogComponent } from './components/common/select-dialog/select-dialog.component'
+import { NgSelectModule } from '@ng-select/ng-select'
+import { NumberComponent } from './components/common/input/number/number.component'
+import { SafeUrlPipe } from './pipes/safeurl.pipe'
+import { SafeHtmlPipe } from './pipes/safehtml.pipe'
+import { CustomDatePipe } from './pipes/custom-date.pipe'
+import { DateComponent } from './components/common/input/date/date.component'
+import { ISODateAdapter } from './utils/ngb-iso-date-adapter'
+import { LocalizedDateParserFormatter } from './utils/ngb-date-parser-formatter'
+import { ApiVersionInterceptor } from './interceptors/api-version.interceptor'
+import { ColorSliderModule } from 'ngx-color/slider'
+import { ColorComponent } from './components/common/input/color/color.component'
+import { DocumentAsnComponent } from './components/document-asn/document-asn.component'
+import { DocumentNotesComponent } from './components/document-notes/document-notes.component'
+import { PermissionsGuard } from './guards/permissions.guard'
+import { DirtyDocGuard } from './guards/dirty-doc.guard'
+import { DirtySavedViewGuard } from './guards/dirty-saved-view.guard'
+import { StoragePathListComponent } from './components/manage/storage-path-list/storage-path-list.component'
+import { StoragePathEditDialogComponent } from './components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component'
+import { SettingsService } from './services/settings.service'
+import { TasksComponent } from './components/admin/tasks/tasks.component'
+import { TourNgBootstrapModule } from 'ngx-ui-tour-ng-bootstrap'
+import { UserEditDialogComponent } from './components/common/edit-dialog/user-edit-dialog/user-edit-dialog.component'
+import { GroupEditDialogComponent } from './components/common/edit-dialog/group-edit-dialog/group-edit-dialog.component'
+import { PermissionsSelectComponent } from './components/common/permissions-select/permissions-select.component'
+import { MailAccountEditDialogComponent } from './components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component'
+import { MailRuleEditDialogComponent } from './components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component'
+import { PermissionsUserComponent } from './components/common/input/permissions/permissions-user/permissions-user.component'
+import { PermissionsGroupComponent } from './components/common/input/permissions/permissions-group/permissions-group.component'
+import { IfOwnerDirective } from './directives/if-owner.directive'
+import { IfObjectPermissionsDirective } from './directives/if-object-permissions.directive'
+import { PermissionsDialogComponent } from './components/common/permissions-dialog/permissions-dialog.component'
+import { PermissionsFormComponent } from './components/common/input/permissions/permissions-form/permissions-form.component'
+import { PermissionsFilterDropdownComponent } from './components/common/permissions-filter-dropdown/permissions-filter-dropdown.component'
+import { UsernamePipe } from './pipes/username.pipe'
+import { LogoComponent } from './components/common/logo/logo.component'
+import { IsNumberPipe } from './pipes/is-number.pipe'
+import { ShareLinksDropdownComponent } from './components/common/share-links-dropdown/share-links-dropdown.component'
+import { WorkflowsComponent } from './components/manage/workflows/workflows.component'
+import { WorkflowEditDialogComponent } from './components/common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component'
+import { MailComponent } from './components/manage/mail/mail.component'
+import { UsersAndGroupsComponent } from './components/admin/users-groups/users-groups.component'
+import { DragDropModule } from '@angular/cdk/drag-drop'
+import { FileDropComponent } from './components/file-drop/file-drop.component'
+import { CustomFieldsComponent } from './components/manage/custom-fields/custom-fields.component'
+import { CustomFieldEditDialogComponent } from './components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component'
+import { CustomFieldsDropdownComponent } from './components/common/custom-fields-dropdown/custom-fields-dropdown.component'
+import { ProfileEditDialogComponent } from './components/common/profile-edit-dialog/profile-edit-dialog.component'
+import { PdfViewerComponent } from './components/common/pdf-viewer/pdf-viewer.component'
+import { DocumentLinkComponent } from './components/common/input/document-link/document-link.component'
+import { PreviewPopupComponent } from './components/common/preview-popup/preview-popup.component'
+import { SwitchComponent } from './components/common/input/switch/switch.component'
+import { ConfigComponent } from './components/admin/config/config.component'
+import { FileComponent } from './components/common/input/file/file.component'
+import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
+import { ConfirmButtonComponent } from './components/common/confirm-button/confirm-button.component'
+import { MonetaryComponent } from './components/common/input/monetary/monetary.component'
+import { SystemStatusDialogComponent } from './components/common/system-status-dialog/system-status-dialog.component'
+import { NgxFilesizeModule } from 'ngx-filesize'
+import { RotateConfirmDialogComponent } from './components/common/confirm-dialog/rotate-confirm-dialog/rotate-confirm-dialog.component'
+import { MergeConfirmDialogComponent } from './components/common/confirm-dialog/merge-confirm-dialog/merge-confirm-dialog.component'
+import { SplitConfirmDialogComponent } from './components/common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component'
+import { DocumentHistoryComponent } from './components/document-history/document-history.component'
+import { DragDropSelectComponent } from './components/common/input/drag-drop-select/drag-drop-select.component'
+import { CustomFieldDisplayComponent } from './components/common/custom-field-display/custom-field-display.component'
+import {
+  airplane,
+  archive,
+  arrowClockwise,
+  arrowCounterclockwise,
+  arrowDown,
+  arrowLeft,
+  arrowRepeat,
+  arrowRight,
+  arrowRightShort,
+  arrowUpRight,
+  asterisk,
+  bodyText,
+  boxArrowUp,
+  boxArrowUpRight,
+  boxes,
+  calendar,
+  calendarEvent,
+  calendarEventFill,
+  cardChecklist,
+  cardHeading,
+  caretDown,
+  caretUp,
+  chatLeftText,
+  check,
+  check2All,
+  checkAll,
+  checkCircleFill,
+  checkLg,
+  chevronDoubleLeft,
+  chevronDoubleRight,
+  clipboard,
+  clipboardCheck,
+  clipboardCheckFill,
+  clipboardFill,
+  dash,
+  diagram3,
+  dice5,
+  doorOpen,
+  download,
+  envelope,
+  exclamationCircleFill,
+  exclamationTriangle,
+  exclamationTriangleFill,
+  eye,
+  fileEarmark,
+  fileEarmarkCheck,
+  fileEarmarkFill,
+  fileEarmarkLock,
+  files,
+  fileText,
+  filter,
+  folder,
+  folderFill,
+  funnel,
+  gear,
+  grid,
+  gripVertical,
+  hash,
+  hddStack,
+  house,
+  infoCircle,
+  journals,
+  link,
+  listTask,
+  listUl,
+  pencil,
+  people,
+  peopleFill,
+  person,
+  personCircle,
+  personFill,
+  personFillLock,
+  personLock,
+  plus,
+  plusCircle,
+  questionCircle,
+  scissors,
+  search,
+  slashCircle,
+  sliders2Vertical,
+  sortAlphaDown,
+  sortAlphaUpAlt,
+  tagFill,
+  tags,
+  textIndentLeft,
+  textLeft,
+  threeDots,
+  threeDotsVertical,
+  trash,
+  uiRadios,
+  upcScan,
+  x,
+  xLg,
+} from 'ngx-bootstrap-icons'
+
+const icons = {
+  airplane,
+  archive,
+  arrowClockwise,
+  arrowCounterclockwise,
+  arrowDown,
+  arrowLeft,
+  arrowRepeat,
+  arrowRight,
+  arrowRightShort,
+  arrowUpRight,
+  asterisk,
+  bodyText,
+  boxArrowUp,
+  boxArrowUpRight,
+  boxes,
+  calendar,
+  calendarEvent,
+  calendarEventFill,
+  cardChecklist,
+  cardHeading,
+  caretDown,
+  caretUp,
+  chatLeftText,
+  check,
+  check2All,
+  checkAll,
+  checkCircleFill,
+  checkLg,
+  chevronDoubleLeft,
+  chevronDoubleRight,
+  clipboard,
+  clipboardCheck,
+  clipboardCheckFill,
+  clipboardFill,
+  dash,
+  diagram3,
+  dice5,
+  doorOpen,
+  download,
+  envelope,
+  exclamationCircleFill,
+  exclamationTriangle,
+  exclamationTriangleFill,
+  eye,
+  fileEarmark,
+  fileEarmarkCheck,
+  fileEarmarkFill,
+  fileEarmarkLock,
+  files,
+  fileText,
+  filter,
+  folder,
+  folderFill,
+  funnel,
+  gear,
+  grid,
+  gripVertical,
+  hash,
+  hddStack,
+  house,
+  infoCircle,
+  journals,
+  link,
+  listTask,
+  listUl,
+  pencil,
+  people,
+  peopleFill,
+  person,
+  personCircle,
+  personFill,
+  personFillLock,
+  personLock,
+  plus,
+  plusCircle,
+  questionCircle,
+  scissors,
+  search,
+  slashCircle,
+  sliders2Vertical,
+  sortAlphaDown,
+  sortAlphaUpAlt,
+  tagFill,
+  tags,
+  textIndentLeft,
+  textLeft,
+  threeDots,
+  threeDotsVertical,
+  trash,
+  uiRadios,
+  upcScan,
+  x,
+  xLg,
+}
+
+import localeAf from '@angular/common/locales/af'
+import localeAr from '@angular/common/locales/ar'
+import localeBe from '@angular/common/locales/be'
+import localeBg from '@angular/common/locales/bg'
+import localeCa from '@angular/common/locales/ca'
+import localeCs from '@angular/common/locales/cs'
+import localeDa from '@angular/common/locales/da'
+import localeDe from '@angular/common/locales/de'
+import localeEl from '@angular/common/locales/el'
+import localeEnGb from '@angular/common/locales/en-GB'
+import localeEs from '@angular/common/locales/es'
+import localeFi from '@angular/common/locales/fi'
+import localeFr from '@angular/common/locales/fr'
+import localeHu from '@angular/common/locales/hu'
+import localeIt from '@angular/common/locales/it'
+import localeJa from '@angular/common/locales/ja'
+import localeLb from '@angular/common/locales/lb'
+import localeNl from '@angular/common/locales/nl'
+import localeNo from '@angular/common/locales/no'
+import localePl from '@angular/common/locales/pl'
+import localePt from '@angular/common/locales/pt'
+import localeRo from '@angular/common/locales/ro'
+import localeRu from '@angular/common/locales/ru'
+import localeSk from '@angular/common/locales/sk'
+import localeSl from '@angular/common/locales/sl'
+import localeSr from '@angular/common/locales/sr'
+import localeSv from '@angular/common/locales/sv'
+import localeTr from '@angular/common/locales/tr'
+import localeUk from '@angular/common/locales/uk'
+import localeZh from '@angular/common/locales/zh'
+
+registerLocaleData(localeAf)
+registerLocaleData(localeAr)
+registerLocaleData(localeBe)
+registerLocaleData(localeBg)
+registerLocaleData(localeCa)
+registerLocaleData(localeCs)
+registerLocaleData(localeDa)
+registerLocaleData(localeDe)
+registerLocaleData(localeEl)
+registerLocaleData(localeEnGb)
+registerLocaleData(localeEs)
+registerLocaleData(localeFi)
+registerLocaleData(localeFr)
+registerLocaleData(localeHu)
+registerLocaleData(localeIt)
+registerLocaleData(localeJa)
+registerLocaleData(localeLb)
+registerLocaleData(localeNl)
+registerLocaleData(localeNo)
+registerLocaleData(localePl)
+registerLocaleData(localePt, 'pt-BR')
+registerLocaleData(localePt, 'pt-PT')
+registerLocaleData(localeRo)
+registerLocaleData(localeRu)
+registerLocaleData(localeSk)
+registerLocaleData(localeSl)
+registerLocaleData(localeSr)
+registerLocaleData(localeSv)
+registerLocaleData(localeTr)
+registerLocaleData(localeUk)
+registerLocaleData(localeZh)
+
+function initializeApp(settings: SettingsService) {
+  return () => {
+    return settings.initializeSettings()
+  }
+}
+
+@NgModule({
+  declarations: [
+    AppComponent,
+    DocumentListComponent,
+    DocumentDetailComponent,
+    DashboardComponent,
+    TagListComponent,
+    DocumentTypeListComponent,
+    CorrespondentListComponent,
+    StoragePathListComponent,
+    LogsComponent,
+    SettingsComponent,
+    NotFoundComponent,
+    CorrespondentEditDialogComponent,
+    ConfirmDialogComponent,
+    TagEditDialogComponent,
+    DocumentTypeEditDialogComponent,
+    StoragePathEditDialogComponent,
+    TagComponent,
+    ClearableBadgeComponent,
+    PageHeaderComponent,
+    AppFrameComponent,
+    ToastsComponent,
+    FilterEditorComponent,
+    FilterableDropdownComponent,
+    ToggleableDropdownButtonComponent,
+    DatesDropdownComponent,
+    DocumentCardLargeComponent,
+    DocumentCardSmallComponent,
+    BulkEditorComponent,
+    TextComponent,
+    SelectComponent,
+    CheckComponent,
+    UrlComponent,
+    PasswordComponent,
+    SaveViewConfigDialogComponent,
+    TagsComponent,
+    IfPermissionsDirective,
+    SortableDirective,
+    SavedViewWidgetComponent,
+    StatisticsWidgetComponent,
+    UploadFileWidgetComponent,
+    WidgetFrameComponent,
+    WelcomeWidgetComponent,
+    YesNoPipe,
+    FileSizePipe,
+    FilterPipe,
+    DocumentTitlePipe,
+    MetadataCollapseComponent,
+    SelectDialogComponent,
+    NumberComponent,
+    SafeUrlPipe,
+    SafeHtmlPipe,
+    CustomDatePipe,
+    DateComponent,
+    ColorComponent,
+    DocumentAsnComponent,
+    DocumentNotesComponent,
+    TasksComponent,
+    UserEditDialogComponent,
+    GroupEditDialogComponent,
+    PermissionsSelectComponent,
+    MailAccountEditDialogComponent,
+    MailRuleEditDialogComponent,
+    PermissionsUserComponent,
+    PermissionsGroupComponent,
+    IfOwnerDirective,
+    IfObjectPermissionsDirective,
+    PermissionsDialogComponent,
+    PermissionsFormComponent,
+    PermissionsFilterDropdownComponent,
+    UsernamePipe,
+    LogoComponent,
+    IsNumberPipe,
+    ShareLinksDropdownComponent,
+    WorkflowsComponent,
+    WorkflowEditDialogComponent,
+    MailComponent,
+    UsersAndGroupsComponent,
+    FileDropComponent,
+    CustomFieldsComponent,
+    CustomFieldEditDialogComponent,
+    CustomFieldsDropdownComponent,
+    ProfileEditDialogComponent,
+    PdfViewerComponent,
+    DocumentLinkComponent,
+    PreviewPopupComponent,
+    SwitchComponent,
+    ConfigComponent,
+    FileComponent,
+    ConfirmButtonComponent,
+    MonetaryComponent,
+    SystemStatusDialogComponent,
+    RotateConfirmDialogComponent,
+    MergeConfirmDialogComponent,
+    SplitConfirmDialogComponent,
+    DocumentHistoryComponent,
+    DragDropSelectComponent,
+    CustomFieldDisplayComponent,
+  ],
+  imports: [
+    BrowserModule,
+    AppRoutingModule,
+    NgbModule,
+    HttpClientModule,
+    FormsModule,
+    ReactiveFormsModule,
+    NgxFileDropModule,
+    NgSelectModule,
+    ColorSliderModule,
+    TourNgBootstrapModule,
+    DragDropModule,
+    NgxBootstrapIconsModule.pick(icons),
+    NgxFilesizeModule,
+  ],
+  providers: [
+    {
+      provide: APP_INITIALIZER,
+      useFactory: initializeApp,
+      deps: [SettingsService],
+      multi: true,
+    },
+    DatePipe,
+    CookieService,
+    {
+      provide: HTTP_INTERCEPTORS,
+      useClass: CsrfInterceptor,
+      multi: true,
+    },
+    {
+      provide: HTTP_INTERCEPTORS,
+      useClass: ApiVersionInterceptor,
+      multi: true,
+    },
+    FilterPipe,
+    DocumentTitlePipe,
+    { provide: NgbDateAdapter, useClass: ISODateAdapter },
+    { provide: NgbDateParserFormatter, useClass: LocalizedDateParserFormatter },
+    PermissionsGuard,
+    DirtyDocGuard,
+    DirtySavedViewGuard,
+    UsernamePipe,
+  ],
+  bootstrap: [AppComponent],
+})
+export class AppModule {}

src-ui/src/app/components/admin/config/config.component.html

@@ -11,7 +11,7 @@
     <ul ngbNav #nav="ngbNav" class="nav-tabs">
         @for (category of optionCategories; track category) {
             <li [ngbNavItem]="category">
-                <a ngbNavLink>{{category}}</a>
+                <a ngbNavLink i18n>{{category}}</a>
                 <ng-template ngbNavContent>
                     <div class="p-3">
                         <div class="row row-cols-1 row-cols-md-2 row-cols-lg-3 g-2">

src-ui/src/app/components/admin/config/config.component.spec.ts

@@ -1,24 +1,23 @@
 import { ComponentFixture, TestBed } from '@angular/core/testing'
 
-import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
-import { provideHttpClientTesting } from '@angular/common/http/testing'
-import { FormsModule, ReactiveFormsModule } from '@angular/forms'
+import { ConfigComponent } from './config.component'
+import { ConfigService } from 'src/app/services/config.service'
+import { ToastService } from 'src/app/services/toast.service'
+import { of, throwError } from 'rxjs'
+import { OutputTypeConfig } from 'src/app/data/paperless-config'
+import { HttpClientTestingModule } from '@angular/common/http/testing'
 import { BrowserModule } from '@angular/platform-browser'
 import { NgbModule } from '@ng-bootstrap/ng-bootstrap'
 import { NgSelectModule } from '@ng-select/ng-select'
-import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
-import { of, throwError } from 'rxjs'
-import { OutputTypeConfig } from 'src/app/data/paperless-config'
-import { ConfigService } from 'src/app/services/config.service'
-import { SettingsService } from 'src/app/services/settings.service'
-import { ToastService } from 'src/app/services/toast.service'
-import { FileComponent } from '../../common/input/file/file.component'
-import { NumberComponent } from '../../common/input/number/number.component'
-import { SelectComponent } from '../../common/input/select/select.component'
-import { SwitchComponent } from '../../common/input/switch/switch.component'
 import { TextComponent } from '../../common/input/text/text.component'
+import { NumberComponent } from '../../common/input/number/number.component'
+import { SwitchComponent } from '../../common/input/switch/switch.component'
+import { FormsModule, ReactiveFormsModule } from '@angular/forms'
 import { PageHeaderComponent } from '../../common/page-header/page-header.component'
-import { ConfigComponent } from './config.component'
+import { SelectComponent } from '../../common/input/select/select.component'
+import { FileComponent } from '../../common/input/file/file.component'
+import { SettingsService } from 'src/app/services/settings.service'
+import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
 
 describe('ConfigComponent', () => {
   let component: ConfigComponent
@@ -29,13 +28,7 @@ describe('ConfigComponent', () => {
 
   beforeEach(async () => {
     await TestBed.configureTestingModule({
-      imports: [
-        BrowserModule,
-        NgbModule,
-        NgSelectModule,
-        FormsModule,
-        ReactiveFormsModule,
-        NgxBootstrapIconsModule.pick(allIcons),
+      declarations: [
         ConfigComponent,
         TextComponent,
         SelectComponent,
@@ -44,9 +37,14 @@ describe('ConfigComponent', () => {
         FileComponent,
         PageHeaderComponent,
       ],
-      providers: [
-        provideHttpClient(withInterceptorsFromDi()),
-        provideHttpClientTesting(),
+      imports: [
+        HttpClientTestingModule,
+        BrowserModule,
+        NgbModule,
+        NgSelectModule,
+        FormsModule,
+        ReactiveFormsModule,
+        NgxBootstrapIconsModule.pick(allIcons),
       ],
     }).compileComponents()
 

src-ui/src/app/components/admin/config/config.component.ts

@@ -1,60 +1,33 @@
-import { AsyncPipe } from '@angular/common'
 import { Component, OnDestroy, OnInit } from '@angular/core'
-import {
-  AbstractControl,
-  FormControl,
-  FormGroup,
-  FormsModule,
-  ReactiveFormsModule,
-} from '@angular/forms'
-import { NgbNavModule } from '@ng-bootstrap/ng-bootstrap'
-import { DirtyComponent, dirtyCheck } from '@ngneat/dirty-check-forms'
-import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
+import { AbstractControl, FormControl, FormGroup } from '@angular/forms'
 import {
   BehaviorSubject,
   Observable,
+  Subject,
   Subscription,
   first,
   takeUntil,
 } from 'rxjs'
 import {
+  PaperlessConfigOptions,
   ConfigCategory,
   ConfigOption,
   ConfigOptionType,
   PaperlessConfig,
-  PaperlessConfigOptions,
 } from 'src/app/data/paperless-config'
 import { ConfigService } from 'src/app/services/config.service'
-import { SettingsService } from 'src/app/services/settings.service'
 import { ToastService } from 'src/app/services/toast.service'
-import { FileComponent } from '../../common/input/file/file.component'
-import { NumberComponent } from '../../common/input/number/number.component'
-import { SelectComponent } from '../../common/input/select/select.component'
-import { SwitchComponent } from '../../common/input/switch/switch.component'
-import { TextComponent } from '../../common/input/text/text.component'
-import { PageHeaderComponent } from '../../common/page-header/page-header.component'
-import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
+import { ComponentWithPermissions } from '../../with-permissions/with-permissions.component'
+import { DirtyComponent, dirtyCheck } from '@ngneat/dirty-check-forms'
+import { SettingsService } from 'src/app/services/settings.service'
 
 @Component({
   selector: 'pngx-config',
   templateUrl: './config.component.html',
   styleUrl: './config.component.scss',
-  imports: [
-    PageHeaderComponent,
-    SelectComponent,
-    SwitchComponent,
-    TextComponent,
-    NumberComponent,
-    FileComponent,
-    AsyncPipe,
-    NgbNavModule,
-    FormsModule,
-    ReactiveFormsModule,
-    NgxBootstrapIconsModule,
-  ],
 })
 export class ConfigComponent
-  extends LoadingComponentWithPermissions
+  extends ComponentWithPermissions
   implements OnInit, OnDestroy, DirtyComponent
 {
   public readonly ConfigOptionType = ConfigOptionType
@@ -72,11 +45,15 @@ export class ConfigComponent
     return PaperlessConfigOptions.filter((o) => o.category === category)
   }
 
+  public loading: boolean = false
+
   initialConfig: PaperlessConfig
   store: BehaviorSubject<any>
   storeSub: Subscription
   isDirty$: Observable<boolean>
 
+  private unsubscribeNotifier: Subject<any> = new Subject()
+
   constructor(
     private configService: ConfigService,
     private toastService: ToastService,
@@ -90,6 +67,7 @@ export class ConfigComponent
   }
 
   ngOnInit(): void {
+    this.loading = true
     this.configService
       .getConfig()
       .pipe(takeUntil(this.unsubscribeNotifier))

src-ui/src/app/components/admin/logs/logs.component.html

@@ -4,7 +4,7 @@
   info="Review the log files for the application and for email checking."
   i18n-info>
   <div class="form-check form-switch">
-    <input class="form-check-input" type="checkbox" role="switch" [(ngModel)]="autoRefreshEnabled">
+    <input class="form-check-input" type="checkbox" role="switch" id="autoRefreshSwitch" (click)="toggleAutoRefresh()" [attr.checked]="autoRefreshInterval">
     <label class="form-check-label" for="autoRefreshSwitch" i18n>Auto refresh</label>
   </div>
 </pngx-page-header>
@@ -17,7 +17,7 @@
       </a>
     </li>
   }
-  @if (loading || !logFiles.length) {
+  @if (isLoading || !logFiles.length) {
     <div class="ps-2 d-flex align-items-center">
       <div class="spinner-border spinner-border-sm me-2" role="status"></div>
       @if (!logFiles.length) {
@@ -30,13 +30,15 @@
 <div [ngbNavOutlet]="nav" class="mt-2"></div>
 
 <div class="bg-dark p-3 text-light font-monospace log-container" #logContainer>
-  @if (loading && logFiles.length) {
+  @if (isLoading && logFiles.length) {
     <div>
       <div class="spinner-border spinner-border-sm me-2" role="status"></div>
       <ng-container i18n>Loading...</ng-container>
     </div>
   }
-  @for (log of logs; track $index) {
-    <p class="m-0 p-0 log-entry-{{getLogLevel(log)}}">{{log}}</p>
+  @for (log of logs; track log) {
+    <p
+      class="m-0 p-0 log-entry-{{getLogLevel(log)}}"
+    >{{log}}</p>
   }
 </div>

src-ui/src/app/components/admin/logs/logs.component.spec.ts

@@ -1,13 +1,17 @@
-import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
-import { provideHttpClientTesting } from '@angular/common/http/testing'
-import { ComponentFixture, TestBed } from '@angular/core/testing'
-import { BrowserModule, By } from '@angular/platform-browser'
-import { NgbModule, NgbNavLink } from '@ng-bootstrap/ng-bootstrap'
-import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
-import { of, throwError } from 'rxjs'
+import {
+  ComponentFixture,
+  TestBed,
+  fakeAsync,
+  tick,
+} from '@angular/core/testing'
 import { LogService } from 'src/app/services/rest/log.service'
 import { PageHeaderComponent } from '../../common/page-header/page-header.component'
 import { LogsComponent } from './logs.component'
+import { of, throwError } from 'rxjs'
+import { HttpClientTestingModule } from '@angular/common/http/testing'
+import { NgbModule, NgbNavLink } from '@ng-bootstrap/ng-bootstrap'
+import { BrowserModule, By } from '@angular/platform-browser'
+import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
 
 const paperless_logs = [
   '[2023-05-29 03:05:01,224] [DEBUG] [paperless.tasks] Training data unchanged.',
@@ -32,16 +36,13 @@ describe('LogsComponent', () => {
 
   beforeEach(async () => {
     TestBed.configureTestingModule({
+      declarations: [LogsComponent, PageHeaderComponent],
+      providers: [],
       imports: [
+        HttpClientTestingModule,
         BrowserModule,
         NgbModule,
         NgxBootstrapIconsModule.pick(allIcons),
-        LogsComponent,
-        PageHeaderComponent,
-      ],
-      providers: [
-        provideHttpClient(withInterceptorsFromDi()),
-        provideHttpClientTesting(),
       ],
     }).compileComponents()
 
@@ -86,7 +87,8 @@ describe('LogsComponent', () => {
     jest.advanceTimersByTime(6000)
     expect(reloadSpy).toHaveBeenCalledTimes(2)
 
-    component.autoRefreshEnabled = false
+    component.toggleAutoRefresh()
+    expect(component.autoRefreshInterval).toBeNull()
     jest.advanceTimersByTime(6000)
     expect(reloadSpy).toHaveBeenCalledTimes(2)
   })

src-ui/src/app/components/admin/logs/logs.component.ts

@@ -1,39 +1,24 @@
 import {
-  ChangeDetectorRef,
   Component,
   ElementRef,
-  OnDestroy,
   OnInit,
   ViewChild,
+  OnDestroy,
+  ChangeDetectorRef,
 } from '@angular/core'
-import { FormsModule, ReactiveFormsModule } from '@angular/forms'
-import { NgbNavModule } from '@ng-bootstrap/ng-bootstrap'
-import { filter, takeUntil, timer } from 'rxjs'
+import { Subject, takeUntil } from 'rxjs'
 import { LogService } from 'src/app/services/rest/log.service'
-import { PageHeaderComponent } from '../../common/page-header/page-header.component'
-import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
 
 @Component({
   selector: 'pngx-logs',
   templateUrl: './logs.component.html',
   styleUrls: ['./logs.component.scss'],
-  imports: [
-    PageHeaderComponent,
-    NgbNavModule,
-    FormsModule,
-    ReactiveFormsModule,
-  ],
 })
-export class LogsComponent
-  extends LoadingComponentWithPermissions
-  implements OnInit, OnDestroy
-{
+export class LogsComponent implements OnInit, OnDestroy {
   constructor(
     private logService: LogService,
     private changedetectorRef: ChangeDetectorRef
-  ) {
-    super()
-  }
+  ) {}
 
   public logs: string[] = []
 
@@ -41,50 +26,50 @@ export class LogsComponent
 
   public activeLog: string
 
-  public autoRefreshEnabled: boolean = true
+  private unsubscribeNotifier: Subject<any> = new Subject()
+
+  public isLoading: boolean = false
+
+  public autoRefreshInterval: any
 
   @ViewChild('logContainer') logContainer: ElementRef
 
   ngOnInit(): void {
+    this.isLoading = true
     this.logService
       .list()
       .pipe(takeUntil(this.unsubscribeNotifier))
       .subscribe((result) => {
         this.logFiles = result
-        this.loading = false
+        this.isLoading = false
         if (this.logFiles.length > 0) {
           this.activeLog = this.logFiles[0]
           this.reloadLogs()
         }
-        timer(5000, 5000)
-          .pipe(
-            filter(() => this.autoRefreshEnabled),
-            takeUntil(this.unsubscribeNotifier)
-          )
-          .subscribe(() => {
-            this.reloadLogs()
-          })
+        this.toggleAutoRefresh()
       })
   }
 
   ngOnDestroy(): void {
-    super.ngOnDestroy()
+    this.unsubscribeNotifier.next(true)
+    this.unsubscribeNotifier.complete()
+    clearInterval(this.autoRefreshInterval)
   }
 
   reloadLogs() {
-    this.loading = true
+    this.isLoading = true
     this.logService
       .get(this.activeLog)
       .pipe(takeUntil(this.unsubscribeNotifier))
       .subscribe({
         next: (result) => {
           this.logs = result
-          this.loading = false
+          this.isLoading = false
           this.scrollToBottom()
         },
         error: () => {
           this.logs = []
-          this.loading = false
+          this.isLoading = false
         },
       })
   }
@@ -111,4 +96,15 @@ export class LogsComponent
       behavior: 'auto',
     })
   }
+
+  toggleAutoRefresh(): void {
+    if (this.autoRefreshInterval) {
+      clearInterval(this.autoRefreshInterval)
+      this.autoRefreshInterval = null
+    } else {
+      this.autoRefreshInterval = setInterval(() => {
+        this.reloadLogs()
+      }, 5000)
+    }
+  }
 }

src-ui/src/app/components/admin/settings/settings.component.html

@@ -1,7 +1,7 @@
 <pngx-page-header
   title="Settings"
   i18n-title
-  info="Options to customize appearance, notifications and more. Settings apply to the <strong>current user only</strong>."
+  info="Options to customize appearance, notifications, saved views and more. Settings apply to the <strong>current user only</strong>."
   i18n-info
   >
   <button class="btn btn-sm btn-outline-primary" (click)="tourService.start()">
@@ -39,204 +39,169 @@
     <li [ngbNavItem]="SettingsNavIDs.General">
       <a ngbNavLink i18n>General</a>
       <ng-template ngbNavContent>
-        <div class="row">
-          <div class="col-xl-6 pe-xl-5">
-            <h4 i18n>Appearance</h4>
-            <div class="row mb-3">
-              <div class="col-md-3 col-form-label pt-0">
-                <span i18n>Display language</span>
-              </div>
-              <div class="col">
 
-                <select class="form-select" formControlName="displayLanguage">
-                  @for (lang of displayLanguageOptions; track lang) {
-                    <option [ngValue]="lang.code">{{lang.name}}@if (lang.code && currentLocale !== 'en-US') {
-                      <span> - {{lang.englishName}}</span>
-                    }</option>
-                  }
-                </select>
+        <h4 i18n>Appearance</h4>
 
-                @if (displayLanguageIsDirty) {
-                  <small class="form-text text-primary" i18n>You need to reload the page after applying a new language.</small>
-                }
-
-              </div>
-            </div>
-
-            <div class="row mb-3">
-              <div class="col-md-3 col-form-label pt-0">
-                <span i18n>Date display</span>
-              </div>
-              <div class="col">
-
-                <select class="form-select" formControlName="dateLocale">
-                  @for (lang of dateLocaleOptions; track lang) {
-                    <option [ngValue]="lang.code">{{lang.name}}@if (lang.code) {
-                      <span> - {{today | customDate:'shortDate':null:lang.code}}</span>
-                    }</option>
-                  }
-                </select>
-
-              </div>
-            </div>
-
-            <div class="row mb-3">
-              <div class="col-md-3 col-form-label pt-0">
-                <span i18n>Date format</span>
-              </div>
-              <div class="col">
-
-                <div class="form-check">
-                  <input type="radio" id="dateFormatShort" name="dateFormat" class="form-check-input" formControlName="dateFormat" value="shortDate">
-                  <label class="form-check-label" for="dateFormatShort" i18n>Short: {{today | customDate:'shortDate':null:computedDateLocale}}</label>
-                </div>
-                <div class="form-check">
-                  <input type="radio" id="dateFormatMedium" name="dateFormat" class="form-check-input" formControlName="dateFormat" value="mediumDate">
-                  <label class="form-check-label" for="dateFormatMedium" i18n>Medium: {{today | customDate:'mediumDate':null:computedDateLocale}}</label>
-                </div>
-                <div class="form-check">
-                  <input type="radio" id="dateFormatLong" name="dateFormat" class="form-check-input" formControlName="dateFormat" value="longDate">
-                  <label class="form-check-label" for="dateFormatLong" i18n>Long: {{today | customDate:'longDate':null:computedDateLocale}}</label>
-                </div>
-
-              </div>
-            </div>
-
-            <div class="row mb-3">
-              <div class="col-md-3 col-form-label pt-0">
-                <span i18n>Items per page</span>
-              </div>
-              <div class="col">
-
-                <select class="form-select" formControlName="documentListItemPerPage">
-                  <option [ngValue]="10">10</option>
-                  <option [ngValue]="25">25</option>
-                  <option [ngValue]="50">50</option>
-                  <option [ngValue]="100">100</option>
-                </select>
-
-              </div>
-            </div>
-
-            <div class="row mb-3">
-              <div class="col-md-3 col-form-label pt-0">
-                <span i18n>Sidebar</span>
-              </div>
-              <div class="col">
-
-                <pngx-input-check i18n-title title="Use 'slim' sidebar (icons only)" formControlName="slimSidebarEnabled"></pngx-input-check>
-
-              </div>
-            </div>
-
-            <div class="row mb-3">
-              <div class="col-md-3 col-form-label pt-0">
-                <span i18n>Dark mode</span>
-              </div>
-              <div class="col">
-                <pngx-input-check i18n-title title="Use system settings" formControlName="darkModeUseSystem"></pngx-input-check>
-                <pngx-input-check [hidden]="settingsForm.value.darkModeUseSystem" i18n-title title="Enable dark mode" formControlName="darkModeEnabled"></pngx-input-check>
-                <pngx-input-check i18n-title title="Invert thumbnails in dark mode" formControlName="darkModeInvertThumbs"></pngx-input-check>
-              </div>
-            </div>
-
-            <div class="row mb-3">
-              <div class="col-md-3 col-form-label pt-0">
-                <span i18n>Theme Color</span>
-              </div>
-              <div class="col col-md-4">
-                <pngx-input-color i18n-title formControlName="themeColor" [error]="error?.color"></pngx-input-color>
-              </div>
-              <div class="col-2">
-                <button class="btn btn-link btn-sm pt-2 ps-0" [disabled]="!this.settingsForm.get('themeColor').value" (click)="clearThemeColor()">
-                  <i-bs width="1em" height="1em" name="x"></i-bs><ng-container i18n>Reset</ng-container>
-                </button>
-              </div>
-            </div>
-
-            <h4 class="mt-4" i18n>Document editing</h4>
-
-            <div class="row mb-3">
-              <div class="col">
-                <pngx-input-check i18n-title title="Use PDF viewer provided by the browser" i18n-hint hint="This is usually faster for displaying large PDF documents, but it might not work on some browsers." formControlName="useNativePdfViewer"></pngx-input-check>
-              </div>
-            </div>
-
-            <div class="row mb-3">
-              <div class="col">
-                <pngx-input-check i18n-title title="Automatically remove inbox tag(s) on save" formControlName="documentEditingRemoveInboxTags"></pngx-input-check>
-              </div>
-            </div>
-
-            <div class="row mb-3">
-              <div class="col">
-                <pngx-input-check i18n-title title="Show document thumbnail during loading" formControlName="documentEditingOverlayThumbnail"></pngx-input-check>
-              </div>
-            </div>
+        <div class="row mb-3">
+          <div class="col-md-3 col-form-label pt-0">
+            <span i18n>Display language</span>
           </div>
-          <div class="col-xl-6 ps-xl-5">
-            <h4 class="mt-4 mt-md-0" id="update-checking" i18n>Update checking</h4>
-            <div class="row mb-3">
-              <div class="col d-flex flex-row align-items-start">
-                <pngx-input-check i18n-title title="Enable update checking" formControlName="updateCheckingEnabled"></pngx-input-check>
-                <button class="btn btn-sm btn-link text-muted me-auto p-0 ms-2" title="What's this?" i18n-title type="button" triggers="mouseenter:mouseleave" [ngbPopover]="updatesPopover" [autoClose]="true">
-                  <i-bs name="question-circle"></i-bs>
-                </button>
-                <ng-template #updatesPopover>
-                  <p i18n>
-                    Update checking works by pinging the public GitHub API for the latest release to determine whether a new version is available. Actual updating of the app must still be performed manually.
-                  </p>
-                  <p>
-                    <em i18n>No tracking data is collected by the app in any way.</em>
-                  </p>
-                </ng-template>
-              </div>
+          <div class="col">
+
+            <select class="form-select" formControlName="displayLanguage">
+              @for (lang of displayLanguageOptions; track lang) {
+                <option [ngValue]="lang.code">{{lang.name}}@if (lang.code && currentLocale !== 'en-US') {
+                  <span> - {{lang.englishName}}</span>
+                }</option>
+              }
+            </select>
+
+            @if (displayLanguageIsDirty) {
+              <small class="form-text text-primary" i18n>You need to reload the page after applying a new language.</small>
+            }
+
+          </div>
+        </div>
+
+        <div class="row mb-3">
+          <div class="col-md-3 col-form-label pt-0">
+            <span i18n>Date display</span>
+          </div>
+          <div class="col">
+
+            <select class="form-select" formControlName="dateLocale">
+              @for (lang of dateLocaleOptions; track lang) {
+                <option [ngValue]="lang.code">{{lang.name}}@if (lang.code) {
+                  <span> - {{today | customDate:'shortDate':null:lang.code}}</span>
+                }</option>
+              }
+            </select>
+
+          </div>
+        </div>
+
+        <div class="row mb-3">
+          <div class="col-md-3 col-form-label pt-0">
+            <span i18n>Date format</span>
+          </div>
+          <div class="col">
+
+            <div class="form-check">
+              <input type="radio" id="dateFormatShort" name="dateFormat" class="form-check-input" formControlName="dateFormat" value="shortDate">
+              <label class="form-check-label" for="dateFormatShort" i18n>Short: {{today | customDate:'shortDate':null:computedDateLocale}}</label>
+            </div>
+            <div class="form-check">
+              <input type="radio" id="dateFormatMedium" name="dateFormat" class="form-check-input" formControlName="dateFormat" value="mediumDate">
+              <label class="form-check-label" for="dateFormatMedium" i18n>Medium: {{today | customDate:'mediumDate':null:computedDateLocale}}</label>
+            </div>
+            <div class="form-check">
+              <input type="radio" id="dateFormatLong" name="dateFormat" class="form-check-input" formControlName="dateFormat" value="longDate">
+              <label class="form-check-label" for="dateFormatLong" i18n>Long: {{today | customDate:'longDate':null:computedDateLocale}}</label>
             </div>
 
-            <h4 class="mt-4" i18n>Bulk editing</h4>
-            <div class="row mb-3">
-              <div class="col">
-                <pngx-input-check i18n-title title="Show confirmation dialogs" formControlName="bulkEditConfirmationDialogs"></pngx-input-check>
-                <pngx-input-check i18n-title title="Apply on close" formControlName="bulkEditApplyOnClose"></pngx-input-check>
-              </div>
-            </div>
+          </div>
+        </div>
 
-            <h4 class="mt-4" i18n>Global search</h4>
-            <div class="row mb-3">
-              <div class="col">
-                <pngx-input-check i18n-title title="Do not include advanced search results" formControlName="searchDbOnly"></pngx-input-check>
-              </div>
-            </div>
+        <div class="row mb-3">
+          <div class="col-md-3 col-form-label pt-0">
+            <span i18n>Items per page</span>
+          </div>
+          <div class="col">
 
-            <div class="row mb-3">
-              <div class="col">
-                <div class="row">
-                  <div class="col-md-3 col-form-label pt-0">
-                    <span i18n>Full search links to</span>
-                  </div>
-                  <div class="col">
-                    <select class="form-select" formControlName="searchLink">
-                      <option [ngValue]="GlobalSearchType.TITLE_CONTENT" i18n>Title and content search</option>
-                      <option [ngValue]="GlobalSearchType.ADVANCED" i18n>Advanced search</option>
-                    </select>
-                  </div>
-                </div>
-              </div>
-            </div>
+            <select class="form-select" formControlName="documentListItemPerPage">
+              <option [ngValue]="10">10</option>
+              <option [ngValue]="25">25</option>
+              <option [ngValue]="50">50</option>
+              <option [ngValue]="100">100</option>
+            </select>
 
-            <h4 class="mt-4" i18n>Saved Views</h4>
-            <div class="row mb-3">
-              <div class="col">
-                <pngx-input-check i18n-title title="Show warning when closing saved views with unsaved changes" formControlName="savedViewsWarnOnUnsavedChange"></pngx-input-check>
-              </div>
-            </div>
+          </div>
+        </div>
 
-            <h4 class="mt-4" i18n>Notes</h4>
-            <div class="row mb-3">
-              <div class="col">
-                <pngx-input-check i18n-title title="Enable notes" formControlName="notesEnabled"></pngx-input-check>
-              </div>
-            </div>
+        <div class="row mb-3">
+          <div class="col-md-3 col-form-label pt-0">
+            <span i18n>Document editor</span>
+          </div>
+          <div class="col">
+
+            <pngx-input-check i18n-title title="Use PDF viewer provided by the browser" i18n-hint hint="This is usually faster for displaying large PDF documents, but it might not work on some browsers." formControlName="useNativePdfViewer"></pngx-input-check>
+
+          </div>
+        </div>
+
+        <div class="row mb-3">
+          <div class="col-md-3 col-form-label pt-0">
+            <span i18n>Sidebar</span>
+          </div>
+          <div class="col">
+
+            <pngx-input-check i18n-title title="Use 'slim' sidebar (icons only)" formControlName="slimSidebarEnabled"></pngx-input-check>
+
+          </div>
+        </div>
+
+        <div class="row mb-3">
+          <div class="col-md-3 col-form-label pt-0">
+            <span i18n>Dark mode</span>
+          </div>
+          <div class="col">
+            <pngx-input-check i18n-title title="Use system settings" formControlName="darkModeUseSystem"></pngx-input-check>
+            <pngx-input-check [hidden]="settingsForm.value.darkModeUseSystem" i18n-title title="Enable dark mode" formControlName="darkModeEnabled"></pngx-input-check>
+            <pngx-input-check i18n-title title="Invert thumbnails in dark mode" formControlName="darkModeInvertThumbs"></pngx-input-check>
+          </div>
+        </div>
+
+        <div class="row mb-3">
+          <div class="col-md-3 col-form-label pt-0">
+            <span i18n>Theme Color</span>
+          </div>
+          <div class="col col-md-3">
+            <pngx-input-color i18n-title formControlName="themeColor" [error]="error?.color"></pngx-input-color>
+          </div>
+          <div class="col-2">
+            <button class="btn btn-link btn-sm pt-2 ps-0" [disabled]="!this.settingsForm.get('themeColor').value" (click)="clearThemeColor()">
+              <i-bs width="1em" height="1em" name="x"></i-bs><ng-container i18n>Reset</ng-container>
+            </button>
+          </div>
+        </div>
+
+        <h4 class="mt-4" id="update-checking" i18n>Update checking</h4>
+
+        <div class="row mb-3">
+          <div class="offset-md-3 col">
+            <p i18n>
+            Update checking works by pinging the public <a href="https://api.github.com/repos/paperless-ngx/paperless-ngx/releases/latest" target="_blank" rel="noopener noreferrer">GitHub API</a> for the latest release to determine whether a new version is available.<br/>
+            Actual updating of the app must still be performed manually.
+          </p>
+            <p i18n>
+            <em>No tracking data is collected by the app in any way.</em>
+          </p>
+            <pngx-input-check i18n-title title="Enable update checking" formControlName="updateCheckingEnabled"></pngx-input-check>
+          </div>
+        </div>
+
+        <h4 class="mt-4" i18n>Document editing</h4>
+
+        <div class="row mb-3">
+          <div class="offset-md-3 col">
+            <pngx-input-check i18n-title title="Automatically remove inbox tag(s) on save" formControlName="documentEditingRemoveInboxTags"></pngx-input-check>
+          </div>
+        </div>
+
+        <h4 class="mt-4" i18n>Bulk editing</h4>
+
+        <div class="row mb-3">
+          <div class="offset-md-3 col">
+            <pngx-input-check i18n-title title="Show confirmation dialogs" formControlName="bulkEditConfirmationDialogs" i18n-hint hint="Deleting documents will always ask for confirmation."></pngx-input-check>
+            <pngx-input-check i18n-title title="Apply on close" formControlName="bulkEditApplyOnClose"></pngx-input-check>
+          </div>
+        </div>
+
+        <h4 class="mt-4" i18n>Notes</h4>
+
+        <div class="row mb-3">
+          <div class="offset-md-3 col">
+            <pngx-input-check i18n-title title="Enable notes" formControlName="notesEnabled"></pngx-input-check>
           </div>
         </div>
 
@@ -250,7 +215,7 @@
         <h4 i18n>Default Permissions</h4>
 
         <div class="row mb-3">
-          <div class="col">
+          <div class="offset-md-3 col">
             <p i18n>
             Settings apply to this user account for objects (Tags, Mail Rules, etc.) created via the web UI
           </p>
@@ -332,7 +297,7 @@
         <h4 i18n>Document processing</h4>
 
         <div class="row mb-3">
-          <div class="col">
+          <div class="offset-md-3 col">
             <pngx-input-check i18n-title title="Show notifications when new documents are detected" formControlName="notificationsConsumerNewDocument"></pngx-input-check>
             <pngx-input-check i18n-title title="Show notifications when document processing completes successfully" formControlName="notificationsConsumerSuccess"></pngx-input-check>
             <pngx-input-check i18n-title title="Show notifications when document processing fails" formControlName="notificationsConsumerFailed"></pngx-input-check>
@@ -342,6 +307,87 @@
 
       </ng-template>
     </li>
+
+    <li [ngbNavItem]="SettingsNavIDs.SavedViews">
+      <a ngbNavLink i18n>Saved views</a>
+      <ng-template ngbNavContent>
+
+        <h4 i18n>Settings</h4>
+        <div class="row mb-3">
+          <div class="offset-md-3 col">
+            <pngx-input-check i18n-title title="Show warning when closing saved views with unsaved changes" formControlName="savedViewsWarnOnUnsavedChange"></pngx-input-check>
+          </div>
+        </div>
+
+        <h4 i18n>Views</h4>
+        <ul class="list-group" formGroupName="savedViews">
+
+          @for (view of savedViews; track view) {
+            <li class="list-group-item py-3">
+            <div [formGroupName]="view.id" class="row">
+              <div class="row">
+                <div class="col">
+                  <pngx-input-text title="Name" formControlName="name"></pngx-input-text>
+                </div>
+                <div class="col">
+                  <div class="form-check form-switch mt-3">
+                    <input type="checkbox" class="form-check-input" id="show_on_dashboard_{{view.id}}" formControlName="show_on_dashboard">
+                    <label class="form-check-label" for="show_on_dashboard_{{view.id}}" i18n>Show on dashboard</label>
+                  </div>
+                  <div class="form-check form-switch">
+                    <input type="checkbox" class="form-check-input" id="show_in_sidebar_{{view.id}}" formControlName="show_in_sidebar">
+                    <label class="form-check-label" for="show_in_sidebar_{{view.id}}" i18n>Show in sidebar</label>
+                  </div>
+                </div>
+                <div class="col-auto">
+                  <label class="form-label" for="name_{{view.id}}" i18n>Actions</label>
+                  <pngx-confirm-button
+                    label="Delete"
+                    i18n-label
+                    (confirm)="deleteSavedView(view)"
+                    *pngxIfPermissions="{ action: PermissionAction.Delete, type: PermissionType.SavedView }"
+                    buttonClasses="btn-sm btn-outline-danger form-control"
+                    iconName="trash">
+                  </pngx-confirm-button>
+                </div>
+              </div>
+              <div class="row">
+                <div class="col">
+                  <pngx-input-number i18n-title title="Documents page size" [showAdd]="false" formControlName="page_size"></pngx-input-number>
+                </div>
+                <div class="col">
+                  <label class="form-label" for="display_mode_{{view.id}}" i18n>Display as</label>
+                  <select class="form-select" formControlName="display_mode">
+                    <option [ngValue]="DisplayMode.TABLE" i18n>Table</option>
+                    <option [ngValue]="DisplayMode.SMALL_CARDS" i18n>Small Cards</option>
+                    <option [ngValue]="DisplayMode.LARGE_CARDS" i18n>Large Cards</option>
+                  </select>
+                </div>
+                  @if (displayFields) {
+                    <pngx-input-drag-drop-select i18n-title title="Show" i18n-emptyText emptyText="Default" [items]="displayFields" formControlName="display_fields"></pngx-input-drag-drop-select>
+                  }
+                </div>
+            </div>
+            </li>
+          }
+
+          @if (savedViews && savedViews.length === 0) {
+            <li class="list-group-item">
+              <div i18n>No saved views defined.</div>
+            </li>
+          }
+
+          @if (!savedViews) {
+            <li class="list-group-item">
+              <div class="spinner-border spinner-border-sm fw-normal ms-2 me-auto" role="status"></div>
+              <div class="visually-hidden" i18n>Loading...</div>
+            </li>
+          }
+
+        </ul>
+
+      </ng-template>
+    </li>
   </ul>
 
   <div [ngbNavOutlet]="nav" class="border-start border-end border-bottom p-3 mb-3 shadow-sm"></div>

src-ui/src/app/components/admin/settings/settings.component.spec.ts

@@ -1,45 +1,35 @@
-import { DragDropModule } from '@angular/cdk/drag-drop'
-import { DatePipe, ViewportScroller } from '@angular/common'
-import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
-import { provideHttpClientTesting } from '@angular/common/http/testing'
+import { ViewportScroller, DatePipe } from '@angular/common'
+import { HttpClientTestingModule } from '@angular/common/http/testing'
 import { ComponentFixture, TestBed } from '@angular/core/testing'
 import { FormsModule, ReactiveFormsModule } from '@angular/forms'
 import { By } from '@angular/platform-browser'
-import { ActivatedRoute, Router, convertToParamMap } from '@angular/router'
+import { Router, ActivatedRoute, convertToParamMap } from '@angular/router'
 import { RouterTestingModule } from '@angular/router/testing'
 import {
+  NgbModule,
   NgbAlertModule,
+  NgbNavLink,
   NgbModal,
   NgbModalModule,
-  NgbModule,
-  NgbNavLink,
 } from '@ng-bootstrap/ng-bootstrap'
 import { NgSelectModule } from '@ng-select/ng-select'
-import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
 import { of, throwError } from 'rxjs'
 import { routes } from 'src/app/app-routing.module'
-import {
-  InstallType,
-  SystemStatus,
-  SystemStatusItemStatus,
-} from 'src/app/data/system-status'
+import { SavedView } from 'src/app/data/saved-view'
 import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
-import { IfOwnerDirective } from 'src/app/directives/if-owner.directive'
 import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
 import { PermissionsGuard } from 'src/app/guards/permissions.guard'
 import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
 import { SafeHtmlPipe } from 'src/app/pipes/safehtml.pipe'
 import { PermissionsService } from 'src/app/services/permissions.service'
 import { GroupService } from 'src/app/services/rest/group.service'
+import { SavedViewService } from 'src/app/services/rest/saved-view.service'
 import { UserService } from 'src/app/services/rest/user.service'
 import { SettingsService } from 'src/app/services/settings.service'
-import { SystemStatusService } from 'src/app/services/system-status.service'
-import { Toast, ToastService } from 'src/app/services/toast.service'
-import { ConfirmButtonComponent } from '../../common/confirm-button/confirm-button.component'
+import { ToastService, Toast } from 'src/app/services/toast.service'
 import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
 import { CheckComponent } from '../../common/input/check/check.component'
 import { ColorComponent } from '../../common/input/color/color.component'
-import { DragDropSelectComponent } from '../../common/input/drag-drop-select/drag-drop-select.component'
 import { NumberComponent } from '../../common/input/number/number.component'
 import { PermissionsGroupComponent } from '../../common/input/permissions/permissions-group/permissions-group.component'
 import { PermissionsUserComponent } from '../../common/input/permissions/permissions-user/permissions-user.component'
@@ -47,9 +37,24 @@ import { SelectComponent } from '../../common/input/select/select.component'
 import { TagsComponent } from '../../common/input/tags/tags.component'
 import { TextComponent } from '../../common/input/text/text.component'
 import { PageHeaderComponent } from '../../common/page-header/page-header.component'
-import { SystemStatusDialogComponent } from '../../common/system-status-dialog/system-status-dialog.component'
 import { SettingsComponent } from './settings.component'
+import { IfOwnerDirective } from 'src/app/directives/if-owner.directive'
+import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
+import { ConfirmButtonComponent } from '../../common/confirm-button/confirm-button.component'
+import { SystemStatusDialogComponent } from '../../common/system-status-dialog/system-status-dialog.component'
+import { SystemStatusService } from 'src/app/services/system-status.service'
+import {
+  SystemStatus,
+  InstallType,
+  SystemStatusItemStatus,
+} from 'src/app/data/system-status'
+import { DragDropSelectComponent } from '../../common/input/drag-drop-select/drag-drop-select.component'
+import { DragDropModule } from '@angular/cdk/drag-drop'
 
+const savedViews = [
+  { id: 1, name: 'view1', show_in_sidebar: true, show_on_dashboard: true },
+  { id: 2, name: 'view2', show_in_sidebar: false, show_on_dashboard: false },
+]
 const users = [
   { id: 1, username: 'user1', is_superuser: false },
   { id: 2, username: 'user2', is_superuser: false },
@@ -64,6 +69,7 @@ describe('SettingsComponent', () => {
   let fixture: ComponentFixture<SettingsComponent>
   let router: Router
   let settingsService: SettingsService
+  let savedViewService: SavedViewService
   let activatedRoute: ActivatedRoute
   let viewportScroller: ViewportScroller
   let toastService: ToastService
@@ -75,16 +81,7 @@ describe('SettingsComponent', () => {
 
   beforeEach(async () => {
     TestBed.configureTestingModule({
-      imports: [
-        NgbModule,
-        RouterTestingModule.withRoutes(routes),
-        FormsModule,
-        ReactiveFormsModule,
-        NgbAlertModule,
-        NgSelectModule,
-        NgxBootstrapIconsModule.pick(allIcons),
-        NgbModalModule,
-        DragDropModule,
+      declarations: [
         SettingsComponent,
         PageHeaderComponent,
         IfPermissionsDirective,
@@ -103,12 +100,18 @@ describe('SettingsComponent', () => {
         ConfirmButtonComponent,
         DragDropSelectComponent,
       ],
-      providers: [
-        CustomDatePipe,
-        DatePipe,
-        PermissionsGuard,
-        provideHttpClient(withInterceptorsFromDi()),
-        provideHttpClientTesting(),
+      providers: [CustomDatePipe, DatePipe, PermissionsGuard],
+      imports: [
+        NgbModule,
+        HttpClientTestingModule,
+        RouterTestingModule.withRoutes(routes),
+        FormsModule,
+        ReactiveFormsModule,
+        NgbAlertModule,
+        NgSelectModule,
+        NgxBootstrapIconsModule.pick(allIcons),
+        NgbModalModule,
+        DragDropModule,
       ],
     }).compileComponents()
 
@@ -130,6 +133,7 @@ describe('SettingsComponent', () => {
       .spyOn(permissionsService, 'currentUserOwnsObject')
       .mockReturnValue(true)
     groupService = TestBed.inject(GroupService)
+    savedViewService = TestBed.inject(SavedViewService)
   })
 
   function completeSetup(excludeService = null) {
@@ -151,6 +155,15 @@ describe('SettingsComponent', () => {
         })
       )
     }
+    if (excludeService !== savedViewService) {
+      jest.spyOn(savedViewService, 'listAll').mockReturnValue(
+        of({
+          all: savedViews.map((v) => v.id),
+          count: savedViews.length,
+          results: (savedViews as SavedView[]).concat([]),
+        })
+      )
+    }
 
     fixture = TestBed.createComponent(SettingsComponent)
     component = fixture.componentInstance
@@ -165,6 +178,8 @@ describe('SettingsComponent', () => {
     expect(navigateSpy).toHaveBeenCalledWith(['settings', 'permissions'])
     tabButtons[2].nativeElement.dispatchEvent(new MouseEvent('click'))
     expect(navigateSpy).toHaveBeenCalledWith(['settings', 'notifications'])
+    tabButtons[3].nativeElement.dispatchEvent(new MouseEvent('click'))
+    expect(navigateSpy).toHaveBeenCalledWith(['settings', 'savedviews'])
 
     const initSpy = jest.spyOn(component, 'initialize')
     component.isDirty = true // mock dirty
@@ -192,8 +207,90 @@ describe('SettingsComponent', () => {
     expect(scrollSpy).toHaveBeenCalledWith('#notifications')
   })
 
+  it('should enable organizing of sidebar saved views even on direct navigation', () => {
+    completeSetup()
+    jest
+      .spyOn(activatedRoute, 'paramMap', 'get')
+      .mockReturnValue(of(convertToParamMap({ section: 'savedviews' })))
+    activatedRoute.snapshot.fragment = '#savedviews'
+    component.ngOnInit()
+    expect(component.activeNavID).toEqual(4) // Saved Views
+    component.ngAfterViewInit()
+    expect(settingsService.organizingSidebarSavedViews).toBeTruthy()
+  })
+
+  it('should support save saved views, show error', () => {
+    completeSetup()
+
+    const tabButtons = fixture.debugElement.queryAll(By.directive(NgbNavLink))
+    tabButtons[3].nativeElement.dispatchEvent(new MouseEvent('click'))
+    fixture.detectChanges()
+
+    const toastErrorSpy = jest.spyOn(toastService, 'showError')
+    const toastSpy = jest.spyOn(toastService, 'show')
+    const savedViewPatchSpy = jest.spyOn(savedViewService, 'patchMany')
+
+    const toggle = fixture.debugElement.query(
+      By.css('.form-check.form-switch input')
+    )
+    toggle.nativeElement.checked = true
+    toggle.nativeElement.dispatchEvent(new Event('change'))
+
+    // saved views error first
+    savedViewPatchSpy.mockReturnValueOnce(
+      throwError(() => new Error('unable to save saved views'))
+    )
+    component.saveSettings()
+    expect(toastErrorSpy).toHaveBeenCalled()
+    expect(savedViewPatchSpy).toHaveBeenCalled()
+    toastSpy.mockClear()
+    toastErrorSpy.mockClear()
+    savedViewPatchSpy.mockClear()
+
+    // succeed saved views
+    savedViewPatchSpy.mockReturnValueOnce(of(savedViews as SavedView[]))
+    component.saveSettings()
+    expect(toastErrorSpy).not.toHaveBeenCalled()
+    expect(savedViewPatchSpy).toHaveBeenCalled()
+  })
+
+  it('should update only patch saved views that have changed', () => {
+    completeSetup()
+
+    const tabButtons = fixture.debugElement.queryAll(By.directive(NgbNavLink))
+    tabButtons[3].nativeElement.dispatchEvent(new MouseEvent('click'))
+    fixture.detectChanges()
+
+    const patchSpy = jest.spyOn(savedViewService, 'patchMany')
+    component.saveSettings()
+    expect(patchSpy).not.toHaveBeenCalled()
+
+    const view = savedViews[0]
+    const toggle = fixture.debugElement.query(
+      By.css('.form-check.form-switch input')
+    )
+    toggle.nativeElement.checked = true
+    toggle.nativeElement.dispatchEvent(new Event('change'))
+    // register change
+    component.savedViewGroup.get(view.id.toString()).value[
+      'show_on_dashboard'
+    ] = !view.show_on_dashboard
+    fixture.detectChanges()
+
+    component.saveSettings()
+    expect(patchSpy).toHaveBeenCalledWith([
+      {
+        id: view.id,
+        name: view.name,
+        show_in_sidebar: view.show_in_sidebar,
+        show_on_dashboard: !view.show_on_dashboard,
+      },
+    ])
+  })
+
   it('should support save local settings updating appearance settings and calling API, show error', () => {
     completeSetup()
+    jest.spyOn(savedViewService, 'patchMany').mockReturnValue(of([]))
     const toastErrorSpy = jest.spyOn(toastService, 'showError')
     const toastSpy = jest.spyOn(toastService, 'show')
     const storeSpy = jest.spyOn(settingsService, 'storeSettings')
@@ -212,7 +309,7 @@ describe('SettingsComponent', () => {
     expect(toastErrorSpy).toHaveBeenCalled()
     expect(storeSpy).toHaveBeenCalled()
     expect(appearanceSettingsSpy).not.toHaveBeenCalled()
-    expect(setSpy).toHaveBeenCalledTimes(28)
+    expect(setSpy).toHaveBeenCalledTimes(25)
 
     // succeed
     storeSpy.mockReturnValueOnce(of(true))
@@ -223,6 +320,7 @@ describe('SettingsComponent', () => {
 
   it('should offer reload if settings changes require', () => {
     completeSetup()
+    jest.spyOn(savedViewService, 'patchMany').mockReturnValue(of([]))
     let toast: Toast
     toastService.getToasts().subscribe((t) => (toast = t[0]))
     component.initialize(true) // reset
@@ -257,6 +355,18 @@ describe('SettingsComponent', () => {
     component.clearThemeColor()
   })
 
+  it('should support delete saved view', () => {
+    completeSetup()
+    const toastSpy = jest.spyOn(toastService, 'showInfo')
+    const deleteSpy = jest.spyOn(savedViewService, 'delete')
+    deleteSpy.mockReturnValue(of(true))
+    component.deleteSavedView(savedViews[0] as SavedView)
+    expect(deleteSpy).toHaveBeenCalled()
+    expect(toastSpy).toHaveBeenCalledWith(
+      `Saved view "${savedViews[0].name}" deleted.`
+    )
+  })
+
   it('should show errors on load if load users failure', () => {
     const toastErrorSpy = jest.spyOn(toastService, 'showError')
     jest

src-ui/src/app/components/admin/settings/settings.component.ts

@@ -1,69 +1,56 @@
-import { AsyncPipe, ViewportScroller } from '@angular/common'
+import { ViewportScroller } from '@angular/common'
 import {
-  AfterViewInit,
   Component,
+  OnInit,
+  AfterViewInit,
+  OnDestroy,
   Inject,
   LOCALE_ID,
-  OnDestroy,
-  OnInit,
 } from '@angular/core'
-import {
-  FormControl,
-  FormGroup,
-  FormsModule,
-  ReactiveFormsModule,
-} from '@angular/forms'
+import { FormGroup, FormControl } from '@angular/forms'
 import { ActivatedRoute, Router } from '@angular/router'
 import {
   NgbModal,
   NgbModalRef,
   NgbNavChangeEvent,
-  NgbNavModule,
-  NgbPopoverModule,
 } from '@ng-bootstrap/ng-bootstrap'
 import { DirtyComponent, dirtyCheck } from '@ngneat/dirty-check-forms'
-import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
 import { TourService } from 'ngx-ui-tour-ng-bootstrap'
 import {
   BehaviorSubject,
+  Subscription,
   Observable,
   Subject,
-  Subscription,
   first,
   takeUntil,
   tap,
 } from 'rxjs'
 import { Group } from 'src/app/data/group'
-import {
-  SystemStatus,
-  SystemStatusItemStatus,
-} from 'src/app/data/system-status'
-import { GlobalSearchType, SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import { SavedView } from 'src/app/data/saved-view'
+import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
 import { User } from 'src/app/data/user'
-import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
-import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
 import { DocumentListViewService } from 'src/app/services/document-list-view.service'
 import {
+  PermissionsService,
   PermissionAction,
   PermissionType,
-  PermissionsService,
 } from 'src/app/services/permissions.service'
 import { GroupService } from 'src/app/services/rest/group.service'
+import { SavedViewService } from 'src/app/services/rest/saved-view.service'
 import { UserService } from 'src/app/services/rest/user.service'
 import {
-  LanguageOption,
   SettingsService,
+  LanguageOption,
 } from 'src/app/services/settings.service'
-import { SystemStatusService } from 'src/app/services/system-status.service'
-import { Toast, ToastService } from 'src/app/services/toast.service'
-import { CheckComponent } from '../../common/input/check/check.component'
-import { ColorComponent } from '../../common/input/color/color.component'
-import { PermissionsGroupComponent } from '../../common/input/permissions/permissions-group/permissions-group.component'
-import { PermissionsUserComponent } from '../../common/input/permissions/permissions-user/permissions-user.component'
-import { SelectComponent } from '../../common/input/select/select.component'
-import { PageHeaderComponent } from '../../common/page-header/page-header.component'
-import { SystemStatusDialogComponent } from '../../common/system-status-dialog/system-status-dialog.component'
+import { ToastService, Toast } from 'src/app/services/toast.service'
 import { ComponentWithPermissions } from '../../with-permissions/with-permissions.component'
+import { SystemStatusDialogComponent } from '../../common/system-status-dialog/system-status-dialog.component'
+import { SystemStatusService } from 'src/app/services/system-status.service'
+import {
+  SystemStatusItemStatus,
+  SystemStatus,
+} from 'src/app/data/system-status'
+import { DisplayMode } from 'src/app/data/document'
 
 enum SettingsNavIDs {
   General = 1,
@@ -82,28 +69,15 @@ const systemDateFormat = {
   selector: 'pngx-settings',
   templateUrl: './settings.component.html',
   styleUrls: ['./settings.component.scss'],
-  imports: [
-    PageHeaderComponent,
-    CheckComponent,
-    ColorComponent,
-    SelectComponent,
-    PermissionsGroupComponent,
-    PermissionsUserComponent,
-    CustomDatePipe,
-    IfPermissionsDirective,
-    AsyncPipe,
-    FormsModule,
-    ReactiveFormsModule,
-    NgbNavModule,
-    NgbPopoverModule,
-    NgxBootstrapIconsModule,
-  ],
 })
 export class SettingsComponent
   extends ComponentWithPermissions
   implements OnInit, AfterViewInit, OnDestroy, DirtyComponent
 {
   activeNavID: number
+  DisplayMode = DisplayMode
+
+  savedViewGroup = new FormGroup({})
 
   settingsForm = new FormGroup({
     bulkEditConfirmationDialogs: new FormControl(null),
@@ -114,6 +88,7 @@ export class SettingsComponent
     darkModeEnabled: new FormControl(null),
     darkModeInvertThumbs: new FormControl(null),
     themeColor: new FormControl(null),
+    useNativePdfViewer: new FormControl(null),
     displayLanguage: new FormControl(null),
     dateLocale: new FormControl(null),
     dateFormat: new FormControl(null),
@@ -124,11 +99,7 @@ export class SettingsComponent
     defaultPermsViewGroups: new FormControl(null),
     defaultPermsEditUsers: new FormControl(null),
     defaultPermsEditGroups: new FormControl(null),
-    useNativePdfViewer: new FormControl(null),
     documentEditingRemoveInboxTags: new FormControl(null),
-    documentEditingOverlayThumbnail: new FormControl(null),
-    searchDbOnly: new FormControl(null),
-    searchLink: new FormControl(null),
 
     notificationsConsumerNewDocument: new FormControl(null),
     notificationsConsumerSuccess: new FormControl(null),
@@ -136,9 +107,14 @@ export class SettingsComponent
     notificationsConsumerSuppressOnDashboard: new FormControl(null),
 
     savedViewsWarnOnUnsavedChange: new FormControl(null),
+    savedViews: this.savedViewGroup,
   })
 
+  savedViews: SavedView[]
   SettingsNavIDs = SettingsNavIDs
+  get displayFields() {
+    return this.settings.allDisplayFields
+  }
 
   store: BehaviorSubject<any>
   storeSub: Subscription
@@ -152,8 +128,6 @@ export class SettingsComponent
 
   public systemStatus: SystemStatus
 
-  public readonly GlobalSearchType = GlobalSearchType
-
   get systemStatusHasErrors(): boolean {
     return (
       this.systemStatus.database.status === SystemStatusItemStatus.ERROR ||
@@ -173,6 +147,7 @@ export class SettingsComponent
   }
 
   constructor(
+    public savedViewService: SavedViewService,
     private documentListViewService: DocumentListViewService,
     private toastService: ToastService,
     private settings: SettingsService,
@@ -234,6 +209,18 @@ export class SettingsComponent
         })
     }
 
+    if (
+      this.permissionsService.currentUserCan(
+        PermissionAction.View,
+        PermissionType.SavedView
+      )
+    ) {
+      this.savedViewService.listAll().subscribe((r) => {
+        this.savedViews = r.results
+        this.initialize(false)
+      })
+    }
+
     this.activatedRoute.paramMap.subscribe((paramMap) => {
       const section = paramMap.get('section')
       if (section) {
@@ -243,6 +230,9 @@ export class SettingsComponent
         if (navIDKey) {
           this.activeNavID = SettingsNavIDs[navIDKey]
         }
+        if (this.activeNavID === SettingsNavIDs.SavedViews) {
+          this.settings.organizingSidebarSavedViews = true
+        }
       }
     })
   }
@@ -314,11 +304,7 @@ export class SettingsComponent
       documentEditingRemoveInboxTags: this.settings.get(
         SETTINGS_KEYS.DOCUMENT_EDITING_REMOVE_INBOX_TAGS
       ),
-      documentEditingOverlayThumbnail: this.settings.get(
-        SETTINGS_KEYS.DOCUMENT_EDITING_OVERLAY_THUMBNAIL
-      ),
-      searchDbOnly: this.settings.get(SETTINGS_KEYS.SEARCH_DB_ONLY),
-      searchLink: this.settings.get(SETTINGS_KEYS.SEARCH_FULL_TYPE),
+      savedViews: {},
     }
   }
 
@@ -331,11 +317,15 @@ export class SettingsComponent
       this.router
         .navigate(['settings', foundNavIDkey.toLowerCase()])
         .then((navigated) => {
+          this.settings.organizingSidebarSavedViews = false
           if (!navigated && this.isDirty) {
             this.activeNavID = navChangeEvent.activeId
           } else if (navigated && this.isDirty) {
             this.initialize()
           }
+          if (this.activeNavID === SettingsNavIDs.SavedViews) {
+            this.settings.organizingSidebarSavedViews = true
+          }
         })
   }
 
@@ -346,6 +336,34 @@ export class SettingsComponent
 
     let storeData = this.getCurrentSettings()
 
+    if (this.savedViews) {
+      this.emptyGroup(this.savedViewGroup)
+
+      for (let view of this.savedViews) {
+        storeData.savedViews[view.id.toString()] = {
+          id: view.id,
+          name: view.name,
+          show_on_dashboard: view.show_on_dashboard,
+          show_in_sidebar: view.show_in_sidebar,
+          page_size: view.page_size,
+          display_mode: view.display_mode,
+          display_fields: view.display_fields,
+        }
+        this.savedViewGroup.addControl(
+          view.id.toString(),
+          new FormGroup({
+            id: new FormControl(null),
+            name: new FormControl(null),
+            show_on_dashboard: new FormControl(null),
+            show_in_sidebar: new FormControl(null),
+            page_size: new FormControl(null),
+            display_mode: new FormControl(null),
+            display_fields: new FormControl([]),
+          })
+        )
+      }
+    }
+
     this.store = new BehaviorSubject(storeData)
 
     this.storeSub = this.store.asObservable().subscribe((state) => {
@@ -385,12 +403,32 @@ export class SettingsComponent
     }
   }
 
+  private emptyGroup(group: FormGroup) {
+    Object.keys(group.controls).forEach((key) => group.removeControl(key))
+  }
+
   ngOnDestroy() {
     if (this.isDirty) this.settings.updateAppearanceSettings() // in case user changed appearance but didn't save
     this.storeSub && this.storeSub.unsubscribe()
+    this.settings.organizingSidebarSavedViews = false
   }
 
-  public saveSettings() {
+  deleteSavedView(savedView: SavedView) {
+    this.savedViewService.delete(savedView).subscribe(() => {
+      this.savedViewGroup.removeControl(savedView.id.toString())
+      this.savedViews.splice(this.savedViews.indexOf(savedView), 1)
+      this.toastService.showInfo(
+        $localize`Saved view "${savedView.name}" deleted.`
+      )
+      this.savedViewService.clearCache()
+      this.savedViewService.listAll().subscribe((r) => {
+        this.savedViews = r.results
+        this.initialize(true)
+      })
+    })
+  }
+
+  private saveLocalSettings() {
     this.savePending = true
     const reloadRequired =
       this.settingsForm.value.displayLanguage !=
@@ -495,18 +533,6 @@ export class SettingsComponent
       SETTINGS_KEYS.DOCUMENT_EDITING_REMOVE_INBOX_TAGS,
       this.settingsForm.value.documentEditingRemoveInboxTags
     )
-    this.settings.set(
-      SETTINGS_KEYS.DOCUMENT_EDITING_OVERLAY_THUMBNAIL,
-      this.settingsForm.value.documentEditingOverlayThumbnail
-    )
-    this.settings.set(
-      SETTINGS_KEYS.SEARCH_DB_ONLY,
-      this.settingsForm.value.searchDbOnly
-    )
-    this.settings.set(
-      SETTINGS_KEYS.SEARCH_FULL_TYPE,
-      this.settingsForm.value.searchLink
-    )
     this.settings.setLanguage(this.settingsForm.value.displayLanguage)
     this.settings
       .storeSettings()
@@ -552,6 +578,31 @@ export class SettingsComponent
     return new Date()
   }
 
+  saveSettings() {
+    // only patch views that have actually changed
+    const changed: SavedView[] = []
+    Object.values(this.savedViewGroup.controls)
+      .filter((g: FormGroup) => !g.pristine)
+      .forEach((group: FormGroup) => {
+        changed.push(group.value)
+      })
+    if (changed.length > 0) {
+      this.savedViewService.patchMany(changed).subscribe({
+        next: () => {
+          this.saveLocalSettings()
+        },
+        error: (error) => {
+          this.toastService.showError(
+            $localize`Error while storing settings on server.`,
+            error
+          )
+        },
+      })
+    } else {
+      this.saveLocalSettings()
+    }
+  }
+
   reset() {
     this.settingsForm.patchValue(this.store.getValue())
   }

src-ui/src/app/components/admin/tasks/tasks.component.html

@@ -4,40 +4,15 @@
   info="File Tasks shows you documents that have been consumed, are waiting to be, or may have failed during the process."
   i18n-info
   >
-  <div class="btn-toolbar col col-md-auto align-items-center gap-2">
+  <div class="btn-toolbar col col-md-auto align-items-center">
     <button class="btn btn-sm btn-outline-secondary me-2" (click)="clearSelection()" [hidden]="selectedTasks.size === 0">
       <i-bs name="x"></i-bs>&nbsp;<ng-container i18n>Clear selection</ng-container>
     </button>
-    <button class="btn btn-sm btn-outline-primary me-2" (click)="dismissTasks()" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.PaperlessTask }" [disabled]="tasksService.total === 0">
+    <button class="btn btn-sm btn-outline-primary me-4" (click)="dismissTasks()" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.PaperlessTask }" [disabled]="tasksService.total === 0">
       <i-bs name="check2-all"></i-bs>&nbsp;{{dismissButtonText}}
     </button>
-    <div class="form-inline d-flex align-items-center">
-      <div class="input-group input-group-sm flex-fill w-auto flex-nowrap">
-        <span class="input-group-text text-muted" i18n>Filter by</span>
-        @if (filterTargets.length > 1) {
-          <div ngbDropdown>
-            <button class="btn btn-sm btn-outline-primary" ngbDropdownToggle>{{filterTargetName}}</button>
-            <div class="dropdown-menu shadow" ngbDropdownMenu>
-              @for (t of filterTargets; track t.id) {
-                <button ngbDropdownItem [class.active]="filterTargetID === t.id" (click)="filterTargetID = t.id">{{t.name}}</button>
-              }
-            </div>
-          </div>
-        } @else {
-          <span class="input-group-text">{{filterTargetName}}</span>
-        }
-        @if (filterText?.length) {
-          <button class="btn btn-link btn-sm px-2 position-absolute top-0 end-0 z-10" (click)="resetFilter()">
-            <i-bs width="1em" height="1em" name="x"></i-bs>
-          </button>
-        }
-        <input #filterInput class="form-control form-control-sm" type="text"
-          (keyup)="filterInputKeyup($event)"
-          [(ngModel)]="filterText">
-      </div>
-    </div>
-    <div class="form-check form-switch mb-0 ms-2">
-      <input class="form-check-input" type="checkbox" role="switch" [(ngModel)]="autoRefreshEnabled">
+    <div class="form-check form-switch mb-0">
+      <input class="form-check-input" type="checkbox" role="switch" id="autoRefreshSwitch" (click)="toggleAutoRefresh()" [attr.checked]="autoRefreshInterval">
       <label class="form-check-label" for="autoRefreshSwitch" i18n>Auto refresh</label>
     </div>
   </div>
@@ -68,7 +43,7 @@
       </tr>
     </thead>
     <tbody>
-      @for (task of tasks | slice: (page-1) * pageSize : page * pageSize; track task.id) {
+      @for (task of tasks | slice: (page-1) * pageSize : page * pageSize; track task) {
         <tr (click)="toggleSelected(task, $event); $event.stopPropagation();">
           <td>
             <div class="form-check">
@@ -143,13 +118,13 @@
   </div>
 </ng-template>
 
-<ul ngbNav #nav="ngbNav" [(activeId)]="activeTab" class="nav-tabs" (hidden)="duringTabChange()" (navChange)="beforeTabChange()">
+<ul ngbNav #nav="ngbNav" [(activeId)]="activeTab" class="nav-tabs" (hidden)="duringTabChange($event)">
   <li ngbNavItem="failed">
     <a ngbNavLink i18n>Failed@if (tasksService.failedFileTasks.length > 0) {
       <span class="badge bg-danger ms-2">{{tasksService.failedFileTasks.length}}</span>
     }</a>
     <ng-template ngbNavContent>
-      <ng-container [ngTemplateOutlet]="tasksTemplate" [ngTemplateOutletContext]="{tasks:currentTasks}"></ng-container>
+      <ng-container [ngTemplateOutlet]="tasksTemplate" [ngTemplateOutletContext]="{tasks:tasksService.failedFileTasks}"></ng-container>
     </ng-template>
   </li>
   <li ngbNavItem="completed">
@@ -157,7 +132,7 @@
       <span class="badge bg-secondary ms-2">{{tasksService.completedFileTasks.length}}</span>
     }</a>
     <ng-template ngbNavContent>
-      <ng-container [ngTemplateOutlet]="tasksTemplate" [ngTemplateOutletContext]="{tasks:currentTasks}"></ng-container>
+      <ng-container [ngTemplateOutlet]="tasksTemplate" [ngTemplateOutletContext]="{tasks:tasksService.completedFileTasks}"></ng-container>
     </ng-template>
   </li>
   <li ngbNavItem="started">
@@ -165,7 +140,7 @@
       <span class="badge bg-secondary ms-2">{{tasksService.startedFileTasks.length}}</span>
     }</a>
     <ng-template ngbNavContent>
-      <ng-container [ngTemplateOutlet]="tasksTemplate" [ngTemplateOutletContext]="{tasks:currentTasks}"></ng-container>
+      <ng-container [ngTemplateOutlet]="tasksTemplate" [ngTemplateOutletContext]="{tasks:tasksService.startedFileTasks}"></ng-container>
     </ng-template>
   </li>
   <li ngbNavItem="queued">
@@ -173,7 +148,7 @@
       <span class="badge bg-secondary ms-2">{{tasksService.queuedFileTasks.length}}</span>
     }</a>
     <ng-template ngbNavContent>
-      <ng-container [ngTemplateOutlet]="tasksTemplate" [ngTemplateOutletContext]="{tasks:currentTasks}"></ng-container>
+      <ng-container [ngTemplateOutlet]="tasksTemplate" [ngTemplateOutletContext]="{tasks:tasksService.queuedFileTasks}"></ng-container>
     </ng-template>
   </li>
 </ul>

src-ui/src/app/components/admin/tasks/tasks.component.scss

@@ -26,14 +26,3 @@ pre {
         max-width: 150px;
     }
 }
-
-.input-group .dropdown .btn {
-    border-top-right-radius: 0;
-    border-bottom-right-radius: 0;
-    border-top-left-radius: 0;
-    border-bottom-left-radius: 0;
-}
-
-.z-10 {
-    z-index: 10;
-}

src-ui/src/app/components/admin/tasks/tasks.component.spec.ts

@@ -1,36 +1,35 @@
 import { DatePipe } from '@angular/common'
-import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
 import {
   HttpTestingController,
-  provideHttpClientTesting,
+  HttpClientTestingModule,
 } from '@angular/common/http/testing'
 import { ComponentFixture, TestBed } from '@angular/core/testing'
-import { FormsModule } from '@angular/forms'
 import { By } from '@angular/platform-browser'
 import { Router } from '@angular/router'
 import { RouterTestingModule } from '@angular/router/testing'
 import {
   NgbModal,
-  NgbModalRef,
   NgbModule,
   NgbNavItem,
+  NgbModalRef,
 } from '@ng-bootstrap/ng-bootstrap'
-import { allIcons, NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
 import { routes } from 'src/app/app-routing.module'
 import {
   PaperlessTask,
-  PaperlessTaskStatus,
   PaperlessTaskType,
+  PaperlessTaskStatus,
 } from 'src/app/data/paperless-task'
 import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
-import { PermissionsGuard } from 'src/app/guards/permissions.guard'
 import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
 import { PermissionsService } from 'src/app/services/permissions.service'
 import { TasksService } from 'src/app/services/tasks.service'
 import { environment } from 'src/environments/environment'
 import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
 import { PageHeaderComponent } from '../../common/page-header/page-header.component'
-import { TasksComponent, TaskTab } from './tasks.component'
+import { TasksComponent } from './tasks.component'
+import { PermissionsGuard } from 'src/app/guards/permissions.guard'
+import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
+import { FormsModule } from '@angular/forms'
 
 const tasks: PaperlessTask[] = [
   {
@@ -119,11 +118,7 @@ describe('TasksComponent', () => {
 
   beforeEach(async () => {
     TestBed.configureTestingModule({
-      imports: [
-        NgbModule,
-        RouterTestingModule.withRoutes(routes),
-        NgxBootstrapIconsModule.pick(allIcons),
-        FormsModule,
+      declarations: [
         TasksComponent,
         PageHeaderComponent,
         IfPermissionsDirective,
@@ -140,8 +135,13 @@ describe('TasksComponent', () => {
         CustomDatePipe,
         DatePipe,
         PermissionsGuard,
-        provideHttpClient(withInterceptorsFromDi()),
-        provideHttpClientTesting(),
+      ],
+      imports: [
+        NgbModule,
+        HttpClientTestingModule,
+        RouterTestingModule.withRoutes(routes),
+        NgxBootstrapIconsModule.pick(allIcons),
+        FormsModule,
       ],
     }).compileComponents()
 
@@ -165,7 +165,7 @@ describe('TasksComponent', () => {
     let currentTasksLength = tasks.filter(
       (t) => t.status === PaperlessTaskStatus.Failed
     ).length
-    component.activeTab = TaskTab.Failed
+    component.activeTab = 'failed'
     fixture.detectChanges()
     expect(tabButtons[0].nativeElement.textContent).toEqual(
       `Failed${currentTasksLength}`
@@ -177,7 +177,7 @@ describe('TasksComponent', () => {
     currentTasksLength = tasks.filter(
       (t) => t.status === PaperlessTaskStatus.Complete
     ).length
-    component.activeTab = TaskTab.Completed
+    component.activeTab = 'completed'
     fixture.detectChanges()
     expect(tabButtons[1].nativeElement.textContent).toEqual(
       `Complete${currentTasksLength}`
@@ -186,7 +186,7 @@ describe('TasksComponent', () => {
     currentTasksLength = tasks.filter(
       (t) => t.status === PaperlessTaskStatus.Started
     ).length
-    component.activeTab = TaskTab.Started
+    component.activeTab = 'started'
     fixture.detectChanges()
     expect(tabButtons[2].nativeElement.textContent).toEqual(
       `Started${currentTasksLength}`
@@ -195,7 +195,7 @@ describe('TasksComponent', () => {
     currentTasksLength = tasks.filter(
       (t) => t.status === PaperlessTaskStatus.Pending
     ).length
-    component.activeTab = TaskTab.Queued
+    component.activeTab = 'queued'
     fixture.detectChanges()
     expect(tabButtons[3].nativeElement.textContent).toEqual(
       `Queued${currentTasksLength}`
@@ -204,7 +204,7 @@ describe('TasksComponent', () => {
 
   it('should to go page 1 between tab switch', () => {
     component.page = 10
-    component.duringTabChange()
+    component.duringTabChange(2)
     expect(component.page).toEqual(1)
   })
 
@@ -281,63 +281,10 @@ describe('TasksComponent', () => {
     expect(reloadSpy).toHaveBeenCalledTimes(1)
     jest.advanceTimersByTime(5000)
     expect(reloadSpy).toHaveBeenCalledTimes(2)
-    component.autoRefreshEnabled = false
+
+    component.toggleAutoRefresh()
+    expect(component.autoRefreshInterval).toBeNull()
     jest.advanceTimersByTime(6000)
     expect(reloadSpy).toHaveBeenCalledTimes(2)
   })
-
-  it('should filter tasks by file name', () => {
-    const input = fixture.debugElement.query(
-      By.css('pngx-page-header input[type=text]')
-    )
-    input.nativeElement.value = '191092'
-    input.nativeElement.dispatchEvent(new Event('input'))
-    jest.advanceTimersByTime(150) // debounce time
-    fixture.detectChanges()
-    expect(component.filterText).toEqual('191092')
-    expect(
-      fixture.debugElement.queryAll(By.css('table tbody tr')).length
-    ).toEqual(2) // 1 task x 2 lines
-  })
-
-  it('should filter tasks by result', () => {
-    component.activeTab = TaskTab.Failed
-    fixture.detectChanges()
-    component.filterTargetID = 1
-    const input = fixture.debugElement.query(
-      By.css('pngx-page-header input[type=text]')
-    )
-    input.nativeElement.value = 'duplicate'
-    input.nativeElement.dispatchEvent(new Event('input'))
-    jest.advanceTimersByTime(150) // debounce time
-    fixture.detectChanges()
-    expect(component.filterText).toEqual('duplicate')
-    expect(
-      fixture.debugElement.queryAll(By.css('table tbody tr')).length
-    ).toEqual(4) // 2 tasks x 2 lines
-  })
-
-  it('should support keyboard events for filtering', () => {
-    const input = fixture.debugElement.query(
-      By.css('pngx-page-header input[type=text]')
-    )
-    input.nativeElement.value = '191092'
-    input.nativeElement.dispatchEvent(
-      new KeyboardEvent('keyup', { key: 'Enter' })
-    )
-    expect(component.filterText).toEqual('191092') // no debounce needed
-    input.nativeElement.dispatchEvent(
-      new KeyboardEvent('keyup', { key: 'Escape' })
-    )
-    expect(component.filterText).toEqual('')
-  })
-
-  it('should reset filter and target on tab switch', () => {
-    component.filterText = '191092'
-    component.filterTargetID = 1
-    component.activeTab = TaskTab.Completed
-    component.beforeTabChange()
-    expect(component.filterText).toEqual('')
-    expect(component.filterTargetID).toEqual(0)
-  })
 })

src-ui/src/app/components/admin/tasks/tasks.component.ts

@@ -1,75 +1,22 @@
-import { NgTemplateOutlet, SlicePipe } from '@angular/common'
-import { Component, OnDestroy, OnInit } from '@angular/core'
-import { FormsModule, ReactiveFormsModule } from '@angular/forms'
+import { Component, OnInit, OnDestroy } from '@angular/core'
 import { Router } from '@angular/router'
-import {
-  NgbCollapseModule,
-  NgbDropdownModule,
-  NgbModal,
-  NgbNavModule,
-  NgbPaginationModule,
-  NgbPopoverModule,
-} from '@ng-bootstrap/ng-bootstrap'
-import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
-import {
-  debounceTime,
-  distinctUntilChanged,
-  filter,
-  first,
-  Subject,
-  takeUntil,
-  timer,
-} from 'rxjs'
+import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
+import { first } from 'rxjs'
 import { PaperlessTask } from 'src/app/data/paperless-task'
-import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
-import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
 import { TasksService } from 'src/app/services/tasks.service'
 import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
-import { PageHeaderComponent } from '../../common/page-header/page-header.component'
-import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
-
-export enum TaskTab {
-  Queued = 'queued',
-  Started = 'started',
-  Completed = 'completed',
-  Failed = 'failed',
-}
-
-enum TaskFilterTargetID {
-  Name,
-  Result,
-}
-
-const FILTER_TARGETS = [
-  { id: TaskFilterTargetID.Name, name: $localize`Name` },
-  { id: TaskFilterTargetID.Result, name: $localize`Result` },
-]
+import { ComponentWithPermissions } from '../../with-permissions/with-permissions.component'
 
 @Component({
   selector: 'pngx-tasks',
   templateUrl: './tasks.component.html',
   styleUrls: ['./tasks.component.scss'],
-  imports: [
-    PageHeaderComponent,
-    IfPermissionsDirective,
-    CustomDatePipe,
-    SlicePipe,
-    FormsModule,
-    ReactiveFormsModule,
-    NgTemplateOutlet,
-    NgbCollapseModule,
-    NgbDropdownModule,
-    NgbNavModule,
-    NgbPaginationModule,
-    NgbPopoverModule,
-    NgxBootstrapIconsModule,
-  ],
 })
 export class TasksComponent
-  extends LoadingComponentWithPermissions
+  extends ComponentWithPermissions
   implements OnInit, OnDestroy
 {
-  public activeTab: TaskTab
+  public activeTab: string
   public selectedTasks: Set<number> = new Set()
   public togggleAll: boolean = false
   public expandedTask: number
@@ -77,27 +24,7 @@ export class TasksComponent
   public pageSize: number = 25
   public page: number = 1
 
-  public autoRefreshEnabled: boolean = true
-
-  private _filterText: string = ''
-  get filterText() {
-    return this._filterText
-  }
-  set filterText(value: string) {
-    this.filterDebounce.next(value)
-  }
-
-  public filterTargetID: TaskFilterTargetID = TaskFilterTargetID.Name
-  public get filterTargetName(): string {
-    return this.filterTargets.find((t) => t.id == this.filterTargetID).name
-  }
-  private filterDebounce: Subject<string> = new Subject<string>()
-
-  public get filterTargets(): Array<{ id: number; name: string }> {
-    return [TaskTab.Failed, TaskTab.Completed].includes(this.activeTab)
-      ? FILTER_TARGETS
-      : FILTER_TARGETS.slice(0, 1)
-  }
+  public autoRefreshInterval: any
 
   get dismissButtonText(): string {
     return this.selectedTasks.size > 0
@@ -115,28 +42,12 @@ export class TasksComponent
 
   ngOnInit() {
     this.tasksService.reload()
-    timer(5000, 5000)
-      .pipe(
-        filter(() => this.autoRefreshEnabled),
-        takeUntil(this.unsubscribeNotifier)
-      )
-      .subscribe(() => {
-        this.tasksService.reload()
-      })
-
-    this.filterDebounce
-      .pipe(
-        takeUntil(this.unsubscribeNotifier),
-        debounceTime(100),
-        distinctUntilChanged(),
-        filter((query) => !query.length || query.length > 2)
-      )
-      .subscribe((query) => (this._filterText = query))
+    this.toggleAutoRefresh()
   }
 
   ngOnDestroy() {
-    super.ngOnDestroy()
     this.tasksService.cancelPending()
+    clearInterval(this.autoRefreshInterval)
   }
 
   dismissTask(task: PaperlessTask) {
@@ -159,11 +70,11 @@ export class TasksComponent
         modal.componentInstance.buttonsEnabled = false
         modal.close()
         this.tasksService.dismissTasks(tasks)
-        this.clearSelection()
+        this.selectedTasks.clear()
       })
     } else {
       this.tasksService.dismissTasks(tasks)
-      this.clearSelection()
+      this.selectedTasks.clear()
     }
   }
 
@@ -185,30 +96,19 @@ export class TasksComponent
   get currentTasks(): PaperlessTask[] {
     let tasks: PaperlessTask[] = []
     switch (this.activeTab) {
-      case TaskTab.Queued:
+      case 'queued':
         tasks = this.tasksService.queuedFileTasks
         break
-      case TaskTab.Started:
+      case 'started':
         tasks = this.tasksService.startedFileTasks
         break
-      case TaskTab.Completed:
+      case 'completed':
         tasks = this.tasksService.completedFileTasks
         break
-      case TaskTab.Failed:
+      case 'failed':
         tasks = this.tasksService.failedFileTasks
         break
     }
-    if (this._filterText.length) {
-      tasks = tasks.filter((t) => {
-        if (this.filterTargetID == TaskFilterTargetID.Name) {
-          return t.task_file_name
-            .toLowerCase()
-            .includes(this._filterText.toLowerCase())
-        } else if (this.filterTargetID == TaskFilterTargetID.Result) {
-          return t.result.toLowerCase().includes(this._filterText.toLowerCase())
-        }
-      })
-    }
     return tasks
   }
 
@@ -225,37 +125,31 @@ export class TasksComponent
     this.selectedTasks.clear()
   }
 
-  duringTabChange() {
+  duringTabChange(navID: number) {
     this.page = 1
   }
 
-  beforeTabChange() {
-    this.resetFilter()
-    this.filterTargetID = TaskFilterTargetID.Name
-  }
-
   get activeTabLocalized(): string {
     switch (this.activeTab) {
-      case TaskTab.Queued:
+      case 'queued':
         return $localize`queued`
-      case TaskTab.Started:
+      case 'started':
         return $localize`started`
-      case TaskTab.Completed:
+      case 'completed':
         return $localize`completed`
-      case TaskTab.Failed:
+      case 'failed':
         return $localize`failed`
     }
   }
 
-  public resetFilter() {
-    this._filterText = ''
-  }
-
-  filterInputKeyup(event: KeyboardEvent) {
-    if (event.key == 'Enter') {
-      this._filterText = (event.target as HTMLInputElement).value
-    } else if (event.key === 'Escape') {
-      this.resetFilter()
+  toggleAutoRefresh(): void {
+    if (this.autoRefreshInterval) {
+      clearInterval(this.autoRefreshInterval)
+      this.autoRefreshInterval = null
+    } else {
+      this.autoRefreshInterval = setInterval(() => {
+        this.tasksService.reload()
+      }, 5000)
     }
   }
 }

src-ui/src/app/components/admin/trash/trash.component.html

@@ -1,103 +0,0 @@
-<pngx-page-header
-    title="Trash"
-    i18n-title
-    info="Manage trashed documents that are pending deletion."
-    i18n-info
-    infoLink="usage/#document-trash">
-    <button class="btn btn-sm btn-outline-secondary" (click)="clearSelection()" [hidden]="selectedDocuments.size === 0">
-        <i-bs name="x"></i-bs>&nbsp;<ng-container i18n>Clear selection</ng-container>
-    </button>
-    <button type="button" class="btn btn-sm btn-outline-primary" (click)="restoreAll(selectedDocuments)" [disabled]="selectedDocuments.size === 0">
-        <i-bs name="arrow-counterclockwise"></i-bs>&nbsp;<ng-container i18n>Restore selected</ng-container>
-    </button>
-    <button type="button" class="btn btn-sm btn-outline-danger" (click)="emptyTrash(selectedDocuments)" [disabled]="selectedDocuments.size === 0">
-        <i-bs name="trash"></i-bs>&nbsp;<ng-container i18n>Delete selected</ng-container>
-    </button>
-    <button type="button" class="btn btn-sm btn-outline-danger" (click)="emptyTrash()" [disabled]="documentsInTrash.length === 0">
-        <i-bs name="trash"></i-bs>&nbsp;<ng-container i18n>Empty trash</ng-container>
-    </button>
-</pngx-page-header>
-
-<div class="row mb-3">
-    <ngb-pagination class="col-auto" [pageSize]="25" [collectionSize]="totalDocuments" [(page)]="page" [maxSize]="5" (pageChange)="reload()" size="sm" aria-label="Pagination"></ngb-pagination>
-</div>
-
-<div class="card border table-responsive mb-3">
-    <table class="table table-striped align-middle shadow-sm mb-0">
-        <thead>
-            <tr>
-            <th scope="col">
-                <div class="form-check m-0 ms-2 me-n2">
-                <input type="checkbox" class="form-check-input" id="all-objects" [(ngModel)]="allToggled" [disabled]="documentsInTrash.length === 0" (click)="toggleAll($event); $event.stopPropagation();">
-                <label class="form-check-label" for="all-objects"></label>
-                </div>
-            </th>
-            <th scope="col" class="fw-normal" i18n>Name</th>
-            <th scope="col" class="fw-normal d-none d-sm-table-cell" i18n>Remaining</th>
-            <th scope="col" class="fw-normal" i18n>Actions</th>
-            </tr>
-        </thead>
-        <tbody>
-            @if (loading) {
-                <tr>
-                    <td colspan="5">
-                    <div class="spinner-border spinner-border-sm me-2" role="status"></div>
-                    <ng-container i18n>Loading...</ng-container>
-                    </td>
-                </tr>
-            }
-            @for (document of documentsInTrash; track document.id) {
-                <tr (click)="toggleSelected(document); $event.stopPropagation();" (mouseleave)="popupPreview.close()" class="data-row fade" [class.show]="show">
-                    <td>
-                    <div class="form-check m-0 ms-2 me-n2">
-                        <input type="checkbox" class="form-check-input" id="{{document.id}}" [checked]="selectedDocuments.has(document.id)" (click)="toggleSelected(document); $event.stopPropagation();">
-                        <label class="form-check-label" for="{{document.id}}"></label>
-                    </div>
-                    </td>
-                    <td scope="row">
-                      {{ document.title }}
-                      <pngx-preview-popup [document]="document" linkClasses="btn btn-sm btn-link" #popupPreview>
-                        <i-bs name="eye"></i-bs>
-                      </pngx-preview-popup>
-                    </td>
-                    <td scope="row" class="d-none d-sm-table-cell" i18n>{{ getDaysRemaining(document) }} days</td>
-                    <td scope="row">
-                    <div class="btn-group d-block d-sm-none">
-                        <div ngbDropdown container="body" class="d-inline-block">
-                        <button type="button" class="btn btn-link" id="actionsMenuMobile" (click)="$event.stopPropagation()" ngbDropdownToggle>
-                            <i-bs name="three-dots-vertical"></i-bs>
-                        </button>
-                        <div ngbDropdownMenu aria-labelledby="actionsMenuMobile">
-                            <button (click)="restore(document)" ngbDropdownItem i18n>Restore</button>
-                            <button (click)="delete(document)" ngbDropdownItem i18n>Delete</button>
-                        </div>
-                        </div>
-                    </div>
-                    <div class="btn-group d-none d-sm-block">
-                        <button class="btn btn-sm btn-outline-secondary" (click)="restore(document); $event.stopPropagation();">
-                            <i-bs width="1em" height="1em" name="arrow-counterclockwise"></i-bs>&nbsp;<ng-container i18n>Restore</ng-container>
-                        </button>
-                        <button class="btn btn-sm btn-outline-danger" (click)="delete(document); $event.stopPropagation();">
-                            <i-bs width="1em" height="1em" name="trash"></i-bs>&nbsp;<ng-container i18n>Delete</ng-container>
-                        </button>
-                    </div>
-                    </td>
-                </tr>
-            }
-        </tbody>
-    </table>
-</div>
-
-@if (!loading) {
-    <div class="d-flex mb-2">
-        <div>
-            <ng-container i18n>{totalDocuments, plural, =1 {One document in trash} other {{{totalDocuments || 0}} total documents in trash}}</ng-container>
-            @if (selectedDocuments.size > 0) {
-                &nbsp;({{selectedDocuments.size}} selected)
-            }
-        </div>
-        @if (documentsInTrash.length > 20) {
-            <ngb-pagination class="ms-auto" [pageSize]="25" [collectionSize]="totalDocuments" [(page)]="page" [maxSize]="5" (pageChange)="reload()" size="sm" aria-label="Pagination"></ngb-pagination>
-        }
-    </div>
-}

src-ui/src/app/components/admin/trash/trash.component.scss

@@ -1,4 +0,0 @@
-// hide caret on mobile dropdown
-.d-block.d-sm-none .dropdown-toggle::after {
-  display: none;
-}

src-ui/src/app/components/admin/trash/trash.component.spec.ts

@@ -1,219 +0,0 @@
-import { ComponentFixture, TestBed } from '@angular/core/testing'
-
-import { HttpClientTestingModule } from '@angular/common/http/testing'
-import { FormsModule, ReactiveFormsModule } from '@angular/forms'
-import { By } from '@angular/platform-browser'
-import { Router } from '@angular/router'
-import {
-  NgbModal,
-  NgbPaginationModule,
-  NgbPopoverModule,
-} from '@ng-bootstrap/ng-bootstrap'
-import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
-import { of, throwError } from 'rxjs'
-import { SafeHtmlPipe } from 'src/app/pipes/safehtml.pipe'
-import { ToastService } from 'src/app/services/toast.service'
-import { TrashService } from 'src/app/services/trash.service'
-import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
-import { PageHeaderComponent } from '../../common/page-header/page-header.component'
-import { TrashComponent } from './trash.component'
-
-const documentsInTrash = [
-  {
-    id: 1,
-    name: 'test1',
-    created: new Date('2023-03-01T10:26:03.093116Z'),
-    deleted_at: new Date('2023-03-01T10:26:03.093116Z'),
-  },
-  {
-    id: 2,
-    name: 'test2',
-    created: new Date('2023-03-01T10:26:03.093116Z'),
-    deleted_at: new Date('2023-03-01T10:26:03.093116Z'),
-  },
-]
-
-describe('TrashComponent', () => {
-  let component: TrashComponent
-  let fixture: ComponentFixture<TrashComponent>
-  let trashService: TrashService
-  let modalService: NgbModal
-  let toastService: ToastService
-  let router: Router
-
-  beforeEach(async () => {
-    await TestBed.configureTestingModule({
-      imports: [
-        HttpClientTestingModule,
-        FormsModule,
-        ReactiveFormsModule,
-        NgbPopoverModule,
-        NgbPaginationModule,
-        NgxBootstrapIconsModule.pick(allIcons),
-        TrashComponent,
-        PageHeaderComponent,
-        ConfirmDialogComponent,
-        SafeHtmlPipe,
-      ],
-    }).compileComponents()
-
-    fixture = TestBed.createComponent(TrashComponent)
-    trashService = TestBed.inject(TrashService)
-    modalService = TestBed.inject(NgbModal)
-    toastService = TestBed.inject(ToastService)
-    router = TestBed.inject(Router)
-    component = fixture.componentInstance
-    fixture.detectChanges()
-  })
-
-  it('should call correct service method on reload', () => {
-    jest.useFakeTimers()
-    const trashSpy = jest.spyOn(trashService, 'getTrash')
-    trashSpy.mockReturnValue(
-      of({
-        count: 2,
-        all: documentsInTrash.map((d) => d.id),
-        results: documentsInTrash,
-      })
-    )
-    component.reload()
-    jest.advanceTimersByTime(100)
-    expect(trashSpy).toHaveBeenCalled()
-    expect(component.documentsInTrash).toEqual(documentsInTrash)
-  })
-
-  it('should support delete document, show error if needed', () => {
-    const trashSpy = jest.spyOn(trashService, 'emptyTrash')
-    let modal
-    modalService.activeInstances.subscribe((instances) => {
-      modal = instances[0]
-    })
-    const toastErrorSpy = jest.spyOn(toastService, 'showError')
-
-    // fail first
-    trashSpy.mockReturnValue(throwError(() => 'Error'))
-    component.delete(documentsInTrash[0])
-    modal.componentInstance.confirmClicked.next()
-    expect(toastErrorSpy).toHaveBeenCalled()
-
-    trashSpy.mockReturnValue(of('OK'))
-    component.delete(documentsInTrash[0])
-    expect(modal).toBeDefined()
-    modal.componentInstance.confirmClicked.next()
-    expect(trashSpy).toHaveBeenCalled()
-  })
-
-  it('should support empty trash, show error if needed', () => {
-    const trashSpy = jest.spyOn(trashService, 'emptyTrash')
-    let modal
-    modalService.activeInstances.subscribe((instances) => {
-      modal = instances[instances.length - 1]
-    })
-    const toastErrorSpy = jest.spyOn(toastService, 'showError')
-
-    // fail first
-    trashSpy.mockReturnValue(throwError(() => 'Error'))
-    component.emptyTrash()
-    modal.componentInstance.confirmClicked.next()
-    expect(toastErrorSpy).toHaveBeenCalled()
-
-    trashSpy.mockReturnValue(of('OK'))
-    component.emptyTrash()
-    expect(modal).toBeDefined()
-    modal.componentInstance.confirmClicked.next()
-    expect(trashSpy).toHaveBeenCalled()
-    modal.close()
-    component.emptyTrash(new Set([1, 2]))
-    modal.componentInstance.confirmClicked.next()
-    expect(trashSpy).toHaveBeenCalledWith([1, 2])
-  })
-
-  it('should support restore document, show error if needed', () => {
-    const restoreSpy = jest.spyOn(trashService, 'restoreDocuments')
-    const reloadSpy = jest.spyOn(component, 'reload')
-    const toastErrorSpy = jest.spyOn(toastService, 'showError')
-
-    // fail first
-    restoreSpy.mockReturnValue(throwError(() => 'Error'))
-    component.restore(documentsInTrash[0])
-    expect(toastErrorSpy).toHaveBeenCalled()
-    expect(reloadSpy).not.toHaveBeenCalled()
-
-    restoreSpy.mockReturnValue(of('OK'))
-    component.restore(documentsInTrash[0])
-    expect(restoreSpy).toHaveBeenCalledWith([documentsInTrash[0].id])
-    expect(reloadSpy).toHaveBeenCalled()
-  })
-
-  it('should support restore all documents, show error if needed', () => {
-    const restoreSpy = jest.spyOn(trashService, 'restoreDocuments')
-    const reloadSpy = jest.spyOn(component, 'reload')
-    const toastErrorSpy = jest.spyOn(toastService, 'showError')
-
-    // fail first
-    restoreSpy.mockReturnValue(throwError(() => 'Error'))
-    component.restoreAll()
-    expect(toastErrorSpy).toHaveBeenCalled()
-    expect(reloadSpy).not.toHaveBeenCalled()
-
-    restoreSpy.mockReturnValue(of('OK'))
-    component.restoreAll()
-    expect(restoreSpy).toHaveBeenCalled()
-    expect(reloadSpy).toHaveBeenCalled()
-    component.restoreAll(new Set([1, 2]))
-    expect(restoreSpy).toHaveBeenCalledWith([1, 2])
-  })
-
-  it('should offer link to restored document', () => {
-    let toasts
-    const navigateSpy = jest.spyOn(router, 'navigate')
-    toastService.getToasts().subscribe((allToasts) => {
-      toasts = [...allToasts]
-    })
-    jest.spyOn(trashService, 'restoreDocuments').mockReturnValue(of('OK'))
-    component.restore(documentsInTrash[0])
-    expect(toasts.length).toEqual(1)
-    toasts[0].action()
-    expect(navigateSpy).toHaveBeenCalledWith([
-      'documents',
-      documentsInTrash[0].id,
-    ])
-  })
-
-  it('should support toggle all items in view', () => {
-    component.documentsInTrash = documentsInTrash
-    expect(component.selectedDocuments.size).toEqual(0)
-    const toggleAllSpy = jest.spyOn(component, 'toggleAll')
-    const checkButton = fixture.debugElement.queryAll(
-      By.css('input.form-check-input')
-    )[0]
-    checkButton.nativeElement.dispatchEvent(new Event('click'))
-    checkButton.nativeElement.checked = true
-    checkButton.nativeElement.dispatchEvent(new Event('click'))
-    expect(toggleAllSpy).toHaveBeenCalled()
-    expect(component.selectedDocuments.size).toEqual(documentsInTrash.length)
-  })
-
-  it('should support toggle item', () => {
-    component.selectedDocuments = new Set([1])
-    component.toggleSelected(documentsInTrash[0])
-    expect(component.selectedDocuments.size).toEqual(0)
-    component.toggleSelected(documentsInTrash[0])
-    expect(component.selectedDocuments.size).toEqual(1)
-  })
-
-  it('should support clear selection', () => {
-    component.selectedDocuments = new Set([1])
-    component.clearSelection()
-    expect(component.selectedDocuments.size).toEqual(0)
-  })
-
-  it('should correctly display days remaining', () => {
-    expect(component.getDaysRemaining(documentsInTrash[0])).toBeLessThan(0)
-    const tenDaysAgo = new Date()
-    tenDaysAgo.setDate(tenDaysAgo.getDate() - 10)
-    expect(
-      component.getDaysRemaining({ deleted_at: tenDaysAgo })
-    ).toBeGreaterThan(0) // 10 days ago but depends on month
-  })
-})

src-ui/src/app/components/admin/trash/trash.component.ts

@@ -1,197 +0,0 @@
-import { Component, OnDestroy } from '@angular/core'
-import { FormsModule, ReactiveFormsModule } from '@angular/forms'
-import { Router } from '@angular/router'
-import {
-  NgbDropdownModule,
-  NgbModal,
-  NgbPaginationModule,
-} from '@ng-bootstrap/ng-bootstrap'
-import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
-import { delay, takeUntil, tap } from 'rxjs'
-import { Document } from 'src/app/data/document'
-import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
-import { SettingsService } from 'src/app/services/settings.service'
-import { ToastService } from 'src/app/services/toast.service'
-import { TrashService } from 'src/app/services/trash.service'
-import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
-import { PageHeaderComponent } from '../../common/page-header/page-header.component'
-import { PreviewPopupComponent } from '../../common/preview-popup/preview-popup.component'
-import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
-
-@Component({
-  selector: 'pngx-trash',
-  templateUrl: './trash.component.html',
-  styleUrl: './trash.component.scss',
-  imports: [
-    PageHeaderComponent,
-    PreviewPopupComponent,
-    FormsModule,
-    ReactiveFormsModule,
-    NgbDropdownModule,
-    NgbPaginationModule,
-    NgxBootstrapIconsModule,
-  ],
-})
-export class TrashComponent
-  extends LoadingComponentWithPermissions
-  implements OnDestroy
-{
-  public documentsInTrash: Document[] = []
-  public selectedDocuments: Set<number> = new Set()
-  public allToggled: boolean = false
-  public page: number = 1
-  public totalDocuments: number
-
-  constructor(
-    private trashService: TrashService,
-    private toastService: ToastService,
-    private modalService: NgbModal,
-    private settingsService: SettingsService,
-    private router: Router
-  ) {
-    super()
-    this.reload()
-  }
-
-  reload() {
-    this.loading = true
-    this.trashService
-      .getTrash(this.page)
-      .pipe(
-        tap((r) => {
-          this.documentsInTrash = r.results
-          this.totalDocuments = r.count
-          this.selectedDocuments.clear()
-          this.loading = false
-        }),
-        delay(100)
-      )
-      .subscribe(() => {
-        this.show = true
-      })
-  }
-
-  delete(document: Document) {
-    let modal = this.modalService.open(ConfirmDialogComponent, {
-      backdrop: 'static',
-    })
-    modal.componentInstance.title = $localize`Confirm delete`
-    modal.componentInstance.messageBold = $localize`This operation will permanently delete this document.`
-    modal.componentInstance.message = $localize`This operation cannot be undone.`
-    modal.componentInstance.btnClass = 'btn-danger'
-    modal.componentInstance.btnCaption = $localize`Delete`
-    modal.componentInstance.confirmClicked
-      .pipe(takeUntil(this.unsubscribeNotifier))
-      .subscribe(() => {
-        modal.componentInstance.buttonsEnabled = false
-        this.trashService.emptyTrash([document.id]).subscribe({
-          next: () => {
-            this.toastService.showInfo($localize`Document deleted`)
-            modal.close()
-            this.reload()
-          },
-          error: (err) => {
-            this.toastService.showError($localize`Error deleting document`, err)
-            modal.close()
-          },
-        })
-      })
-  }
-
-  emptyTrash(documents?: Set<number>) {
-    let modal = this.modalService.open(ConfirmDialogComponent, {
-      backdrop: 'static',
-    })
-    modal.componentInstance.title = $localize`Confirm delete`
-    modal.componentInstance.messageBold = documents
-      ? $localize`This operation will permanently delete the selected documents.`
-      : $localize`This operation will permanently delete all documents in the trash.`
-    modal.componentInstance.message = $localize`This operation cannot be undone.`
-    modal.componentInstance.btnClass = 'btn-danger'
-    modal.componentInstance.btnCaption = $localize`Delete`
-    modal.componentInstance.confirmClicked
-      .pipe(takeUntil(this.unsubscribeNotifier))
-      .subscribe(() => {
-        this.trashService
-          .emptyTrash(documents ? Array.from(documents) : null)
-          .subscribe({
-            next: () => {
-              this.toastService.showInfo($localize`Document(s) deleted`)
-              this.allToggled = false
-              modal.close()
-              this.reload()
-            },
-            error: (err) => {
-              this.toastService.showError(
-                $localize`Error deleting document(s)`,
-                err
-              )
-              modal.close()
-            },
-          })
-      })
-  }
-
-  restore(document: Document) {
-    this.trashService.restoreDocuments([document.id]).subscribe({
-      next: () => {
-        this.toastService.show({
-          content: $localize`Document restored`,
-          delay: 5000,
-          actionName: $localize`Open document`,
-          action: () => {
-            this.router.navigate(['documents', document.id])
-          },
-        })
-        this.reload()
-      },
-      error: (err) => {
-        this.toastService.showError($localize`Error restoring document`, err)
-      },
-    })
-  }
-
-  restoreAll(documents: Set<number> = null) {
-    this.trashService
-      .restoreDocuments(documents ? Array.from(documents) : null)
-      .subscribe({
-        next: () => {
-          this.toastService.showInfo($localize`Document(s) restored`)
-          this.allToggled = false
-          this.reload()
-        },
-        error: (err) => {
-          this.toastService.showError(
-            $localize`Error restoring document(s)`,
-            err
-          )
-        },
-      })
-  }
-
-  toggleAll(event: PointerEvent) {
-    if ((event.target as HTMLInputElement).checked) {
-      this.selectedDocuments = new Set(this.documentsInTrash.map((t) => t.id))
-    } else {
-      this.clearSelection()
-    }
-  }
-
-  toggleSelected(object: Document) {
-    this.selectedDocuments.has(object.id)
-      ? this.selectedDocuments.delete(object.id)
-      : this.selectedDocuments.add(object.id)
-  }
-
-  clearSelection() {
-    this.allToggled = false
-    this.selectedDocuments.clear()
-  }
-
-  getDaysRemaining(document: Document): number {
-    const delay = this.settingsService.get(SETTINGS_KEYS.EMPTY_TRASH_DELAY)
-    const diff = new Date().getTime() - new Date(document.deleted_at).getTime()
-    const days = Math.ceil(diff / (1000 * 3600 * 24))
-    return delay - days
-  }
-}

src-ui/src/app/components/admin/users-groups/users-groups.component.spec.ts

@@ -1,19 +1,27 @@
 import { DatePipe } from '@angular/common'
-import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
-import { provideHttpClientTesting } from '@angular/common/http/testing'
+import { HttpClientTestingModule } from '@angular/common/http/testing'
 import {
   ComponentFixture,
   TestBed,
   fakeAsync,
   tick,
 } from '@angular/core/testing'
-import { NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap'
-import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
-import { of, throwError } from 'rxjs'
-import { Group } from 'src/app/data/group'
-import { User } from 'src/app/data/user'
+import { FormsModule, ReactiveFormsModule } from '@angular/forms'
+import { RouterTestingModule } from '@angular/router/testing'
+import {
+  NgbModule,
+  NgbAlertModule,
+  NgbModal,
+  NgbModalRef,
+} from '@ng-bootstrap/ng-bootstrap'
+import { NgSelectModule } from '@ng-select/ng-select'
+import { throwError, of } from 'rxjs'
+import { routes } from 'src/app/app-routing.module'
+import { IfOwnerDirective } from 'src/app/directives/if-owner.directive'
+import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
 import { PermissionsGuard } from 'src/app/guards/permissions.guard'
 import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
+import { SafeHtmlPipe } from 'src/app/pipes/safehtml.pipe'
 import { PermissionsService } from 'src/app/services/permissions.service'
 import { GroupService } from 'src/app/services/rest/group.service'
 import { UserService } from 'src/app/services/rest/user.service'
@@ -22,7 +30,20 @@ import { ToastService } from 'src/app/services/toast.service'
 import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
 import { GroupEditDialogComponent } from '../../common/edit-dialog/group-edit-dialog/group-edit-dialog.component'
 import { UserEditDialogComponent } from '../../common/edit-dialog/user-edit-dialog/user-edit-dialog.component'
+import { CheckComponent } from '../../common/input/check/check.component'
+import { NumberComponent } from '../../common/input/number/number.component'
+import { PasswordComponent } from '../../common/input/password/password.component'
+import { PermissionsGroupComponent } from '../../common/input/permissions/permissions-group/permissions-group.component'
+import { PermissionsUserComponent } from '../../common/input/permissions/permissions-user/permissions-user.component'
+import { SelectComponent } from '../../common/input/select/select.component'
+import { TagsComponent } from '../../common/input/tags/tags.component'
+import { TextComponent } from '../../common/input/text/text.component'
+import { PageHeaderComponent } from '../../common/page-header/page-header.component'
+import { SettingsComponent } from '../settings/settings.component'
 import { UsersAndGroupsComponent } from './users-groups.component'
+import { User } from 'src/app/data/user'
+import { Group } from 'src/app/data/group'
+import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
 
 const users = [
   { id: 1, username: 'user1', is_superuser: false },
@@ -45,13 +66,34 @@ describe('UsersAndGroupsComponent', () => {
 
   beforeEach(() => {
     TestBed.configureTestingModule({
-      imports: [NgxBootstrapIconsModule.pick(allIcons)],
-      providers: [
+      declarations: [
+        UsersAndGroupsComponent,
+        SettingsComponent,
+        PageHeaderComponent,
+        IfPermissionsDirective,
         CustomDatePipe,
-        DatePipe,
-        PermissionsGuard,
-        provideHttpClient(withInterceptorsFromDi()),
-        provideHttpClientTesting(),
+        ConfirmDialogComponent,
+        CheckComponent,
+        SafeHtmlPipe,
+        SelectComponent,
+        TextComponent,
+        PasswordComponent,
+        NumberComponent,
+        TagsComponent,
+        PermissionsUserComponent,
+        PermissionsGroupComponent,
+        IfOwnerDirective,
+      ],
+      providers: [CustomDatePipe, DatePipe, PermissionsGuard],
+      imports: [
+        NgbModule,
+        HttpClientTestingModule,
+        RouterTestingModule.withRoutes(routes),
+        FormsModule,
+        ReactiveFormsModule,
+        NgbAlertModule,
+        NgSelectModule,
+        NgxBootstrapIconsModule.pick(allIcons),
       ],
     }).compileComponents()
     fixture = TestBed.createComponent(UsersAndGroupsComponent)

src-ui/src/app/components/admin/users-groups/users-groups.component.ts

@@ -1,31 +1,23 @@
 import { Component, OnDestroy, OnInit } from '@angular/core'
 import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
-import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
 import { Subject, first, takeUntil } from 'rxjs'
 import { Group } from 'src/app/data/group'
 import { User } from 'src/app/data/user'
-import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
 import { PermissionsService } from 'src/app/services/permissions.service'
 import { GroupService } from 'src/app/services/rest/group.service'
 import { UserService } from 'src/app/services/rest/user.service'
-import { SettingsService } from 'src/app/services/settings.service'
 import { ToastService } from 'src/app/services/toast.service'
 import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
 import { EditDialogMode } from '../../common/edit-dialog/edit-dialog.component'
 import { GroupEditDialogComponent } from '../../common/edit-dialog/group-edit-dialog/group-edit-dialog.component'
 import { UserEditDialogComponent } from '../../common/edit-dialog/user-edit-dialog/user-edit-dialog.component'
-import { PageHeaderComponent } from '../../common/page-header/page-header.component'
 import { ComponentWithPermissions } from '../../with-permissions/with-permissions.component'
+import { SettingsService } from 'src/app/services/settings.service'
 
 @Component({
   selector: 'pngx-users-groups',
   templateUrl: './users-groups.component.html',
   styleUrls: ['./users-groups.component.scss'],
-  imports: [
-    PageHeaderComponent,
-    IfPermissionsDirective,
-    NgxBootstrapIconsModule,
-  ],
 })
 export class UsersAndGroupsComponent
   extends ComponentWithPermissions