Merge branch 'dev'

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

.codecov.yml

@@ -14,6 +14,9 @@ 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:
@@ -22,7 +25,12 @@ coverage:
         threshold: 1%
     patch:
       default:
-        # For the changed lines only, target 75% covered, but
-        # allow as low as 50%
-        target: 75%
+        # For the changed lines only, target 100% covered, but
+        # allow as low as 75%
+        target: 100%
         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
+ignore-words-list = criterias,afterall,valeu,ureue,equest,ure,assertIn

.devcontainer/Dockerfile

@@ -0,0 +1,180 @@
+# 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/README.md

@@ -0,0 +1,117 @@
+# Paperless NGX Development Environment
+
+## Overview
+
+Welcome to the Paperless NGX development environment! This setup uses VSCode DevContainers to provide a consistent and seamless development experience.
+
+### What are DevContainers?
+
+DevContainers are a feature in VSCode that allows you to develop within a Docker container. This ensures that your development environment is consistent across different machines and setups. By defining a containerized environment, you can eliminate the "works on my machine" problem.
+
+### Advantages of DevContainers
+
+- **Consistency**: Same environment for all developers.
+- **Isolation**: Separate development environment from your local machine.
+- **Reproducibility**: Easily recreate the environment on any machine.
+- **Pre-configured Tools**: Include all necessary tools and dependencies in the container.
+
+## DevContainer Setup
+
+The DevContainer configuration provides up all the necessary services for Paperless NGX, including:
+
+- Redis
+- Gotenberg
+- Tika
+
+Data is stored using Docker volumes to ensure persistence across container restarts.
+
+## Configuration Files
+
+The setup includes debugging configurations (`launch.json`) and tasks (`tasks.json`) to help you manage and debug various parts of the project:
+
+- **Backend Debugging:**
+  - `manage.py runserver`
+  - `manage.py document-consumer`
+  - `celery`
+- **Maintenance Tasks:**
+  - Create superuser
+  - Run migrations
+  - Recreate virtual environment (`.venv` with pipenv)
+  - Compile frontend assets
+
+## Getting Started
+
+### Step 1: Running the DevContainer
+
+To start the DevContainer:
+
+1. Open VSCode.
+2. Open the project folder.
+3. Open the command palette:
+   - **Windows/Linux**: `Ctrl+Shift+P`
+   - **Mac**: `Cmd+Shift+P`
+4. Type and select `Dev Containers: Rebuild and Reopen in Container`.
+
+VSCode will build and start the DevContainer environment.
+
+### Step 2: Initial Setup
+
+Once the DevContainer is up and running, perform the following steps:
+
+1. **Compile Frontend Assets**:
+
+   - Open the command palette:
+     - **Windows/Linux**: `Ctrl+Shift+P`
+     - **Mac**: `Cmd+Shift+P`
+   - Select `Tasks: Run Task`.
+   - Choose `Frontend Compile`.
+
+2. **Run Database Migrations**:
+
+   - Open the command palette:
+     - **Windows/Linux**: `Ctrl+Shift+P`
+     - **Mac**: `Cmd+Shift+P`
+   - Select `Tasks: Run Task`.
+   - Choose `Migrate Database`.
+
+3. **Create Superuser**:
+   - Open the command palette:
+     - **Windows/Linux**: `Ctrl+Shift+P`
+     - **Mac**: `Cmd+Shift+P`
+   - Select `Tasks: Run Task`.
+   - Choose `Create Superuser`.
+
+### Debugging and Running Services
+
+You can start and debug backend services either as debugging sessions via `launch.json` or as tasks.
+
+#### Using `launch.json`:
+
+1. Press `F5` or go to the **Run and Debug** view in VSCode.
+2. Select the desired configuration:
+   - `Runserver`
+   - `Document Consumer`
+   - `Celery`
+
+#### Using Tasks:
+
+1. Open the command palette:
+   - **Windows/Linux**: `Ctrl+Shift+P`
+   - **Mac**: `Cmd+Shift+P`
+2. Select `Tasks: Run Task`.
+3. Choose the desired task:
+   - `Runserver`
+   - `Document Consumer`
+   - `Celery`
+
+### Additional Maintenance Tasks
+
+Additional tasks are available for common maintenance operations:
+
+- **Recreate .venv**: For setting up the virtual environment using pipenv.
+- **Migrate Database**: To apply database migrations.
+- **Create Superuser**: To create an admin user for the application.
+
+## Let's Get Started!
+
+Follow the steps above to get your development environment up and running. Happy coding!

.devcontainer/devcontainer.json

@@ -0,0 +1,16 @@
+{
+    "name": "Paperless Development",
+    "dockerComposeFile": "docker-compose.devcontainer.sqlite-tika.yml",
+    "service": "paperless-development",
+    "workspaceFolder": "/usr/src/paperless/paperless-ngx",
+    "postCreateCommand": "/bin/bash -c pre-commit install && pipenv install --dev",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+              "mhutchie.git-graph",
+              "ms-python.python"
+            ]
+        }
+    },
+    "remoteUser": "paperless"
+  }

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

@@ -0,0 +1,84 @@
+# 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 # Pipenv environment persisted in volume
+      - /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
+    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:
+  data:
+  media:
+  redisdata:
+  pipenv:

.devcontainer/vscode/launch.json

@@ -0,0 +1,43 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "manage.py runserver",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/src/manage.py",
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "args": ["runserver"],
+            "django": true
+        },
+        {
+            "name": "manage.py document_consumer",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/src/manage.py",
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "args": ["document_consumer"],
+            "django": true
+        },
+        {
+            "name": "celery",
+            "type": "python",
+            "cwd": "${workspaceFolder}/src",
+            "request": "launch",
+            "module": "celery",
+            "console": "integratedTerminal",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}/src"
+              },
+            "args": [
+                "-A",
+                "paperless",
+                "worker",
+                "-l",
+                "DEBUG"
+            ]
+        }
+    ]
+}

.devcontainer/vscode/settings.json

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

.devcontainer/vscode/tasks.json

@@ -0,0 +1,136 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+	{
+		"label": "manage.py document_consumer",
+		"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": "manage.py runserver",
+			"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",
+		"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: manage.py createsuperuser",
+		"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": "compile frontend",
+		"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": "Maintenance: recreate .venv",
+		"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": "Celery Worker",
+		"type": "shell",
+		"command": "pipenv run celery --app paperless worker -l DEBUG",
+		"group": {
+		  "kind": "build",
+		  "isDefault": true
+		},
+		"presentation": {
+			"echo": true,
+			"reveal": "always",
+			"focus": true,
+			"panel": "shared",
+			"showReuseMessage": false,
+			"clear": true,
+			"revealProblems": "onProblem"
+		},
+		"options": {
+			"cwd": "${workspaceFolder}/src"
+		}
+	  }
+	]
+  }

.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 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
+        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
   - type: markdown
     attributes:
       value: |
@@ -86,22 +86,23 @@ 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: input
+  - type: textarea
     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:
@@ -109,6 +110,8 @@ 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,7 +53,6 @@ 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: "2023.12.1"
+  DEFAULT_PIP_ENV_VERSION: "2024.0.3"
   # This is the default version of Python to use in most steps which aren't specific
-  DEFAULT_PYTHON_VERSION: "3.10"
+  DEFAULT_PYTHON_VERSION: "3.11"
 
 jobs:
   pre-commit:
@@ -100,7 +100,7 @@ jobs:
       - pre-commit
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11']
+        python-version: ['3.10', '3.11', '3.12']
       fail-fast: false
     steps:
       -
@@ -260,7 +260,7 @@ jobs:
           retention-days: 7
 
   tests-coverage-upload:
-    name: "Upload Coverage"
+    name: "Upload to Codecov"
     runs-on: ubuntu-22.04
     needs:
       - tests-backend
@@ -306,6 +306,30 @@ jobs:
           # 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 }}
@@ -398,7 +422,7 @@ jobs:
           password: ${{ secrets.QUAY_ROBOT_TOKEN }}
       -
         name: Build and push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: ./Dockerfile
@@ -406,6 +430,8 @@ 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: |
@@ -456,12 +482,6 @@ 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: |
@@ -629,7 +649,9 @@ 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|@(.+?) \(\[#|[@\1](https://github.com/\1) ([#|ig' changelog-new.md
+          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
           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

@@ -33,7 +33,7 @@ jobs:
       -
         name: Clean temporary images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/ephemeral@v0.6.0
+        uses: stumpylog/image-cleaner-action/ephemeral@v0.8.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "${{ github.repository_owner }}"
@@ -61,7 +61,7 @@ jobs:
       -
         name: Clean untagged images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/untagged@v0.6.0
+        uses: stumpylog/image-cleaner-action/untagged@v0.8.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "${{ github.repository_owner }}"

.github/workflows/crowdin.yml

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

.github/workflows/repo-maintenance.yml

@@ -16,13 +16,14 @@ concurrency:
 jobs:
   stale:
     name: 'Stale'
+    if: github.repository_owner == 'paperless-ngx'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/stale@v9
         with:
           days-before-stale: 7
           days-before-close: 14
-          any-of-labels: 'cant-reproduce,not a bug'
+          any-of-labels: 'stale,cant-reproduce,not a bug'
           stale-issue-label: stale
           stale-pr-label: stale
           stale-issue-message: >
@@ -31,6 +32,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-latest
     steps:
       - uses: dessant/lock-threads@v5
@@ -56,6 +58,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-latest
     steps:
       - uses: actions/github-script@v7
@@ -112,6 +115,7 @@ jobs:
             }
   close-outdated-discussions:
     name: 'Close Outdated Discussions'
+    if: github.repository_owner == 'paperless-ngx'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/github-script@v7
@@ -203,6 +207,7 @@ jobs:
             }
   close-unsupported-feature-requests:
     name: 'Close Unsupported Feature Requests'
+    if: github.repository_owner == 'paperless-ngx'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/github-script@v7
@@ -212,15 +217,20 @@ 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 = 10;
+            const CUTOFF_2_COUNT = 20;
+            const CUTOFF_3_DAYS = 730;
+            const CUTOFF_3_COUNT = 40;
 
             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!,
@@ -250,9 +260,12 @@ jobs:
             const result = await github.graphql(query, variables);
 
             for (const discussion of result.repository.discussions.nodes) {
-              const discussionDate = new Date(discussion.updatedAt);
-              if ((discussionDate < cutoff1Date && discussion.upvoteCount < CUTOFF_1_COUNT) ||
-                  (discussionDate < cutoff2Date && discussion.upvoteCount < CUTOFF_2_COUNT)) {
+              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)) {
                 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,6 +22,7 @@ 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
@@ -65,6 +66,8 @@ target/
 .vscode
 /src-ui/.vscode
 /docs/.vscode
+.vscode-server
+*CommandMarker
 
 # Other stuff that doesn't belong
 .virtualenv

.pre-commit-config.yaml

@@ -29,15 +29,16 @@ repos:
       - id: check-case-conflict
       - id: detect-private-key
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.3.0
     hooks:
       - id: codespell
         exclude: "(^src-ui/src/locale/)|(^src-ui/e2e/)|(^src/paperless_mail/tests/samples/)"
         exclude_types:
           - pofile
           - json
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: 'v3.1.0'
+  # See https://github.com/prettier/prettier/issues/15742 for the fork reason
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: 'v3.3.3'
     hooks:
       - id: prettier
         types_or:
@@ -47,13 +48,10 @@ repos:
         exclude: "(^Pipfile\\.lock$)"
   # Python hooks
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.4.2'
+    rev: 'v0.6.8'
     hooks:
       - id: ruff
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.4.2
-    hooks:
-      - id: black
+      - id: ruff-format
   # Dockerfile hooks
   - repo: https://github.com/AleksaC/hadolint-py
     rev: v2.12.0.3
@@ -64,6 +62,8 @@ repos:
     rev: v6.2.1
     hooks:
       - id: beautysh
+        additional_dependencies:
+          - setuptools
         args:
           - "--tab"
   - repo: https://github.com/shellcheck-py/shellcheck-py

.prettierrc

@@ -7,9 +7,9 @@
     "trailingComma": "es5",
     "overrides": [
         {
-            "files": ["index.md", "administration.md"],
+            "files": ["docs/*.md"],
             "options": {
-                "tabWidth": 4
+                "tabWidth": 4,
             }
         }
     ]

.python-version

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

.ruff.toml

@@ -2,7 +2,7 @@ fix = true
 line-length = 88
 respect-gitignore = true
 src = ["src"]
-target-version = "py39"
+target-version = "py310"
 output-format = "grouped"
 show-fixes = 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, socio-economic status,
+identity and expression, level of experience, education, socioeconomic 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.9 - 3.11. We format Python code with [Black](https://github.com/psf/black).
+Paperless supports python 3.10 - 3.12 at this time. We format Python code with [ruff](https://docs.astral.sh/ruff/formatter/).
 
 ## 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: 5 "up-votes" after 180 days of inactivity or 10 "up-votes" after 365 days.
+- 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.
 
 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,6 +13,16 @@ 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
 
@@ -21,7 +31,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.11-alpine as pipenv-base
+FROM --platform=$BUILDPLATFORM docker.io/python:3.12-alpine AS pipenv-base
 
 WORKDIR /usr/src/pipenv
 
@@ -29,7 +39,7 @@ COPY Pipfile* ./
 
 RUN set -eux \
   && echo "Installing pipenv" \
-    && python3 -m pip install --no-cache-dir --upgrade pipenv==2023.12.1 \
+    && python3 -m pip install --no-cache-dir --upgrade pipenv==2024.0.3 \
   && echo "Generating requirement.txt" \
     && pipenv requirements > requirements.txt
 
@@ -37,7 +47,7 @@ RUN set -eux \
 # Purpose: The final image
 # Comments:
 #  - Don't leave anything extra in here
-FROM docker.io/python:3.11-slim-bookworm as main-app
+FROM docker.io/python:3.12-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/"
@@ -53,7 +63,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.02.1
+ARG GS_VERSION=10.03.1
 
 # Set Python environment variables
 ENV PYTHONDONTWRITEBYTECODE=1 \
@@ -83,7 +93,6 @@ ARG RUNTIME_PACKAGES="\
   icc-profiles-free \
   imagemagick \
   # PostgreSQL
-  libpq5 \
   postgresql-client \
   # MySQL / MariaDB
   mariadb-client \
@@ -129,17 +138,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-2_${TARGETARCH}.deb \
+          --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-2_${TARGETARCH}.deb \
+          --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-2_all.deb \
+          --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-2_all.deb \
-        && dpkg --install ./libgs10_${GS_VERSION}.dfsg-2_${TARGETARCH}.deb \
-        && dpkg --install ./ghostscript_${GS_VERSION}.dfsg-2_${TARGETARCH}.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 \
@@ -223,19 +232,22 @@ 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" \
-    && 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 \
+    && curl --fail --silent --show-error --location \
+    --output psycopg_c-3.2.2-cp312-cp312-linux_x86_64.whl \
+    https://github.com/paperless-ngx/builder/releases/download/psycopg-3.2.2/psycopg_c-3.2.2-cp312-cp312-linux_x86_64.whl \
+    && curl --fail --silent --show-error --location \
+    --output psycopg_c-3.2.2-cp312-cp312-linux_aarch64.whl  \
+    https://github.com/paperless-ngx/builder/releases/download/psycopg-3.2.2/psycopg_c-3.2.2-cp312-cp312-linux_aarch64.whl \
+    && python3 -m pip install --default-timeout=1000 --find-links . --requirement requirements.txt \
   && 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 \
+    && python3 -W ignore::RuntimeWarning -m nltk.downloader -d "/usr/share/nltk_data" punkt_tab \
   && 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/* \
@@ -259,6 +271,8 @@ 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,17 +7,18 @@ name = "pypi"
 dateparser = "~=1.2"
 # WARNING: django does not use semver.
 #          Only patch versions are guaranteed to not introduce breaking changes.
-django = "~=4.2.11"
+django = "~=5.1.1"
 django-allauth = {extras = ["socialaccount"], version = "*"}
 django-auditlog = "*"
 django-celery-results = "*"
 django-compression-middleware = "*"
 django-cors-headers = "*"
 django-extensions = "*"
-django-filter = "~=24.2"
+django-filter = "~=24.3"
 django-guardian = "*"
 django-multiselectfield = "*"
-djangorestframework = "==3.14.0"
+django-soft-delete = "*"
+djangorestframework = "==3.15.2"
 djangorestframework-guardian = "*"
 drf-writable-nested = "*"
 bleach = "*"
@@ -29,15 +30,17 @@ filelock = "*"
 flower = "*"
 gotenberg-client = "*"
 gunicorn = "*"
+httpx-oauth = "*"
 imap-tools = "*"
 inotifyrecursive = "~=0.3"
+jinja2 = "~=3.1"
 langdetect = "*"
 mysqlclient = "*"
 nltk = "*"
-ocrmypdf = "~=15.4"
+ocrmypdf = "~=16.5"
 pathvalidate = "*"
 pdf2image = "*"
-psycopg2 = "*"
+psycopg = {version = "*", extras = ["c"]}
 python-dateutil = "*"
 python-dotenv = "*"
 python-gnupg = "*"
@@ -46,23 +49,24 @@ python-magic = "*"
 pyzbar = "*"
 rapidfuzz = "*"
 redis = {extras = ["hiredis"], version = "*"}
-scikit-learn = "~=1.4"
+scikit-learn = "~=1.5"
 setproctitle = "*"
 tika-client = "*"
 tqdm = "*"
+# See https://github.com/paperless-ngx/paperless-ngx/issues/5494
 uvicorn = {extras = ["standard"], version = "==0.25.0"}
 watchdog = "~=4.0"
-whitenoise = "~=6.6"
-whoosh="~=2.7"
+whitenoise = "~=6.8"
+whoosh = "~=2.7"
 zxing-cpp = {version = "*", platform_machine = "== 'x86_64'"}
 
+
 [dev-packages]
 # Linting
-black = "*"
 pre-commit = "*"
 ruff = "*"
-# Testing
 factory-boy = "*"
+# Testing
 pytest = "*"
 pytest-cov = "*"
 pytest-django = "*"
@@ -70,6 +74,7 @@ pytest-httpx = "*"
 pytest-env = "*"
 pytest-sugar = "*"
 pytest-xdist = "*"
+pytest-mock = "*"
 pytest-rerunfailures = "*"
 imagehash = "*"
 daphne = "*"
@@ -92,5 +97,4 @@ types-tqdm = "*"
 types-Markdown = "*"
 types-Pygments = "*"
 types-colorama = "*"
-types-psycopg2 = "*"
 types-setuptools = "*"

README.md

@@ -37,7 +37,7 @@ Thanks to the generous folks at [DigitalOcean](https://m.do.co/c/8d70b916d462),
   <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_black_.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">
       <img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_black_.svg" width="140px">
     </picture>
   </a>

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

@@ -3,10 +3,9 @@
 # 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:7.10
+    image: docker.io/gotenberg/gotenberg:8.7
     hostname: gotenberg
     container_name: gotenberg
     network_mode: host
@@ -20,7 +19,7 @@ services:
       - "--log-level=warn"
       - "--log-format=text"
   tika:
-    image: ghcr.io/paperless-ngx/tika:latest
+    image: docker.io/apache/tika:latest
     hostname: tika
     container_name: tika
     network_mode: host

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

@@ -30,7 +30,6 @@
 # For more extensive installation and update instructions, refer to the
 # documentation.
 
-version: "3.4"
 services:
   broker:
     image: docker.io/library/redis:7
@@ -39,7 +38,7 @@ services:
       - redisdata:/data
 
   db:
-    image: docker.io/library/mariadb:10
+    image: docker.io/library/mariadb:11
     restart: unless-stopped
     volumes:
       - dbdata:/var/lib/mysql
@@ -78,7 +77,7 @@ services:
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
 
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:7.10
+    image: docker.io/gotenberg/gotenberg:8.7
     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.
@@ -88,7 +87,7 @@ services:
       - "--chromium-allow-list=file:///tmp/.*"
 
   tika:
-    image: ghcr.io/paperless-ngx/tika:latest
+    image: docker.io/apache/tika:latest
     restart: unless-stopped
 
 volumes:

docker/compose/docker-compose.mariadb.yml

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

docker/compose/docker-compose.portainer.yml

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

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

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

docker/compose/docker-compose.postgres.yml

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

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

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

docker/compose/docker-compose.sqlite.yml

@@ -23,7 +23,6 @@
 # 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 -o -u "${usermap_new_uid}" paperless
-		groupmod -o -g "${usermap_new_gid}" paperless
+		usermod --non-unique --uid "${usermap_new_uid}" paperless
+		groupmod --non-unique --gid "${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 -A "${custom_script_dir}" 2>/dev/null)" ]; then
+		if [ -n "$(/bin/ls --almost-all "${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 "${dir}"
+			mkdir --parents --verbose "${dir}"
 		fi
 	done
 
 	local -r tmp_dir="${PAPERLESS_SCRATCH_DIR:=/tmp/paperless}"
 	echo "Creating directory scratch directory ${tmp_dir}"
-	mkdir --parents "${tmp_dir}"
+	mkdir --parents --verbose "${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 paperless:paperless {} +
+		find "${dir}" -not \( -user paperless -and -group paperless \) -exec chown --changes paperless:paperless {} +
 	done
 	set -e
 
@@ -122,33 +122,44 @@ 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 -s "$pkg" &>/dev/null; then
+		if dpkg --status "$pkg" &>/dev/null; then
 			echo "Package $pkg already installed!"
 			continue
-		fi
-
-		if ! apt-cache show "$pkg" &>/dev/null; then
-			echo "Package $pkg not found! :("
-			continue
-		fi
-
-		echo "Installing package $pkg..."
-		if ! apt-get -y install "$pkg" &>/dev/null; then
-			echo "Could not install $pkg"
-			exit 1
+		else
+			to_install+=("$pkg")
 		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 -u)" == "$(id -u paperless)" ]; then
+if [ "$(id --user)" == "$(id --user 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 -h ${host} -p ${port})" ]; do
+	while [ ! "$(pg_isready --host ${host} --port ${port})" ]; do
 
 		if [ $attempt_num -eq $max_attempts ]; then
 			echo "Unable to connect to database."
@@ -25,6 +25,7 @@ wait_for_postgres() {
 		attempt_num=$(("$attempt_num" + 1))
 		sleep 5
 	done
+	echo "Connected to PostgreSQL"
 }
 
 wait_for_mariadb() {
@@ -51,6 +52,7 @@ 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" ]]; then
+		if [[ ${env_name} == "PAPERLESS_OCR_SKIP_ARCHIVE_FILE" || ${env_name} == "PAPERLESS_MODEL_FILE" ]]; then
 			continue
 		fi
 		# Extract the value of the environment

docker/install_management_commands.sh

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

docker/wait-for-redis.py

@@ -4,6 +4,7 @@ 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,6 +19,8 @@ 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
@@ -185,34 +187,12 @@ For PostgreSQL, refer to [Upgrading a PostgreSQL Cluster](https://www.postgresql
 
 For MariaDB, refer to [Upgrading MariaDB](https://mariadb.com/kb/en/upgrading/)
 
-## Downgrading Paperless {#downgrade-paperless}
+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.
 
-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.
+!!! warning
 
-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.
+    You should not change any settings, especially paths, when doing this or there is a
+    risk of data loss
 
 ## Management utilities {#management-commands}
 
@@ -269,6 +249,9 @@ 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
@@ -327,6 +310,16 @@ 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
@@ -341,15 +334,23 @@ 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.
+Note that .zip files (as can be generated from the exporter) are not supported. You must unzip them into
+the target directory first.
 
 !!! note
 
@@ -359,6 +360,7 @@ Note that .zip files (as can be generated from the exporter) are not supported.
 !!! 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}
 
@@ -586,7 +588,7 @@ Enabling encryption is no longer supported.
 
 Basic usage to disable encryption of your document store:
 
-(Note: If [`PAPERLESS_PASSPHRASE`](configuration.md#PAPERLESS_PASSPHRASE) isn't set already, you need to specify
+(Note: If `PAPERLESS_PASSPHRASE` isn't set already, you need to specify
 it here)
 
 ```

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://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).
+-   **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).
 
 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,6 +187,7 @@ 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                  |
@@ -241,12 +242,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}
 
@@ -264,7 +265,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:
@@ -297,39 +298,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
+### Placeholders {#filename-format-variables}
 
-Paperless provides the following placeholders within filenames:
+Paperless provides the following variables for use 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
 
@@ -337,6 +338,11 @@ Paperless provides the following placeholders 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
@@ -362,7 +368,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.
@@ -375,10 +381,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:
 
@@ -389,8 +395,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
@@ -417,6 +423,97 @@ 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
@@ -435,15 +532,15 @@ installation, you can use volumes to accomplish this:
 
 ```yaml
 services:
-  # ...
-  webserver:
-    environment:
-      - PAPERLESS_ENABLE_FLOWER
-    ports:
-      - 5555:5555 # (2)!
     # ...
-    volumes:
-      - /path/to/my/flowerconfig.py:/usr/src/paperless/src/paperless/flowerconfig.py:ro # (1)!
+    webserver:
+        environment:
+            - PAPERLESS_ENABLE_FLOWER
+        ports:
+            - 5555:5555 # (2)!
+        # ...
+        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.
@@ -474,11 +571,11 @@ For example, using Docker Compose:
 
 ```yaml
 services:
-  # ...
-  webserver:
     # ...
-    volumes:
-      - /path/to/my/scripts:/custom-cont-init.d:ro # (1)!
+    webserver:
+        # ...
+        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
@@ -526,16 +623,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.
@@ -687,4 +784,59 @@ 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.
+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.extra` socket by invoking
+
+```
+gpgconf --list-dir agent-extra-socket
+```
+
+on your host. A possible output is `~/.gnupg/S.gpg-agent.extra`.
+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.extra 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
+```

docs/api.md

@@ -8,23 +8,23 @@ 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](#posting-documents-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](#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).
 
 All of these endpoints except for the logging endpoint allow you to
 fetch (and edit and delete where appropriate) individual objects by
@@ -33,31 +33,32 @@ 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.
-- `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.
+-   `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 }`
 
 !!! note
 
@@ -68,11 +69,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
@@ -106,30 +107,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"
+    }
 ]
 ```
 
@@ -139,9 +140,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
 
@@ -227,20 +228,14 @@ 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:
 
@@ -273,12 +268,57 @@ 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.
+-   `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.
 
 ### `/api/search/autocomplete/`
 
@@ -286,8 +326,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
@@ -311,19 +351,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.
+-   `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
@@ -389,41 +429,50 @@ 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
-- `redo_ocr`
-  - 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.
-- `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
+-   `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.
 
 ### Objects
 
@@ -445,16 +494,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:
@@ -491,19 +540,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.
+-   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: 400px) {
+@media (min-width: 768px) {
     .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/getting-started/#securing-redis).
+    Instance](https://redis.io/docs/latest/operate/oss_and_stack/management/security).
 
     Defaults to `redis://localhost:6379`.
 
@@ -219,10 +219,10 @@ database, classification model, etc).
 
     Defaults to "../data/", relative to the "src" directory.
 
-#### [`PAPERLESS_TRASH_DIR=<path>`](#PAPERLESS_TRASH_DIR) {#PAPERLESS_TRASH_DIR}
+#### [`PAPERLESS_EMPTY_TRASH_DIR=<path>`](#PAPERLESS_EMPTY_TRASH_DIR) {#PAPERLESS_EMPTY_TRASH_DIR}
 
-: Instead of removing deleted documents, they are moved to this
-directory.
+: 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.
 
     This must be writeable by the user running paperless. When running
     inside docker, ensure that this path is within a permanent volume
@@ -230,7 +230,9 @@ directory.
 
     Note that the directory must exist prior to using this setting.
 
-    Defaults to empty (i.e. really delete documents).
+    Defaults to empty (i.e. really delete files).
+
+    This setting was previously named PAPERLESS_TRASH_DIR.
 
 #### [`PAPERLESS_MEDIA_ROOT=<path>`](#PAPERLESS_MEDIA_ROOT) {#PAPERLESS_MEDIA_ROOT}
 
@@ -288,6 +290,12 @@ 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}
@@ -586,15 +594,32 @@ 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. 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).
+: 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.
 
     Defaults to False
 
 #### [`PAPERLESS_ACCOUNT_SESSION_REMEMBER=<bool>`](#PAPERLESS_ACCOUNT_SESSION_REMEMBER) {#PAPERLESS_ACCOUNT_SESSION_REMEMBER}
 
-: See the corresponding
+: If false, sessions will expire at browser close, if true will use `PAPERLESS_SESSION_COOKIE_AGE` for expiration. 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/)
@@ -616,6 +641,8 @@ 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
@@ -1131,6 +1158,12 @@ 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}
@@ -1174,6 +1207,48 @@ 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)).
+
+#### [`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}
@@ -1212,6 +1287,12 @@ 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
@@ -1259,6 +1340,15 @@ 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
@@ -1354,6 +1444,20 @@ 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

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 formatting tool `black`, will format failing
+as the Python linting and formatting tool `ruff`, will format failing
 files, so all you need to do is `git add` those files again
 and retry your commit.
 
@@ -81,10 +81,6 @@ first-time setup.
     !!! 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:
 
@@ -103,17 +99,17 @@ first-time setup.
 
 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 :-).
 
@@ -126,9 +122,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:
 
@@ -154,11 +150,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
 
@@ -249,14 +245,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.
@@ -302,18 +298,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
@@ -364,10 +360,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.
 
-Building the image works as with any image:
+Make sure you have the `docker-buildx` package installed. Building the image works as with any image:
 
 ```
-docker build --file Dockerfile --tag paperless:local --progress simple .
+docker build --file Dockerfile --tag paperless:local .
 ```
 
 ## Extending Paperless-ngx
@@ -382,10 +378,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
@@ -443,14 +439,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.
+-   `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,8 +127,16 @@ 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
+-   `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.

docs/setup.md

@@ -2,11 +2,11 @@
 
 You can go multiple routes to setup and run Paperless:
 
-- [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)
-- 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)
+-   A user-maintained list of commercial hosting providers can be found [in the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Related-Projects)
 
 The Docker routes are quick & easy. These are the recommended routes.
 This configures all the stuff from the above automatically so that it
@@ -105,14 +105,14 @@ steps described in [Docker setup](#docker_hub) automatically.
 
     ```yaml
     ports:
-      - 8000:8000
+        - 8000:8000
     ```
 
     Replace the part BEFORE the colon with a port of your choice:
 
     ```yaml
     ports:
-      - 8010:8000
+        - 8010:8000
     ```
 
     Don't change the part after the colon or edit other lines that
@@ -129,11 +129,11 @@ steps described in [Docker setup](#docker_hub) automatically.
     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:
 
@@ -222,7 +222,7 @@ steps described in [Docker setup](#docker_hub) automatically.
 
     ```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
@@ -230,8 +230,8 @@ steps described in [Docker setup](#docker_hub) automatically.
 
     ```yaml
     webserver:
-      build:
-        context: .
+        build:
+            context: .
     ```
 
 4.  Follow steps 3 to 8 of [Docker Setup](#docker_hub). When asked to run
@@ -250,44 +250,48 @@ 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` - 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
+    -   `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
 
     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 mime-support libzbar0 poppler-utils
+    python3 python3-pip python3-dev imagemagick fonts-liberation gnupg libpq-dev default-libmysqlclient-dev pkg-config libmagic-dev 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:
 
@@ -297,11 +301,21 @@ supported.
 
     On Raspberry Pi, these libraries are required as well:
 
-    - `libatlas-base-dev`
-    - `libxslt1-dev`
+    -   `libatlas-base-dev`
+    -   `libxslt1-dev`
+    -   `mime-support`
 
-    You will also need `build-essential`, `python3-setuptools` and
-    `python3-wheel` for installing some of the python dependencies.
+    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
+    ```
 
 2.  Install `redis` >= 6.0 and configure it to start automatically.
 
@@ -347,33 +361,33 @@ supported.
     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
 
@@ -381,9 +395,9 @@ supported.
 
 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
@@ -401,8 +415,7 @@ supported.
     sudo chown paperless:paperless /opt/paperless/consume
     ```
 
-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.
+8.  Install python requirements from the `requirements.txt` file.
 
     ```shell-session
     sudo -Hu paperless pip3 install -r requirements.txt
@@ -411,6 +424,12 @@ supported.
     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
@@ -521,8 +540,7 @@ supported.
 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 your
-    `PAPERLESS_DATA_DIR/nltk`. Refer to the [NLTK
+    Stemmer, Stopwords and Punkt tokenizer to `/usr/share/nltk_data`. Refer to the [NLTK
     instructions](https://www.nltk.org/data.html) for details on how to
     download the data.
 
@@ -568,21 +586,21 @@ 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:
 
@@ -667,24 +685,37 @@ commands as well.
 1.  Stop and remove the paperless container
 2.  If using an external database, stop the container
 3.  Update Redis configuration
-    a) If `REDIS_URL` is already set, change it to [`PAPERLESS_REDIS`](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
+
+    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
+
 4.  Update user mapping
-    a) If set, change the environment variable `PUID` to `USERMAP_UID`
-    b) If set, change the environment variable `PGID` to `USERMAP_GID`
+
+    1. If set, change the environment variable `PUID` to `USERMAP_UID`
+
+    1. If set, change the environment variable `PGID` to `USERMAP_GID`
+
 5.  Update configuration paths
-    a) Set the environment variable [`PAPERLESS_DATA_DIR`](configuration.md#PAPERLESS_DATA_DIR) to `/config`
+
+    1. Set the environment variable [`PAPERLESS_DATA_DIR`](configuration.md#PAPERLESS_DATA_DIR) to `/config`
+
 6.  Update media paths
-    a) Set the environment variable [`PAPERLESS_MEDIA_ROOT`](configuration.md#PAPERLESS_MEDIA_ROOT) to
-    `/data/media`
+
+    1. Set the environment variable [`PAPERLESS_MEDIA_ROOT`](configuration.md#PAPERLESS_MEDIA_ROOT) to
+       `/data/media`
+
 7.  Update timezone
-    a) Set the environment variable [`PAPERLESS_TIME_ZONE`](configuration.md#PAPERLESS_TIME_ZONE) to the same
-    value as `TZ`
+
+    1. 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.
@@ -732,30 +763,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,6 +353,20 @@ 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
 
@@ -112,7 +112,7 @@ process.
 Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Related-Projects) for a user-maintained list of related projects and
 software (e.g. for mobile devices) that is compatible with Paperless-ngx.
 
-### IMAP (Email) {#usage-email}
+### 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,26 +136,27 @@ 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.
+on e-mails that it has consumed documents from. The filename attachment
+patterns can include wildcards and multiple patterns separated by a comma.
 
 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
 
@@ -199,6 +200,14 @@ 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)
@@ -237,9 +246,13 @@ 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).
 
-!!! note
+!!! tip
 
-    Superusers can access all parts of the front and backend application as well as any and all objects.
+    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.
 
 #### Admin Status
 
@@ -248,29 +261,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 the user can access. For example, they
+Global permissions define what areas of the app and API endpoints users 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 | 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.        |
+| 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.          |
 
 #### Detailed Explanation of Object Permissions {#object-permissions}
 
@@ -347,32 +360,32 @@ 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
 
 There are currently two types of workflow actions, "Assignment", which can assign:
 
-- 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
+-   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
 
 and "Removal" actions, which 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
+-   Tags, correspondents, document types or storage paths
+-   Document owner
+-   View and / or edit permissions
+-   Custom fields
 
 #### Title placeholders
 
@@ -380,29 +393,29 @@ Workflow titles can include placeholders but the available options differ depend
 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
+-   `{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
+-   `{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
 
@@ -421,13 +434,12 @@ 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 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".
+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".
 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
@@ -438,23 +450,24 @@ 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
+-   `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
 
 ## 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
 
@@ -462,15 +475,16 @@ Paperless-ngx added the ability to create shareable links to files in version 2.
 
 ## PDF Actions
 
-Paperless-ngx supports 3 basic editing operations for PDFs (these operations cannot be performed on non-PDF files):
+Paperless-ngx supports four basic editing operations for PDFs (these operations currently 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
+-   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.
 
 !!! important
 
-    Note that rotation alters the Paperless-ngx _original_ file, which would, for example, invalidate a digital signature.
+    Note that rotation and deleting pages alter the Paperless-ngx _original_ file, which would, for example, invalidate a digital signature.
 
 ## Document History
 
@@ -478,6 +492,15 @@ 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
@@ -535,18 +558,18 @@ 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}
 
@@ -635,8 +658,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
 
@@ -710,78 +733,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.

mkdocs.yml

@@ -6,6 +6,12 @@ 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
@@ -18,7 +24,7 @@ theme:
       scheme: slate
       toggle:
         icon: material/brightness-4
-        name: Switch to light mode
+        name: Switch to system preference
   features:
     - navigation.tabs
     - navigation.top
@@ -49,6 +55,9 @@ 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,6 +31,11 @@
 			"**/.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_TRASH_DIR=
+#PAPERLESS_EMPTY_TRASH_DIR=
 #PAPERLESS_MEDIA_ROOT=../media
 #PAPERLESS_STATICDIR=../static
 #PAPERLESS_FILENAME_FORMAT=

scripts/post-consumption-example.sh

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

src-ui/angular.json

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

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

@@ -9,7 +9,7 @@ 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__all=9/)
+  await expect(page).toHaveURL(/tags__id__in=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_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}"
+            "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}"
           },
           "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__all=9",
+          "url": "http://localhost:8000/api/documents/?page=1&page_size=10&ordering=-created&truncate_content=true&tags__id__in=9",
           "httpVersion": "HTTP/1.1",
           "cookies": [],
           "headers": [
@@ -284,7 +284,7 @@
               "value": "true"
             },
             {
-              "name": "tags__id__all",
+              "name": "tags__id__in",
               "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__all=9",
+          "url": "http://localhost:8000/api/documents/?page=1&page_size=50&ordering=-created&truncate_content=true&tags__id__in=9",
           "httpVersion": "HTTP/1.1",
           "cookies": [],
           "headers": [
@@ -502,7 +502,7 @@
               "value": "true"
             },
             {
-              "name": "tags__id__all",
+              "name": "tags__id__in",
               "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_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}"
+            "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}"
           },
           "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__all=9",
+          "url": "http://localhost:8000/api/documents/?page=1&page_size=10&ordering=-created&truncate_content=true&tags__id__in=9",
           "httpVersion": "HTTP/1.1",
           "cookies": [],
           "headers": [
@@ -284,7 +284,7 @@
               "value": "true"
             },
             {
-              "name": "tags__id__all",
+              "name": "tags__id__in",
               "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_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}"
+            "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}"
           },
           "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_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}"
+            "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}"
           },
           "headersSize": -1,
           "bodySize": -1,

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

@@ -71,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('pngx-pdf-viewer')
+  await page.waitForSelector('pdf-viewer')
 })
 
 test('should show a list of notes', async ({ page }) => {

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

@@ -84,13 +84,8 @@ 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('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('menuitem', { name: 'Last 3 months' }).first().click()
+  await page.getByLabel('Datesselected').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()

src-ui/extra-webpack.config.ts

@@ -0,0 +1,24 @@
+import * as webpack from 'webpack'
+import {
+  CustomWebpackBrowserSchema,
+  TargetOptions,
+} from '@angular-builders/custom-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,7 +7,6 @@ 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,58 +11,60 @@
   },
   "private": true,
   "dependencies": {
-    "@angular/cdk": "^17.3.6",
-    "@angular/common": "~17.3.7",
-    "@angular/compiler": "~17.3.7",
-    "@angular/core": "~17.3.7",
-    "@angular/forms": "~17.3.7",
-    "@angular/localize": "~17.3.7",
-    "@angular/platform-browser": "~17.3.7",
-    "@angular/platform-browser-dynamic": "~17.3.7",
-    "@angular/router": "~17.3.7",
-    "@ng-bootstrap/ng-bootstrap": "^16.0.0",
-    "@ng-select/ng-select": "^12.0.7",
+    "@angular/cdk": "^18.2.11",
+    "@angular/common": "~18.2.10",
+    "@angular/compiler": "~18.2.10",
+    "@angular/core": "~18.2.10",
+    "@angular/forms": "~18.2.10",
+    "@angular/localize": "~18.2.10",
+    "@angular/platform-browser": "~18.2.10",
+    "@angular/platform-browser-dynamic": "~18.2.10",
+    "@angular/router": "~18.2.10",
+    "@ng-bootstrap/ng-bootstrap": "^17.0.1",
+    "@ng-select/ng-select": "^13.9.1",
     "@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.3.4",
     "ngx-bootstrap-icons": "^1.9.3",
     "ngx-color": "^9.0.0",
-    "ngx-cookie-service": "^17.1.0",
+    "ngx-cookie-service": "^18.0.0",
     "ngx-file-drop": "^16.0.0",
-    "ngx-filesize": "^3.0.3",
-    "ngx-ui-tour-ng-bootstrap": "^14.0.2",
-    "pdfjs-dist": "^3.11.174",
+    "ngx-ui-tour-ng-bootstrap": "^15.0.0",
     "rxjs": "^7.8.1",
-    "tslib": "^2.6.2",
-    "uuid": "^9.0.1",
-    "zone.js": "^0.14.4"
+    "tslib": "^2.8.1",
+    "uuid": "^11.0.2",
+    "zone.js": "^0.14.8"
   },
   "devDependencies": {
-    "@angular-builders/jest": "17.0.3",
-    "@angular-devkit/build-angular": "~17.3.6",
-    "@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.6",
-    "@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",
+    "@angular-builders/custom-webpack": "^18.0.0",
+    "@angular-builders/jest": "^18.0.0",
+    "@angular-devkit/build-angular": "^18.2.2",
+    "@angular-devkit/core": "^18.2.11",
+    "@angular-devkit/schematics": "^18.2.11",
+    "@angular-eslint/builder": "18.4.0",
+    "@angular-eslint/eslint-plugin": "18.4.0",
+    "@angular-eslint/eslint-plugin-template": "18.4.0",
+    "@angular-eslint/schematics": "18.4.0",
+    "@angular-eslint/template-parser": "18.4.0",
+    "@angular/cli": "~18.2.11",
+    "@angular/compiler-cli": "~18.2.2",
+    "@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",
     "jest": "29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "jest-preset-angular": "^14.0.0",
+    "jest-preset-angular": "^14.2.4",
     "jest-websocket-mock": "^2.5.0",
     "patch-package": "^8.0.0",
     "ts-node": "~10.9.1",
-    "typescript": "^5.3.3",
-    "wait-on": "^7.2.0"
+    "typescript": "^5.5.4"
   }
 }

src-ui/setup-jest.ts

@@ -24,6 +24,7 @@ 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'
@@ -55,6 +56,7 @@ registerLocaleData(localeFr)
 registerLocaleData(localeHu)
 registerLocaleData(localeIt)
 registerLocaleData(localeJa)
+registerLocaleData(localeKo)
 registerLocaleData(localeLb)
 registerLocaleData(localeNl)
 registerLocaleData(localeNo)

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

@@ -26,6 +26,7 @@ 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'
+import { TrashComponent } from './components/admin/trash/trash.component'
 
 export const routes: Routes = [
   { path: '', redirectTo: 'dashboard', pathMatch: 'full' },
@@ -144,6 +145,17 @@ 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',

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

@@ -1,4 +1,4 @@
-import { HttpClientTestingModule } from '@angular/common/http/testing'
+import { provideHttpClientTesting } from '@angular/common/http/testing'
 import {
   ComponentFixture,
   TestBed,
@@ -24,6 +24,7 @@ import { NgbModalModule } from '@ng-bootstrap/ng-bootstrap'
 import { HotKeyService } from './services/hot-key.service'
 import { PermissionsGuard } from './guards/permissions.guard'
 import { DirtySavedViewGuard } from './guards/dirty-saved-view.guard'
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
 
 describe('AppComponent', () => {
   let component: AppComponent
@@ -39,14 +40,18 @@ describe('AppComponent', () => {
   beforeEach(async () => {
     TestBed.configureTestingModule({
       declarations: [AppComponent, ToastsComponent, FileDropComponent],
-      providers: [PermissionsGuard, DirtySavedViewGuard],
       imports: [
-        HttpClientTestingModule,
         TourNgBootstrapModule,
         RouterModule.forRoot(routes),
         NgxFileDropModule,
         NgbModalModule,
       ],
+      providers: [
+        PermissionsGuard,
+        DirtySavedViewGuard,
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
+      ],
     }).compileComponents()
 
     tourService = TestBed.inject(TourService)

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

@@ -35,6 +35,8 @@ export class AppComponent implements OnInit, OnDestroy {
     private permissionsService: PermissionsService,
     private hotKeyService: HotKeyService
   ) {
+    let anyWindow = window as any
+    anyWindow.pdfWorkerSrc = 'assets/js/pdf.worker.min.mjs'
     this.settings.updateAppearanceSettings()
   }
 

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

@@ -7,7 +7,11 @@ import {
   NgbDateParserFormatter,
   NgbModule,
 } from '@ng-bootstrap/ng-bootstrap'
-import { HttpClientModule, HTTP_INTERCEPTORS } from '@angular/common/http'
+import {
+  HTTP_INTERCEPTORS,
+  provideHttpClient,
+  withInterceptorsFromDi,
+} 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'
@@ -37,6 +41,7 @@ import { DocumentCardSmallComponent } from './components/document-list/document-
 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 { TextAreaComponent } from './components/common/input/textarea/textarea.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'
@@ -104,8 +109,9 @@ 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 { CustomFieldsQueryDropdownComponent } from './components/common/custom-fields-query-dropdown/custom-fields-query-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 { PdfViewerModule } from 'ng2-pdf-viewer'
 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'
@@ -115,7 +121,6 @@ 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'
@@ -124,6 +129,8 @@ import { DragDropSelectComponent } from './components/common/input/drag-drop-sel
 import { CustomFieldDisplayComponent } from './components/common/custom-field-display/custom-field-display.component'
 import { GlobalSearchComponent } from './components/app-frame/global-search/global-search.component'
 import { HotkeyDialogComponent } from './components/common/hotkey-dialog/hotkey-dialog.component'
+import { DeletePagesConfirmDialogComponent } from './components/common/confirm-dialog/delete-pages-confirm-dialog/delete-pages-confirm-dialog.component'
+import { TrashComponent } from './components/admin/trash/trash.component'
 import {
   airplane,
   archive,
@@ -136,7 +143,9 @@ import {
   arrowRightShort,
   arrowUpRight,
   asterisk,
+  braces,
   bodyText,
+  boxArrowInRight,
   boxArrowUp,
   boxArrowUpRight,
   boxes,
@@ -160,12 +169,14 @@ import {
   clipboardCheckFill,
   clipboardFill,
   dash,
+  dashCircle,
   diagram3,
   dice5,
   doorOpen,
   download,
   envelope,
   envelopeAt,
+  envelopeAtFill,
   exclamationCircleFill,
   exclamationTriangle,
   exclamationTriangleFill,
@@ -174,6 +185,7 @@ import {
   fileEarmarkCheck,
   fileEarmarkFill,
   fileEarmarkLock,
+  fileEarmarkMinus,
   files,
   fileText,
   filter,
@@ -181,6 +193,7 @@ import {
   folderFill,
   funnel,
   gear,
+  google,
   grid,
   gripVertical,
   hash,
@@ -191,6 +204,8 @@ import {
   link,
   listTask,
   listUl,
+  microsoft,
+  nodePlus,
   pencil,
   people,
   peopleFill,
@@ -220,6 +235,7 @@ import {
   uiRadios,
   upcScan,
   x,
+  xCircle,
   xLg,
 } from 'ngx-bootstrap-icons'
 
@@ -235,7 +251,9 @@ const icons = {
   arrowRightShort,
   arrowUpRight,
   asterisk,
+  braces,
   bodyText,
+  boxArrowInRight,
   boxArrowUp,
   boxArrowUpRight,
   boxes,
@@ -259,12 +277,14 @@ const icons = {
   clipboardCheckFill,
   clipboardFill,
   dash,
+  dashCircle,
   diagram3,
   dice5,
   doorOpen,
   download,
   envelope,
   envelopeAt,
+  envelopeAtFill,
   exclamationCircleFill,
   exclamationTriangle,
   exclamationTriangleFill,
@@ -273,6 +293,7 @@ const icons = {
   fileEarmarkCheck,
   fileEarmarkFill,
   fileEarmarkLock,
+  fileEarmarkMinus,
   files,
   fileText,
   filter,
@@ -280,6 +301,7 @@ const icons = {
   folderFill,
   funnel,
   gear,
+  google,
   grid,
   gripVertical,
   hash,
@@ -290,6 +312,8 @@ const icons = {
   link,
   listTask,
   listUl,
+  microsoft,
+  nodePlus,
   pencil,
   people,
   peopleFill,
@@ -319,6 +343,7 @@ const icons = {
   uiRadios,
   upcScan,
   x,
+  xCircle,
   xLg,
 }
 
@@ -338,6 +363,7 @@ 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'
@@ -369,6 +395,7 @@ registerLocaleData(localeFr)
 registerLocaleData(localeHu)
 registerLocaleData(localeIt)
 registerLocaleData(localeJa)
+registerLocaleData(localeKo)
 registerLocaleData(localeLb)
 registerLocaleData(localeNl)
 registerLocaleData(localeNo)
@@ -422,6 +449,7 @@ function initializeApp(settings: SettingsService) {
     DocumentCardSmallComponent,
     BulkEditorComponent,
     TextComponent,
+    TextAreaComponent,
     SelectComponent,
     CheckComponent,
     UrlComponent,
@@ -474,8 +502,8 @@ function initializeApp(settings: SettingsService) {
     CustomFieldsComponent,
     CustomFieldEditDialogComponent,
     CustomFieldsDropdownComponent,
+    CustomFieldsQueryDropdownComponent,
     ProfileEditDialogComponent,
-    PdfViewerComponent,
     DocumentLinkComponent,
     PreviewPopupComponent,
     SwitchComponent,
@@ -492,21 +520,23 @@ function initializeApp(settings: SettingsService) {
     CustomFieldDisplayComponent,
     GlobalSearchComponent,
     HotkeyDialogComponent,
+    DeletePagesConfirmDialogComponent,
+    TrashComponent,
   ],
+  bootstrap: [AppComponent],
   imports: [
     BrowserModule,
     AppRoutingModule,
     NgbModule,
-    HttpClientModule,
     FormsModule,
     ReactiveFormsModule,
+    PdfViewerModule,
     NgxFileDropModule,
     NgSelectModule,
     ColorSliderModule,
     TourNgBootstrapModule,
     DragDropModule,
     NgxBootstrapIconsModule.pick(icons),
-    NgxFilesizeModule,
   ],
   providers: [
     {
@@ -535,7 +565,7 @@ function initializeApp(settings: SettingsService) {
     DirtyDocGuard,
     DirtySavedViewGuard,
     UsernamePipe,
+    provideHttpClient(withInterceptorsFromDi()),
   ],
-  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 i18n>{{category}}</a>
+                <a ngbNavLink>{{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

@@ -5,7 +5,7 @@ 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 { provideHttpClientTesting } 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'
@@ -18,6 +18,7 @@ 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'
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
 
 describe('ConfigComponent', () => {
   let component: ConfigComponent
@@ -38,7 +39,6 @@ describe('ConfigComponent', () => {
         PageHeaderComponent,
       ],
       imports: [
-        HttpClientTestingModule,
         BrowserModule,
         NgbModule,
         NgSelectModule,
@@ -46,6 +46,10 @@ describe('ConfigComponent', () => {
         ReactiveFormsModule,
         NgxBootstrapIconsModule.pick(allIcons),
       ],
+      providers: [
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
+      ],
     }).compileComponents()
 
     configService = TestBed.inject(ConfigService)

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

@@ -8,10 +8,11 @@ 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 { provideHttpClientTesting } 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'
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
 
 const paperless_logs = [
   '[2023-05-29 03:05:01,224] [DEBUG] [paperless.tasks] Training data unchanged.',
@@ -37,13 +38,15 @@ describe('LogsComponent', () => {
   beforeEach(async () => {
     TestBed.configureTestingModule({
       declarations: [LogsComponent, PageHeaderComponent],
-      providers: [],
       imports: [
-        HttpClientTestingModule,
         BrowserModule,
         NgbModule,
         NgxBootstrapIconsModule.pick(allIcons),
       ],
+      providers: [
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
+      ],
     }).compileComponents()
 
     logService = TestBed.inject(LogService)

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

@@ -192,7 +192,7 @@
 
         <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="Show confirmation dialogs" formControlName="bulkEditConfirmationDialogs"></pngx-input-check>
             <pngx-input-check i18n-title title="Apply on close" formControlName="bulkEditApplyOnClose"></pngx-input-check>
           </div>
         </div>
@@ -201,7 +201,23 @@
 
         <div class="row mb-3">
           <div class="offset-md-3 col">
-            <pngx-input-check i18n-title title="Search database only (do not include advanced search results)" formControlName="searchDbOnly"></pngx-input-check>
+            <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="offset-md-3 col">
+            <div class="row">
+              <div class="col-md-2 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>
 
@@ -316,7 +332,7 @@
       </ng-template>
     </li>
 
-    <li [ngbNavItem]="SettingsNavIDs.SavedViews">
+    <li [ngbNavItem]="SettingsNavIDs.SavedViews" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.SavedView }">
       <a ngbNavLink i18n>Saved views</a>
       <ng-template ngbNavContent>
 
@@ -332,7 +348,7 @@
 
           @for (view of savedViews; track view) {
             <li class="list-group-item py-3">
-            <div [formGroupName]="view.id" class="row">
+            <div [formGroupName]="view.id">
               <div class="row">
                 <div class="col">
                   <pngx-input-text title="Name" formControlName="name"></pngx-input-text>

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

@@ -1,5 +1,5 @@
 import { ViewportScroller, DatePipe } from '@angular/common'
-import { HttpClientTestingModule } from '@angular/common/http/testing'
+import { provideHttpClientTesting } from '@angular/common/http/testing'
 import { ComponentFixture, TestBed } from '@angular/core/testing'
 import { FormsModule, ReactiveFormsModule } from '@angular/forms'
 import { By } from '@angular/platform-browser'
@@ -50,6 +50,7 @@ import {
 } 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'
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
 
 const savedViews = [
   { id: 1, name: 'view1', show_in_sidebar: true, show_on_dashboard: true },
@@ -100,10 +101,8 @@ describe('SettingsComponent', () => {
         ConfirmButtonComponent,
         DragDropSelectComponent,
       ],
-      providers: [CustomDatePipe, DatePipe, PermissionsGuard],
       imports: [
         NgbModule,
-        HttpClientTestingModule,
         RouterTestingModule.withRoutes(routes),
         FormsModule,
         ReactiveFormsModule,
@@ -113,6 +112,13 @@ describe('SettingsComponent', () => {
         NgbModalModule,
         DragDropModule,
       ],
+      providers: [
+        CustomDatePipe,
+        DatePipe,
+        PermissionsGuard,
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
+      ],
     }).compileComponents()
 
     router = TestBed.inject(Router)
@@ -309,7 +315,7 @@ describe('SettingsComponent', () => {
     expect(toastErrorSpy).toHaveBeenCalled()
     expect(storeSpy).toHaveBeenCalled()
     expect(appearanceSettingsSpy).not.toHaveBeenCalled()
-    expect(setSpy).toHaveBeenCalledTimes(26)
+    expect(setSpy).toHaveBeenCalledTimes(27)
 
     // succeed
     storeSpy.mockReturnValueOnce(of(true))

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

@@ -27,7 +27,7 @@ import {
 } from 'rxjs'
 import { Group } from 'src/app/data/group'
 import { SavedView } from 'src/app/data/saved-view'
-import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import { GlobalSearchType, SETTINGS_KEYS } from 'src/app/data/ui-settings'
 import { User } from 'src/app/data/user'
 import { DocumentListViewService } from 'src/app/services/document-list-view.service'
 import {
@@ -101,6 +101,7 @@ export class SettingsComponent
     defaultPermsEditGroups: new FormControl(null),
     documentEditingRemoveInboxTags: new FormControl(null),
     searchDbOnly: new FormControl(null),
+    searchLink: new FormControl(null),
 
     notificationsConsumerNewDocument: new FormControl(null),
     notificationsConsumerSuccess: new FormControl(null),
@@ -129,6 +130,8 @@ export class SettingsComponent
 
   public systemStatus: SystemStatus
 
+  public readonly GlobalSearchType = GlobalSearchType
+
   get systemStatusHasErrors(): boolean {
     return (
       this.systemStatus.database.status === SystemStatusItemStatus.ERROR ||
@@ -306,6 +309,7 @@ export class SettingsComponent
         SETTINGS_KEYS.DOCUMENT_EDITING_REMOVE_INBOX_TAGS
       ),
       searchDbOnly: this.settings.get(SETTINGS_KEYS.SEARCH_DB_ONLY),
+      searchLink: this.settings.get(SETTINGS_KEYS.SEARCH_FULL_TYPE),
       savedViews: {},
     }
   }
@@ -539,6 +543,10 @@ export class SettingsComponent
       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()

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

@@ -1,7 +1,7 @@
 import { DatePipe } from '@angular/common'
 import {
   HttpTestingController,
-  HttpClientTestingModule,
+  provideHttpClientTesting,
 } from '@angular/common/http/testing'
 import { ComponentFixture, TestBed } from '@angular/core/testing'
 import { By } from '@angular/platform-browser'
@@ -30,6 +30,7 @@ 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'
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
 
 const tasks: PaperlessTask[] = [
   {
@@ -125,6 +126,12 @@ describe('TasksComponent', () => {
         CustomDatePipe,
         ConfirmDialogComponent,
       ],
+      imports: [
+        NgbModule,
+        RouterTestingModule.withRoutes(routes),
+        NgxBootstrapIconsModule.pick(allIcons),
+        FormsModule,
+      ],
       providers: [
         {
           provide: PermissionsService,
@@ -135,13 +142,8 @@ describe('TasksComponent', () => {
         CustomDatePipe,
         DatePipe,
         PermissionsGuard,
-      ],
-      imports: [
-        NgbModule,
-        HttpClientTestingModule,
-        RouterTestingModule.withRoutes(routes),
-        NgxBootstrapIconsModule.pick(allIcons),
-        FormsModule,
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
       ],
     }).compileComponents()
 

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

@@ -70,11 +70,11 @@ export class TasksComponent
         modal.componentInstance.buttonsEnabled = false
         modal.close()
         this.tasksService.dismissTasks(tasks)
-        this.selectedTasks.clear()
+        this.clearSelection()
       })
     } else {
       this.tasksService.dismissTasks(tasks)
-      this.selectedTasks.clear()
+      this.clearSelection()
     }
   }
 

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

@@ -0,0 +1,98 @@
+<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 (isLoading) {
+                <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();">
+                    <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 }}</td>
+                    <td scope="row" 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 (!isLoading) {
+    <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.spec.ts

@@ -0,0 +1,200 @@
+import { ComponentFixture, TestBed } from '@angular/core/testing'
+
+import { TrashComponent } from './trash.component'
+import { HttpClientTestingModule } from '@angular/common/http/testing'
+import { PageHeaderComponent } from '../../common/page-header/page-header.component'
+import {
+  NgbModal,
+  NgbPaginationModule,
+  NgbPopoverModule,
+} from '@ng-bootstrap/ng-bootstrap'
+import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
+import { FormsModule, ReactiveFormsModule } from '@angular/forms'
+import { TrashService } from 'src/app/services/trash.service'
+import { of, throwError } from 'rxjs'
+import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
+import { By } from '@angular/platform-browser'
+import { SafeHtmlPipe } from 'src/app/pipes/safehtml.pipe'
+import { ToastService } from 'src/app/services/toast.service'
+
+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
+
+  beforeEach(async () => {
+    await TestBed.configureTestingModule({
+      declarations: [
+        TrashComponent,
+        PageHeaderComponent,
+        ConfirmDialogComponent,
+        SafeHtmlPipe,
+      ],
+      imports: [
+        HttpClientTestingModule,
+        FormsModule,
+        ReactiveFormsModule,
+        NgbPopoverModule,
+        NgbPaginationModule,
+        NgxBootstrapIconsModule.pick(allIcons),
+      ],
+    }).compileComponents()
+
+    fixture = TestBed.createComponent(TrashComponent)
+    trashService = TestBed.inject(TrashService)
+    modalService = TestBed.inject(NgbModal)
+    toastService = TestBed.inject(ToastService)
+    component = fixture.componentInstance
+    fixture.detectChanges()
+  })
+
+  it('should call correct service method on reload', () => {
+    const trashSpy = jest.spyOn(trashService, 'getTrash')
+    trashSpy.mockReturnValue(
+      of({
+        count: 2,
+        all: documentsInTrash.map((d) => d.id),
+        results: documentsInTrash,
+      })
+    )
+    component.reload()
+    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 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

@@ -0,0 +1,165 @@
+import { Component, OnDestroy } from '@angular/core'
+import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
+import { Document } from 'src/app/data/document'
+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 { Subject, takeUntil } from 'rxjs'
+import { SettingsService } from 'src/app/services/settings.service'
+import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
+
+@Component({
+  selector: 'pngx-trash',
+  templateUrl: './trash.component.html',
+  styleUrl: './trash.component.scss',
+})
+export class TrashComponent implements OnDestroy {
+  public documentsInTrash: Document[] = []
+  public selectedDocuments: Set<number> = new Set()
+  public allToggled: boolean = false
+  public page: number = 1
+  public totalDocuments: number
+  public isLoading: boolean = false
+  unsubscribeNotifier: Subject<void> = new Subject()
+
+  constructor(
+    private trashService: TrashService,
+    private toastService: ToastService,
+    private modalService: NgbModal,
+    private settingsService: SettingsService
+  ) {
+    this.reload()
+  }
+
+  ngOnDestroy() {
+    this.unsubscribeNotifier.next()
+    this.unsubscribeNotifier.complete()
+  }
+
+  reload() {
+    this.isLoading = true
+    this.trashService.getTrash(this.page).subscribe((r) => {
+      this.documentsInTrash = r.results
+      this.totalDocuments = r.count
+      this.isLoading = false
+      this.selectedDocuments.clear()
+    })
+  }
+
+  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.showInfo($localize`Document restored`)
+        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,5 +1,5 @@
 import { DatePipe } from '@angular/common'
-import { HttpClientTestingModule } from '@angular/common/http/testing'
+import { provideHttpClientTesting } from '@angular/common/http/testing'
 import {
   ComponentFixture,
   TestBed,
@@ -44,6 +44,7 @@ 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'
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
 
 const users = [
   { id: 1, username: 'user1', is_superuser: false },
@@ -84,10 +85,8 @@ describe('UsersAndGroupsComponent', () => {
         PermissionsGroupComponent,
         IfOwnerDirective,
       ],
-      providers: [CustomDatePipe, DatePipe, PermissionsGuard],
       imports: [
         NgbModule,
-        HttpClientTestingModule,
         RouterTestingModule.withRoutes(routes),
         FormsModule,
         ReactiveFormsModule,
@@ -95,6 +94,13 @@ describe('UsersAndGroupsComponent', () => {
         NgSelectModule,
         NgxBootstrapIconsModule.pick(allIcons),
       ],
+      providers: [
+        CustomDatePipe,
+        DatePipe,
+        PermissionsGuard,
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
+      ],
     }).compileComponents()
     fixture = TestBed.createComponent(UsersAndGroupsComponent)
     settingsService = TestBed.inject(SettingsService)

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

@@ -43,7 +43,7 @@
           <div class="dropdown-divider"></div>
         </div>
         <button ngbDropdownItem class="nav-link" (click)="editProfile()">
-          <i-bs class="me-2" name="person"></i-bs>&nbsp;<ng-container i18n>My Profile</ng-container>
+          <i-bs class="me-2" name="person"></i-bs><ng-container i18n>My Profile</ng-container>
         </button>
         <a ngbDropdownItem class="nav-link" routerLink="settings" (click)="closeMenu()"
           *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.UISettings }">
@@ -93,33 +93,35 @@
         </ul>
 
         <div class="nav-group mt-3 mb-1" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.SavedView }">
-          @if (savedViewService.loading || savedViewService.sidebarViews?.length > 0) {
+          @if (savedViewService.loading) {
             <h6 class="sidebar-heading px-3 text-muted">
               <span i18n>Saved views</span>
-              @if (savedViewService.loading) {
-                <div class="spinner-border spinner-border-sm fw-normal ms-2" role="status"></div>
-              }
+              <div class="spinner-border spinner-border-sm fw-normal ms-2" role="status"></div>
             </h6>
+          } @else if (savedViewService.sidebarViews?.length > 0) {
+            <h6 class="sidebar-heading px-3 text-muted">
+              <span i18n>Saved views</span>
+            </h6>
+            <ul class="nav flex-column mb-2" cdkDropList (cdkDropListDropped)="onDrop($event)">
+              @for (view of savedViewService.sidebarViews; track view.id) {
+                <li class="nav-item w-100 app-link" cdkDrag [cdkDragDisabled]="!settingsService.organizingSidebarSavedViews"
+                  cdkDragPreviewContainer="parent" cdkDragPreviewClass="navItemDrag" (cdkDragStarted)="onDragStart($event)"
+                  (cdkDragEnded)="onDragEnd($event)">
+                  <a class="nav-link" [class.text-truncate]="!slimSidebarEnabled" routerLink="view/{{view.id}}"
+                    routerLinkActive="active" (click)="closeMenu()" [ngbPopover]="view.name"
+                    [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave"
+                    popoverClass="popover-slim">
+                    <i-bs class="me-1" name="funnel"></i-bs><span>&nbsp;{{view.name}}</span>
+                  </a>
+                  @if (settingsService.organizingSidebarSavedViews) {
+                    <div class="position-absolute end-0 top-0 px-3 py-2" [class.me-n3]="slimSidebarEnabled" cdkDragHandle>
+                      <i-bs name="grip-vertical"></i-bs>
+                    </div>
+                  }
+                </li>
+              }
+            </ul>
           }
-          <ul class="nav flex-column mb-2" cdkDropList (cdkDropListDropped)="onDrop($event)">
-            @for (view of savedViewService.sidebarViews; track view.id) {
-              <li class="nav-item w-100 app-link" cdkDrag [cdkDragDisabled]="!settingsService.organizingSidebarSavedViews"
-                cdkDragPreviewContainer="parent" cdkDragPreviewClass="navItemDrag" (cdkDragStarted)="onDragStart($event)"
-                (cdkDragEnded)="onDragEnd($event)">
-                <a class="nav-link" [class.text-truncate]="!slimSidebarEnabled" routerLink="view/{{view.id}}"
-                  routerLinkActive="active" (click)="closeMenu()" [ngbPopover]="view.name"
-                  [disablePopover]="!slimSidebarEnabled" placement="end" container="body" triggers="mouseenter:mouseleave"
-                  popoverClass="popover-slim">
-                  <i-bs class="me-1" name="funnel"></i-bs><span>&nbsp;{{view.name}}</span>
-                </a>
-                @if (settingsService.organizingSidebarSavedViews) {
-                  <div class="position-absolute end-0 top-0 px-3 py-2" [class.me-n3]="slimSidebarEnabled" cdkDragHandle>
-                    <i-bs name="grip-vertical"></i-bs>
-                  </div>
-                }
-              </li>
-            }
-          </ul>
         </div>
 
         <div class="nav-group mt-3 mb-1" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.Document }">
@@ -214,6 +216,13 @@
                 <i-bs class="me-1" name="envelope"></i-bs><span>&nbsp;<ng-container i18n>Mail</ng-container></span>
               </a>
             </li>
+            <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.Delete, type: PermissionType.Document }">
+              <a class="nav-link" routerLink="trash" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Trash"
+                i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body"
+                triggers="mouseenter:mouseleave" popoverClass="popover-slim">
+                <i-bs class="me-1" name="trash"></i-bs><span>&nbsp;<ng-container i18n>Trash</ng-container></span>
+              </a>
+            </li>
           </ul>
         </div>
 

src-ui/src/app/components/app-frame/app-frame.component.scss

@@ -12,6 +12,9 @@
   z-index: 995; /* Behind the navbar */
   padding: 50px 0 0; /* Height of navbar */
   box-shadow: inset -1px 0 0 rgba(0, 0, 0, .1);
+  overflow-y: auto;
+  --pngx-sidebar-width: 100%;
+  max-width: var(--pngx-sidebar-width);
 
   .sidebar-heading .spinner-border {
     width: 0.8em;
@@ -24,15 +27,15 @@
 
   // These come from the col-* classes for non-slim sidebar, needed for animation
   @media (min-width: 768px) {
-    max-width: 25%;
+    --pngx-sidebar-width: 25%;
   }
 
   @media (min-width: 992px) {
-    max-width: 16.66666667%;
+    --pngx-sidebar-width: 16.66666667%;
   }
 
   @media (min-width: 2400px) {
-    max-width: 8.33333333%;
+    --pngx-sidebar-width: 8.33333333%;
   }
 
   transition: all .2s ease;
@@ -109,12 +112,17 @@ main {
 
   .sidebar-slim-toggler {
     display: block;
-    position: absolute;
-    right: -12px;
+    position: fixed;
+    left: calc(var(--pngx-sidebar-width) - 12px);
     top: 60px;
     z-index: 996;
     --bs-btn-padding-x: 0.35rem;
     --bs-btn-padding-y: 0.125rem;
+    transition: all .2s ease;
+  }
+
+  .sidebar.slim .sidebar-slim-toggler {
+    --pngx-sidebar-width: 50px !important;
   }
 }
 

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

@@ -1,6 +1,6 @@
 import {
-  HttpClientTestingModule,
   HttpTestingController,
+  provideHttpClientTesting,
 } from '@angular/common/http/testing'
 import { AppFrameComponent } from './app-frame.component'
 import {
@@ -37,6 +37,7 @@ import { SavedView } from 'src/app/data/saved-view'
 import { ProfileEditDialogComponent } from '../common/profile-edit-dialog/profile-edit-dialog.component'
 import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
 import { GlobalSearchComponent } from './global-search/global-search.component'
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
 
 const saved_views = [
   {
@@ -100,7 +101,6 @@ describe('AppFrameComponent', () => {
         GlobalSearchComponent,
       ],
       imports: [
-        HttpClientTestingModule,
         BrowserModule,
         RouterTestingModule.withRoutes(routes),
         NgbModule,
@@ -115,7 +115,7 @@ describe('AppFrameComponent', () => {
         {
           provide: SavedViewService,
           useValue: {
-            initialize: () => {},
+            reload: () => {},
             listAll: () =>
               of({
                 all: [saved_views.map((v) => v.id)],
@@ -150,6 +150,8 @@ describe('AppFrameComponent', () => {
           },
         },
         PermissionsGuard,
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
       ],
     }).compileComponents()
 
@@ -168,7 +170,7 @@ describe('AppFrameComponent', () => {
       .mockReturnValue('Hello World')
     jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
 
-    savedViewSpy = jest.spyOn(savedViewService, 'initialize')
+    savedViewSpy = jest.spyOn(savedViewService, 'reload')
 
     fixture = TestBed.createComponent(AppFrameComponent)
     component = fixture.componentInstance

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

@@ -35,7 +35,6 @@ import {
 } from '@angular/cdk/drag-drop'
 import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
 import { ProfileEditDialogComponent } from '../common/profile-edit-dialog/profile-edit-dialog.component'
-import { ObjectWithId } from 'src/app/data/object-with-id'
 
 @Component({
   selector: 'pngx-app-frame',
@@ -74,7 +73,7 @@ export class AppFrameComponent
         PermissionType.SavedView
       )
     ) {
-      this.savedViewService.initialize()
+      this.savedViewService.reload()
     }
   }
 

src-ui/src/app/components/app-frame/global-search/global-search.component.html

@@ -6,17 +6,25 @@
             <div class="form-control form-control-sm">
                 <input class="bg-transparent border-0 w-100 h-100" #searchInput type="text" name="query"
                     placeholder="Search" aria-label="Search" i18n-placeholder
-                    autocomplete="off" spellcheck="false"
-                    [(ngModel)]="query" (ngModelChange)="this.queryDebounce.next($event)" (keydown)="searchInputKeyDown($event)">
+                    autocomplete="off"
+                    spellcheck="false"
+                    [(ngModel)]="query"
+                    (ngModelChange)="this.queryDebounce.next($event)"
+                    (keydown)="searchInputKeyDown($event)"
+                    ngbDropdownAnchor>
                 <div class="position-absolute top-50 end-0 translate-middle">
                     @if (loading) {
                         <div class="spinner-border spinner-border-sm text-muted mt-1"></div>
                     }
                 </div>
             </div>
-            @if (query && (searchResults?.documents.length === searchService.searchResultObjectLimit || searchService.searchDbOnly)) {
-                <button class="btn btn-sm btn-outline-secondary" type="button" (click)="runAdvanedSearch()">
-                    <ng-container i18n>Advanced search</ng-container>
+            @if (query) {
+                <button class="btn btn-sm btn-outline-secondary" type="button" (click)="runFullSearch()">
+                    @if (useAdvancedForFullSearch) {
+                        <ng-container i18n>Advanced search</ng-container>
+                    } @else {
+                        <ng-container i18n>Search</ng-container>
+                    }
                     <i-bs width="1em" height="1em" name="arrow-right-short"></i-bs>
                 </button>
             }
@@ -25,7 +33,7 @@
 
     <ng-template #resultItemTemplate let-item="item" let-nameProp="nameProp" let-type="type" let-icon="icon" let-date="date">
         <div #resultItem ngbDropdownItem class="py-2 d-flex align-items-center focus-ring border-0 cursor-pointer" tabindex="-1"
-        (click)="primaryAction(type, item)"
+        (click)="primaryAction(type, item, $event)"
         (mouseenter)="onItemHover($event)">
             <i-bs width="1.2em" height="1.2em" name="{{icon}}" class="me-2 text-muted"></i-bs>
             <div class="text-truncate">
@@ -36,19 +44,19 @@
             </div>
             <div class="btn-group ms-auto">
                 <button #primaryButton type="button" class="btn btn-sm btn-outline-primary d-flex"
-                (click)="primaryAction(type, item); $event.stopImmediatePropagation()"
+                (click)="primaryAction(type, item, $event); $event.stopImmediatePropagation()"
                 (keydown)="onButtonKeyDown($event)"
                 [disabled]="disablePrimaryButton(type, item)"
                 (mouseenter)="onButtonHover($event)">
                     @if (type === DataType.Document) {
-                        <i-bs width="1em" height="1em" name="pencil"></i-bs>
+                        <i-bs width="1em" height="1em" name="box-arrow-in-right"></i-bs>
                         <span>&nbsp;<ng-container i18n>Open</ng-container></span>
                     } @else if (type === DataType.SavedView) {
                         <i-bs width="1em" height="1em" name="eye"></i-bs>
                         <span>&nbsp;<ng-container i18n>Open</ng-container></span>
                     } @else if (type === DataType.Workflow || type === DataType.CustomField || type === DataType.Group || type === DataType.User || type === DataType.MailAccount || type === DataType.MailRule) {
                         <i-bs width="1em" height="1em" name="pencil"></i-bs>
-                        <span>&nbsp;<ng-container i18n>Edit</ng-container></span>
+                        <span>&nbsp;<ng-container i18n>Open</ng-container></span>
                     } @else {
                         <i-bs width="1em" height="1em" name="filter"></i-bs>
                         <span>&nbsp;<ng-container i18n>Filter documents</ng-container></span>
@@ -56,7 +64,7 @@
                 </button>
                 @if (type !== DataType.SavedView && type !== DataType.Workflow && type !== DataType.CustomField && type !== DataType.Group && type !== DataType.User && type !== DataType.MailAccount && type !== DataType.MailRule) {
                     <button #secondaryButton type="button" class="btn btn-sm btn-outline-primary d-flex"
-                    (click)="secondaryAction(type, item); $event.stopImmediatePropagation()"
+                    (click)="secondaryAction(type, item, $event); $event.stopImmediatePropagation()"
                     (keydown)="onButtonKeyDown($event)"
                     [disabled]="disableSecondaryButton(type, item)"
                     (mouseenter)="onButtonHover($event)">
@@ -64,8 +72,8 @@
                             <i-bs width="1em" height="1em" name="download"></i-bs>
                             <span>&nbsp;<ng-container i18n>Download</ng-container></span>
                         } @else {
-                            <i-bs width="1em" height="1em" name="pencil"></i-bs>
-                            <span>&nbsp;<ng-container i18n>Edit</ng-container></span>
+                            <i-bs width="1em" height="1em" name="box-arrow-in-right"></i-bs>
+                            <span>&nbsp;<ng-container i18n>Open</ng-container></span>
                         }
                     </button>
                 }

src-ui/src/app/components/app-frame/global-search/global-search.component.scss

@@ -31,6 +31,9 @@ form {
   .input-group .btn {
     border-color: rgba(255, 255, 255, 0.2);
     color: var(--pngx-primary-text-contrast);
+    padding-top: .15rem;
+    padding-bottom: .15rem;
+    min-height: calc(1.3em + 0.5rem + calc(var(--bs-border-width) * 2)) !important;
   }
 
   .form-control {
@@ -62,10 +65,6 @@ form {
   --pngx-focus-alpha: 0;
 }
 
-.cursor-pointer {
-  cursor: pointer;
-}
-
 .mh-75 {
   max-height: 75vh;
 }

src-ui/src/app/components/app-frame/global-search/global-search.component.spec.ts

@@ -17,14 +17,15 @@ import {
 import { CorrespondentEditDialogComponent } from '../../common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component'
 import { UserEditDialogComponent } from '../../common/edit-dialog/user-edit-dialog/user-edit-dialog.component'
 import { DocumentListViewService } from 'src/app/services/document-list-view.service'
-import { HttpClientTestingModule } from '@angular/common/http/testing'
+import { provideHttpClientTesting } from '@angular/common/http/testing'
 import { FormsModule, ReactiveFormsModule } from '@angular/forms'
 import {
   FILTER_FULLTEXT_QUERY,
   FILTER_HAS_CORRESPONDENT_ANY,
   FILTER_HAS_DOCUMENT_TYPE_ANY,
   FILTER_HAS_STORAGE_PATH_ANY,
-  FILTER_HAS_TAGS_ANY,
+  FILTER_HAS_TAGS_ALL,
+  FILTER_TITLE_CONTENT,
 } from 'src/app/data/filter-rule-type'
 import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
 import { DocumentService } from 'src/app/services/rest/document.service'
@@ -36,6 +37,10 @@ import { WorkflowEditDialogComponent } from '../../common/edit-dialog/workflow-e
 import { ElementRef } from '@angular/core'
 import { ToastService } from 'src/app/services/toast.service'
 import { DataType } from 'src/app/data/datatype'
+import { queryParamsFromFilterRules } from 'src/app/utils/query-params'
+import { SettingsService } from 'src/app/services/settings.service'
+import { GlobalSearchType, SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
 
 const searchResults = {
   total: 11,
@@ -129,18 +134,22 @@ describe('GlobalSearchComponent', () => {
   let documentService: DocumentService
   let documentListViewService: DocumentListViewService
   let toastService: ToastService
+  let settingsService: SettingsService
 
   beforeEach(async () => {
     await TestBed.configureTestingModule({
       declarations: [GlobalSearchComponent],
       imports: [
-        HttpClientTestingModule,
         NgbModalModule,
         NgbDropdownModule,
         FormsModule,
         ReactiveFormsModule,
         NgxBootstrapIconsModule.pick(allIcons),
       ],
+      providers: [
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
+      ],
     }).compileComponents()
 
     searchService = TestBed.inject(SearchService)
@@ -149,6 +158,7 @@ describe('GlobalSearchComponent', () => {
     documentService = TestBed.inject(DocumentService)
     documentListViewService = TestBed.inject(DocumentListViewService)
     toastService = TestBed.inject(ToastService)
+    settingsService = TestBed.inject(SettingsService)
 
     fixture = TestBed.createComponent(GlobalSearchComponent)
     component = fixture.componentInstance
@@ -248,10 +258,22 @@ describe('GlobalSearchComponent', () => {
     expect(blurSpy).toHaveBeenCalled()
 
     component.searchResults = { total: 1 } as any
-    component.resultsDropdown.close()
-    const openSpy = jest.spyOn(component.resultsDropdown, 'open')
+    component.resultsDropdown.open()
+
+    component.searchInputKeyDown(
+      new KeyboardEvent('keydown', { key: 'ArrowDown' })
+    )
+    expect(component['currentItemIndex']).toBe(0)
+    const closeSpy = jest.spyOn(component.resultsDropdown, 'close')
+    component.dropdownKeyDown(new KeyboardEvent('keydown', { key: 'Escape' }))
+    expect(closeSpy).toHaveBeenCalled()
+
+    component.searchResults = searchResults as any
+    component.resultsDropdown.open()
+    component.query = 'test'
+    const advancedSearchSpy = jest.spyOn(component, 'runFullSearch')
     component.searchInputKeyDown(new KeyboardEvent('keydown', { key: 'Enter' }))
-    expect(openSpy).toHaveBeenCalled()
+    expect(advancedSearchSpy).toHaveBeenCalled()
   })
 
   it('should search on query debounce', fakeAsync(() => {
@@ -268,37 +290,81 @@ describe('GlobalSearchComponent', () => {
   it('should support primary action', () => {
     const object = { id: 1 }
     const routerSpy = jest.spyOn(router, 'navigate')
-    const qfSpy = jest.spyOn(documentListViewService, 'quickFilter')
     const modalSpy = jest.spyOn(modalService, 'open')
 
     let modal: NgbModalRef
     modalService.activeInstances.subscribe((m) => (modal = m[m.length - 1]))
 
     component.primaryAction(DataType.Document, object)
-    expect(routerSpy).toHaveBeenCalledWith(['/documents', object.id])
+    expect(routerSpy).toHaveBeenCalledWith(['/documents', object.id], {})
 
     component.primaryAction(DataType.SavedView, object)
-    expect(routerSpy).toHaveBeenCalledWith(['/view', object.id])
+    expect(routerSpy).toHaveBeenCalledWith(['/view', object.id], {})
 
     component.primaryAction(DataType.Correspondent, object)
-    expect(qfSpy).toHaveBeenCalledWith([
-      { rule_type: FILTER_HAS_CORRESPONDENT_ANY, value: object.id.toString() },
-    ])
+    expect(routerSpy).toHaveBeenCalledWith(['/documents'], {
+      queryParams: Object.assign(
+        {
+          page: 1,
+          reverse: 1,
+          sort: 'created',
+        },
+        queryParamsFromFilterRules([
+          {
+            rule_type: FILTER_HAS_CORRESPONDENT_ANY,
+            value: object.id.toString(),
+          },
+        ])
+      ),
+    })
 
     component.primaryAction(DataType.DocumentType, object)
-    expect(qfSpy).toHaveBeenCalledWith([
-      { rule_type: FILTER_HAS_DOCUMENT_TYPE_ANY, value: object.id.toString() },
-    ])
+    expect(routerSpy).toHaveBeenCalledWith(['/documents'], {
+      queryParams: Object.assign(
+        {
+          page: 1,
+          reverse: 1,
+          sort: 'created',
+        },
+        queryParamsFromFilterRules([
+          {
+            rule_type: FILTER_HAS_DOCUMENT_TYPE_ANY,
+            value: object.id.toString(),
+          },
+        ])
+      ),
+    })
 
     component.primaryAction(DataType.StoragePath, object)
-    expect(qfSpy).toHaveBeenCalledWith([
-      { rule_type: FILTER_HAS_STORAGE_PATH_ANY, value: object.id.toString() },
-    ])
+    expect(routerSpy).toHaveBeenCalledWith(['/documents'], {
+      queryParams: Object.assign(
+        {
+          page: 1,
+          reverse: 1,
+          sort: 'created',
+        },
+        queryParamsFromFilterRules([
+          {
+            rule_type: FILTER_HAS_STORAGE_PATH_ANY,
+            value: object.id.toString(),
+          },
+        ])
+      ),
+    })
 
     component.primaryAction(DataType.Tag, object)
-    expect(qfSpy).toHaveBeenCalledWith([
-      { rule_type: FILTER_HAS_TAGS_ANY, value: object.id.toString() },
-    ])
+    expect(routerSpy).toHaveBeenCalledWith(['/documents'], {
+      queryParams: Object.assign(
+        {
+          page: 1,
+          reverse: 1,
+          sort: 'created',
+        },
+        queryParamsFromFilterRules([
+          { rule_type: FILTER_HAS_TAGS_ALL, value: object.id.toString() },
+        ])
+      ),
+    })
 
     component.primaryAction(DataType.User, object)
     expect(modalSpy).toHaveBeenCalledWith(UserEditDialogComponent, {
@@ -442,17 +508,41 @@ describe('GlobalSearchComponent', () => {
     expect(focusSpy).toHaveBeenCalled()
   })
 
-  it('should prevent event propagation for keyboard events on buttons that are not arrows', () => {
-    const event = { stopImmediatePropagation: jest.fn(), key: 'Enter' }
-    const stopPropagationSpy = jest.spyOn(event, 'stopImmediatePropagation')
-    component.onButtonKeyDown(event as any)
-    expect(stopPropagationSpy).toHaveBeenCalled()
+  it('should support open in new window', () => {
+    const openSpy = jest.spyOn(window, 'open')
+    const event = new Event('click')
+    event['ctrlKey'] = true
+    component.primaryAction(DataType.Document, { id: 2 }, event as any)
+    expect(openSpy).toHaveBeenCalledWith('/documents/2', '_blank')
+
+    component.searchResults = searchResults as any
+    component.resultsDropdown.open()
+    fixture.detectChanges()
+
+    const button = component.primaryButtons.get(0).nativeElement
+    const keyboardEvent = new KeyboardEvent('keydown', {
+      key: 'Enter',
+      ctrlKey: true,
+    })
+    const dispatchSpy = jest.spyOn(button, 'dispatchEvent')
+    button.dispatchEvent(keyboardEvent)
+    expect(dispatchSpy).toHaveBeenCalledTimes(2) // once for keydown, second for click
   })
 
-  it('should support explicit advanced search', () => {
+  it('should support title content search and advanced search', () => {
     const qfSpy = jest.spyOn(documentListViewService, 'quickFilter')
     component.query = 'test'
-    component.runAdvanedSearch()
+    component.runFullSearch()
+    expect(qfSpy).toHaveBeenCalledWith([
+      { rule_type: FILTER_TITLE_CONTENT, value: 'test' },
+    ])
+
+    settingsService.set(
+      SETTINGS_KEYS.SEARCH_FULL_TYPE,
+      GlobalSearchType.ADVANCED
+    )
+    component.query = 'test'
+    component.runFullSearch()
     expect(qfSpy).toHaveBeenCalledWith([
       { rule_type: FILTER_FULLTEXT_QUERY, value: 'test' },
     ])

src-ui/src/app/components/app-frame/global-search/global-search.component.ts

@@ -14,7 +14,8 @@ import {
   FILTER_HAS_CORRESPONDENT_ANY,
   FILTER_HAS_DOCUMENT_TYPE_ANY,
   FILTER_HAS_STORAGE_PATH_ANY,
-  FILTER_HAS_TAGS_ANY,
+  FILTER_HAS_TAGS_ALL,
+  FILTER_TITLE_CONTENT,
 } from 'src/app/data/filter-rule-type'
 import { DataType } from 'src/app/data/datatype'
 import { ObjectWithId } from 'src/app/data/object-with-id'
@@ -41,6 +42,9 @@ import { TagEditDialogComponent } from '../../common/edit-dialog/tag-edit-dialog
 import { UserEditDialogComponent } from '../../common/edit-dialog/user-edit-dialog/user-edit-dialog.component'
 import { WorkflowEditDialogComponent } from '../../common/edit-dialog/workflow-edit-dialog/workflow-edit-dialog.component'
 import { HotKeyService } from 'src/app/services/hot-key.service'
+import { paramsFromViewState } from 'src/app/utils/query-params'
+import { SettingsService } from 'src/app/services/settings.service'
+import { GlobalSearchType, SETTINGS_KEYS } from 'src/app/data/ui-settings'
 
 @Component({
   selector: 'pngx-global-search',
@@ -62,6 +66,13 @@ export class GlobalSearchComponent implements OnInit {
   @ViewChildren('primaryButton') primaryButtons: QueryList<ElementRef>
   @ViewChildren('secondaryButton') secondaryButtons: QueryList<ElementRef>
 
+  get useAdvancedForFullSearch(): boolean {
+    return (
+      this.settingsService.get(SETTINGS_KEYS.SEARCH_FULL_TYPE) ===
+      GlobalSearchType.ADVANCED
+    )
+  }
+
   constructor(
     public searchService: SearchService,
     private router: Router,
@@ -70,7 +81,8 @@ export class GlobalSearchComponent implements OnInit {
     private documentListViewService: DocumentListViewService,
     private permissionsService: PermissionsService,
     private toastService: ToastService,
-    private hotkeyService: HotKeyService
+    private hotkeyService: HotKeyService,
+    private settingsService: SettingsService
   ) {
     this.queryDebounce = new Subject<string>()
 
@@ -87,7 +99,7 @@ export class GlobalSearchComponent implements OnInit {
       })
   }
 
-  ngOnInit() {
+  public ngOnInit() {
     this.hotkeyService
       .addShortcut({ keys: '/', description: $localize`Global search` })
       .subscribe(() => {
@@ -104,17 +116,22 @@ export class GlobalSearchComponent implements OnInit {
     })
   }
 
-  public primaryAction(type: string, object: ObjectWithId) {
+  public primaryAction(
+    type: string,
+    object: ObjectWithId,
+    event: PointerEvent = null
+  ) {
+    const newWindow = event?.metaKey || event?.ctrlKey
     this.reset(true)
     let filterRuleType: number
     let editDialogComponent: any
     let size: string = 'md'
     switch (type) {
       case DataType.Document:
-        this.router.navigate(['/documents', object.id])
+        this.navigateOrOpenInNewWindow(['/documents', object.id], newWindow)
         return
       case DataType.SavedView:
-        this.router.navigate(['/view', object.id])
+        this.navigateOrOpenInNewWindow(['/view', object.id], newWindow)
         return
       case DataType.Correspondent:
         filterRuleType = FILTER_HAS_CORRESPONDENT_ANY
@@ -126,7 +143,7 @@ export class GlobalSearchComponent implements OnInit {
         filterRuleType = FILTER_HAS_STORAGE_PATH_ANY
         break
       case DataType.Tag:
-        filterRuleType = FILTER_HAS_TAGS_ANY
+        filterRuleType = FILTER_HAS_TAGS_ALL
         break
       case DataType.User:
         editDialogComponent = UserEditDialogComponent
@@ -154,9 +171,17 @@ export class GlobalSearchComponent implements OnInit {
     }
 
     if (filterRuleType) {
-      this.documentListViewService.quickFilter([
-        { rule_type: filterRuleType, value: object.id.toString() },
-      ])
+      let params = paramsFromViewState({
+        filterRules: [
+          { rule_type: filterRuleType, value: object.id.toString() },
+        ],
+        currentPage: 1,
+        sortField: this.documentListViewService.sortField ?? 'created',
+        sortReverse: this.documentListViewService.sortReverse,
+      })
+      this.navigateOrOpenInNewWindow(['/documents'], newWindow, {
+        queryParams: params,
+      })
     } else if (editDialogComponent) {
       const modalRef: NgbModalRef = this.modalService.open(
         editDialogComponent,
@@ -213,6 +238,7 @@ export class GlobalSearchComponent implements OnInit {
 
   private reset(close: boolean = false) {
     this.queryDebounce.next(null)
+    this.query = null
     this.searchResults = null
     this.currentItemIndex = -1
     if (close) {
@@ -233,7 +259,7 @@ export class GlobalSearchComponent implements OnInit {
     item.nativeElement.focus()
   }
 
-  onItemHover(event: MouseEvent) {
+  public onItemHover(event: MouseEvent) {
     const item: ElementRef = this.resultItems
       .toArray()
       .find((item) => item.nativeElement === event.currentTarget)
@@ -241,7 +267,7 @@ export class GlobalSearchComponent implements OnInit {
     this.setCurrentItem()
   }
 
-  onButtonHover(event: MouseEvent) {
+  public onButtonHover(event: MouseEvent) {
     ;(event.currentTarget as HTMLElement).focus()
   }
 
@@ -262,19 +288,14 @@ export class GlobalSearchComponent implements OnInit {
       event.preventDefault()
       this.currentItemIndex = this.searchResults.total - 1
       this.setCurrentItem()
-    } else if (
-      event.key === 'Enter' &&
-      this.searchResults?.total === 1 &&
-      this.resultsDropdown.isOpen()
-    ) {
-      this.primaryButtons.first.nativeElement.click()
-      this.searchInput.nativeElement.blur()
-    } else if (
-      event.key === 'Enter' &&
-      this.searchResults?.total &&
-      !this.resultsDropdown.isOpen()
-    ) {
-      this.resultsDropdown.open()
+    } else if (event.key === 'Enter') {
+      if (this.searchResults?.total === 1 && this.resultsDropdown.isOpen()) {
+        this.primaryButtons.first.nativeElement.click()
+        this.searchInput.nativeElement.blur()
+      } else if (this.query?.length) {
+        this.runFullSearch()
+        this.reset(true)
+      }
     } else if (event.key === 'Escape' && !this.resultsDropdown.isOpen()) {
       if (this.query?.length) {
         this.reset(true)
@@ -284,7 +305,7 @@ export class GlobalSearchComponent implements OnInit {
     }
   }
 
-  dropdownKeyDown(event: KeyboardEvent) {
+  public dropdownKeyDown(event: KeyboardEvent) {
     if (
       this.searchResults?.total &&
       this.resultsDropdown.isOpen() &&
@@ -318,16 +339,18 @@ export class GlobalSearchComponent implements OnInit {
         event.preventDefault()
         event.stopImmediatePropagation()
         this.primaryButtons.get(this.domIndex).nativeElement.focus()
+      } else if (event.key === 'Escape') {
+        event.preventDefault()
+        event.stopImmediatePropagation()
+        this.reset(true)
+        this.searchInput.nativeElement.focus()
       }
     }
   }
 
-  onButtonKeyDown(event: KeyboardEvent) {
-    // prevents ngBootstrap issue with keydown events
-    if (
-      !['ArrowDown', 'ArrowUp', 'ArrowRight', 'ArrowLeft'].includes(event.key)
-    ) {
-      event.stopImmediatePropagation()
+  public onButtonKeyDown(event: KeyboardEvent) {
+    if (event.key === 'Enter' && (event.metaKey || event.ctrlKey)) {
+      event.target.dispatchEvent(new MouseEvent('click', { ctrlKey: true }))
     }
   }
 
@@ -366,10 +389,28 @@ export class GlobalSearchComponent implements OnInit {
     )
   }
 
-  runAdvanedSearch() {
+  public runFullSearch() {
+    const ruleType = this.useAdvancedForFullSearch
+      ? FILTER_FULLTEXT_QUERY
+      : FILTER_TITLE_CONTENT
     this.documentListViewService.quickFilter([
-      { rule_type: FILTER_FULLTEXT_QUERY, value: this.query },
+      { rule_type: ruleType, value: this.query },
     ])
     this.reset(true)
   }
+
+  private navigateOrOpenInNewWindow(
+    commands: any,
+    newWindow: boolean = false,
+    extras: Object = {}
+  ) {
+    if (newWindow) {
+      const url = this.router.serializeUrl(
+        this.router.createUrlTree(commands, extras)
+      )
+      window.open(url, '_blank')
+    } else {
+      this.router.navigate(commands, extras)
+    }
+  }
 }

src-ui/src/app/components/common/confirm-dialog/confirm-dialog.component.spec.ts

@@ -86,14 +86,4 @@ describe('ConfirmDialogComponent', () => {
     expect(closeModalSpy).toHaveBeenCalled()
     expect(confirmSubjectResult).toBeFalsy()
   })
-
-  it('should support delay confirm', fakeAsync(() => {
-    component.confirmButtonEnabled = false
-    component.delayConfirm(1)
-    expect(component.confirmButtonEnabled).toBeFalsy()
-    tick(1500)
-    fixture.detectChanges()
-    expect(component.confirmButtonEnabled).toBeTruthy()
-    discardPeriodicTasks()
-  }))
 })

src-ui/src/app/components/common/confirm-dialog/confirm-dialog.component.ts

@@ -54,26 +54,6 @@ export class ConfirmDialogComponent {
   confirmSubject: Subject<boolean>
   alternativeSubject: Subject<boolean>
 
-  delayConfirm(seconds: number) {
-    const refreshInterval = 0.15 // s
-
-    this.secondsTotal = seconds
-    this.seconds = seconds
-
-    interval(refreshInterval * 1000)
-      .pipe(
-        take(this.secondsTotal / refreshInterval + 2) // need 2 more for animation to complete after 0
-      )
-      .subscribe((count) => {
-        this.seconds = Math.max(
-          0,
-          this.secondsTotal - refreshInterval * (count + 1)
-        )
-        this.confirmButtonEnabled =
-          this.secondsTotal - refreshInterval * count < 0
-      })
-  }
-
   cancel() {
     this.confirmSubject?.next(false)
     this.confirmSubject?.complete()

src-ui/src/app/components/common/confirm-dialog/delete-pages-confirm-dialog/delete-pages-confirm-dialog.component.html

@@ -0,0 +1,54 @@
+<div class="modal-header">
+    <h4 class="modal-title" id="modal-basic-title">{{title}}</h4>
+    <button type="button" class="btn-close" aria-label="Close" (click)="cancel()">
+    </button>
+</div>
+<div class="modal-body">
+    <div class="row">
+        <div class="col">
+            <div class="btn-toolbar flex-nowrap">
+                <div class="input-group input-group-sm">
+                    <div class="input-group-text" i18n>Page</div>
+                    <input class="form-control mw-60" type="number" min="1" [(ngModel)]="currentPage" />
+                    <div class="input-group-text" i18n>of {{totalPages}}</div>
+                </div>
+                <div class="input-group input-group-sm ms-auto">
+                    <span class="input-group-text" i18n>Pages to remove</span>
+                    <input [ngModel]="pagesString" class="form-control" disabled />
+                </div>
+            </div>
+            <div class="pdf-viewer-container w-100 mt-3">
+                <pdf-viewer #pdfViewer [src]="pdfSrc" [(page)]="currentPage"
+                [original-size]="false"
+                [zoom]="1"
+                zoom-scale="page-fit"
+                [render-text]="false"
+                (pagerendered)="pageRendered($event)"
+                (after-load-complete)="pdfPreviewLoaded($event)">
+                </pdf-viewer>
+            </div>
+        </div>
+    </div>
+</div>
+<div class="modal-footer flex-nowrap">
+    <div>
+        @if (message) {
+            <p [innerHTML]="message | safeHtml"></p>
+        }
+        @if (messageBold) {
+            <p class="mb-0 small"><b [innerHTML]="messageBold | safeHtml"></b></p>
+        }
+    </div>
+    <button type="button" class="btn" [class]="cancelBtnClass" (click)="cancel()" [disabled]="!buttonsEnabled">
+            <span class="d-inline-block" style="padding-bottom: 1px;">{{cancelBtnCaption}}</span>
+        </button>
+    <button type="button" class="btn" [class]="btnClass" (click)="confirm()" [disabled]="!confirmButtonEnabled || !buttonsEnabled">
+        {{btnCaption}}
+    </button>
+</div>
+
+<ng-template #pageCheckOverlay let-page="page" let-pages="pages">
+    <div class="position-absolute top-0 start-0 w-100 h-100 p-2" (click)="pageCheckChanged(page)">
+        <input type="checkbox" class="form-check-input" />
+    </div>
+</ng-template>

src-ui/src/app/components/common/confirm-dialog/delete-pages-confirm-dialog/delete-pages-confirm-dialog.component.scss

@@ -0,0 +1,28 @@
+.pdf-viewer-container {
+  background-color: gray;
+  height: 350px;
+
+  pdf-viewer {
+    width: 100%;
+    height: 100%;
+  }
+}
+
+.mw-60 {
+  max-width: 60px;
+}
+
+div.position-absolute:has(.form-check-input:checked) {
+  background-color: rgba(var(--bs-dark-rgb), 0.4);
+}
+
+.form-check-input {
+  &:checked {
+    background-color: var(--bs-danger);
+    border-color: var(--bs-danger);
+  }
+  &:focus {
+    box-shadow: 0 0 0 0.25rem rgba(var(--bs-danger-rgb), var(--pngx-focus-alpha));
+    border-color: var(--bs-danger);
+  }
+}

src-ui/src/app/components/common/confirm-dialog/delete-pages-confirm-dialog/delete-pages-confirm-dialog.component.spec.ts

@@ -0,0 +1,60 @@
+import { ComponentFixture, TestBed } from '@angular/core/testing'
+import { DeletePagesConfirmDialogComponent } from './delete-pages-confirm-dialog.component'
+import { provideHttpClientTesting } from '@angular/common/http/testing'
+import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
+import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
+import { SafeHtmlPipe } from 'src/app/pipes/safehtml.pipe'
+import { FormsModule, ReactiveFormsModule } from '@angular/forms'
+import { PdfViewerComponent } from 'ng2-pdf-viewer'
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
+
+describe('DeletePagesConfirmDialogComponent', () => {
+  let component: DeletePagesConfirmDialogComponent
+  let fixture: ComponentFixture<DeletePagesConfirmDialogComponent>
+
+  beforeEach(async () => {
+    await TestBed.configureTestingModule({
+      declarations: [DeletePagesConfirmDialogComponent, PdfViewerComponent],
+      imports: [
+        NgxBootstrapIconsModule.pick(allIcons),
+        FormsModule,
+        ReactiveFormsModule,
+      ],
+      providers: [
+        NgbActiveModal,
+        SafeHtmlPipe,
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
+      ],
+    }).compileComponents()
+    fixture = TestBed.createComponent(DeletePagesConfirmDialogComponent)
+    component = fixture.componentInstance
+    fixture.detectChanges()
+  })
+
+  it('should return a string with comma-separated pages', () => {
+    component.pages = [1, 2, 3, 4]
+    expect(component.pagesString).toEqual('1, 2, 3, 4')
+  })
+
+  it('should update totalPages when pdf is loaded', () => {
+    component.pdfPreviewLoaded({ numPages: 5 } as any)
+    expect(component.totalPages).toEqual(5)
+  })
+
+  it('should update checks when page is rendered', () => {
+    const event = {
+      target: document.createElement('div'),
+      detail: { pageNumber: 1 },
+    } as any
+    component.pageRendered(event)
+    expect(component['checks'].length).toEqual(1)
+  })
+
+  it('should update pages when page check is changed', () => {
+    component.pageCheckChanged(1)
+    expect(component.pages).toEqual([1])
+    component.pageCheckChanged(1)
+    expect(component.pages).toEqual([])
+  })
+})

src-ui/src/app/components/common/confirm-dialog/delete-pages-confirm-dialog/delete-pages-confirm-dialog.component.ts

@@ -0,0 +1,64 @@
+import { Component, TemplateRef, ViewChild } from '@angular/core'
+import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
+import { DocumentService } from 'src/app/services/rest/document.service'
+import { ConfirmDialogComponent } from '../confirm-dialog.component'
+import { PDFDocumentProxy, PdfViewerComponent } from 'ng2-pdf-viewer'
+
+@Component({
+  selector: 'pngx-delete-pages-confirm-dialog',
+  templateUrl: './delete-pages-confirm-dialog.component.html',
+  styleUrl: './delete-pages-confirm-dialog.component.scss',
+})
+export class DeletePagesConfirmDialogComponent extends ConfirmDialogComponent {
+  public documentID: number
+  public pages: number[] = []
+  public currentPage: number = 1
+  public totalPages: number
+
+  @ViewChild('pdfViewer') pdfViewer: PdfViewerComponent
+  @ViewChild('pageCheckOverlay') pageCheckOverlay!: TemplateRef<any>
+  private checks: HTMLElement[] = []
+
+  public get pagesString(): string {
+    return this.pages.join(', ')
+  }
+
+  public get pdfSrc(): string {
+    return this.documentService.getPreviewUrl(this.documentID)
+  }
+
+  constructor(
+    activeModal: NgbActiveModal,
+    private documentService: DocumentService
+  ) {
+    super(activeModal)
+  }
+
+  public pdfPreviewLoaded(pdf: PDFDocumentProxy) {
+    this.totalPages = pdf.numPages
+  }
+
+  pageRendered(event: CustomEvent) {
+    const pageDiv = event.target as HTMLDivElement
+    const check = this.pageCheckOverlay.createEmbeddedView({
+      page: event.detail.pageNumber,
+    })
+    this.checks[event.detail.pageNumber - 1] = check.rootNodes[0]
+    pageDiv?.insertBefore(check.rootNodes[0], pageDiv.firstChild)
+    this.updateChecks()
+  }
+
+  pageCheckChanged(pageNumber: number) {
+    if (!this.pages.includes(pageNumber)) this.pages.push(pageNumber)
+    else if (this.pages.includes(pageNumber))
+      this.pages.splice(this.pages.indexOf(pageNumber), 1)
+    this.updateChecks()
+  }
+
+  private updateChecks() {
+    this.checks.forEach((check, i) => {
+      const input = check.getElementsByTagName('input')[0]
+      input.checked = this.pages.includes(i + 1)
+    })
+  }
+}