Just save this

[ci skip]

.codecov.yml

@@ -1,17 +1,19 @@
 codecov:
   require_ci_to_pass: true
-  # https://docs.codecov.com/docs/components
+# https://docs.codecov.com/docs/flags#recommended-automatic-flag-management
-component_management:
+# Require each flag to have 1 upload before notification
-  individual_components:
+flag_management:
-    - component_id: backend
+  individual_flags:
+    - name: backend
       paths:
-        - src/**
+        - src/
-    - component_id: frontend
+    - name: frontend
       paths:
-        - src-ui/**
+        - src-ui/
 # https://docs.codecov.com/docs/pull-request-comments
+# codecov will only comment if coverage changes
 comment:
-  layout: "header, diff, components, flags, files"
+  require_changes: true
   # https://docs.codecov.com/docs/javascript-bundle-analysis
   require_bundle_changes: true
   bundle_change_threshold: "50Kb"

.codespellrc

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

.devcontainer/Dockerfile

@@ -76,16 +76,18 @@ RUN set -eux \
     && apt-get update \
     && apt-get install --yes --quiet --no-install-recommends ${RUNTIME_PACKAGES}
 
-ARG PYTHON_PACKAGES="ca-certificates"
+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}
 
-COPY --from=ghcr.io/astral-sh/uv:0.7.8 /uv /bin/uv
-
-
 RUN set -eux \
   && echo "Installing pre-built updates" \
     && echo "Installing qpdf ${QPDF_VERSION}" \
@@ -121,14 +123,13 @@ RUN set -eux \
 WORKDIR /usr/src/paperless/src/docker/
 
 COPY [ \
-  "docker/rootfs/etc/ImageMagick-6/paperless-policy.xml", \
+  "docker/imagemagick-policy.xml", \
   "./" \
 ]
 
 RUN set -eux \
   && echo "Configuring ImageMagick" \
-    && mv paperless-policy.xml /etc/ImageMagick-6/policy.xml
+    && mv imagemagick-policy.xml /etc/ImageMagick-6/policy.xml
-
 
 # Packages needed only for building a few quick Python
 # dependencies
@@ -139,17 +140,18 @@ ARG BUILD_PACKAGES="\
   libpq-dev \
   # https://github.com/PyMySQL/mysqlclient#linux
   default-libmysqlclient-dev \
-  pkg-config"
+  pkg-config \
+  pre-commit"
 
 # hadolint ignore=DL3042
-RUN --mount=type=cache,target=/root/.cache/uv,id=pip-cache \
+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 -g pnpm
+  && npm update npm -g
 
 # add users, setup scripts
 # Mount the compiled frontend to expected location
@@ -167,6 +169,9 @@ RUN set -eux \
     && 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", \

.devcontainer/README.md

@@ -1,94 +0,0 @@
-# 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 `uv`)
-  - 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 and choose `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, run the `Project Setup: Run all Init Tasks` task to initialize the project.
-
-Alternatively, the Project Setup can be done with individual tasks:
-
-1. **Compile Frontend Assets**: `Maintenance: Compile frontend for production`.
-2. **Run Database Migrations**: `Maintenance: manage.py migrate`.
-3. **Create Superuser**: `Maintenance: manage.py createsuperuser`.
-
-### 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 and select `Tasks: Run Task`.
-2. 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 `uv`.
-- **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

@@ -3,7 +3,7 @@
     "dockerComposeFile": "docker-compose.devcontainer.sqlite-tika.yml",
     "service": "paperless-development",
     "workspaceFolder": "/usr/src/paperless/paperless-ngx",
-    "postCreateCommand": "/bin/bash -c 'uv sync --group dev && uv run pre-commit install'",
+    "postCreateCommand": "pipenv install --dev && pipenv run pre-commit install",
     "customizations": {
         "vscode": {
           "extensions": [

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

@@ -20,17 +20,20 @@
 #
 # 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.
+      context: ../    # Dockerfile cannot access files from parent directories if context is not set.
       dockerfile: ./.devcontainer/Dockerfile
     restart: unless-stopped
     depends_on:
@@ -40,7 +43,7 @@ services:
     volumes:
       - ..:/usr/src/paperless/paperless-ngx:delegated
       - ../.devcontainer/vscode:/usr/src/paperless/paperless-ngx/.vscode:delegated # VSCode config files
-      - virtualenv:/usr/src/paperless/paperless-ngx/.venv # Virtual environment persisted in volume
+      - pipenv:/usr/src/paperless/paperless-ngx/.venv
       - /usr/src/paperless/paperless-ngx/src/documents/static/frontend # Static frontend files exist only in container
       - /usr/src/paperless/paperless-ngx/src/.pytest_cache
       - /usr/src/paperless/paperless-ngx/.ruff_cache
@@ -57,22 +60,24 @@ services:
       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:8.17
+    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:
+  pipenv:
-  media:
-  redisdata:
-  virtualenv:

.devcontainer/vscode/settings.json

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

.devcontainer/vscode/tasks.json

@@ -5,7 +5,7 @@
 			"label": "Start: Celery Worker",
 			"description": "Start the Celery Worker which processes background and consume tasks",
 			"type": "shell",
-			"command": "uv run celery --app paperless worker -l DEBUG",
+			"command": "pipenv run celery --app paperless worker -l DEBUG",
 			"isBackground": true,
 			"options": {
 				"cwd": "${workspaceFolder}/src"
@@ -33,7 +33,7 @@
 			"label": "Start: Frontend Angular",
 			"description": "Start the Frontend Angular Dev Server",
 			"type": "shell",
-			"command": "pnpm start",
+			"command": "npm start",
 			"isBackground": true,
 			"options": {
 				"cwd": "${workspaceFolder}/src-ui"
@@ -61,7 +61,7 @@
 			"label": "Start: Consumer Service (manage.py document_consumer)",
 			"description": "Start the Consumer Service which processes files from a directory",
 			"type": "shell",
-			"command": "uv run python manage.py document_consumer",
+			"command": "pipenv run python manage.py document_consumer",
 			"group": "build",
 			"presentation": {
 				"echo": true,
@@ -80,7 +80,7 @@
 			"label": "Start: Backend Server (manage.py runserver)",
 			"description": "Start the Backend Server which serves the Django API and the compiled Angular frontend",
 			"type": "shell",
-			"command": "uv run python manage.py runserver",
+			"command": "pipenv run python manage.py runserver",
 			"group": "build",
 			"presentation": {
 				"echo": true,
@@ -99,7 +99,7 @@
 			"label": "Maintenance: manage.py migrate",
 			"description": "Apply database migrations",
 			"type": "shell",
-			"command": "uv run python manage.py migrate",
+			"command": "pipenv run python manage.py migrate",
 			"group": "none",
 			"presentation": {
 				"echo": true,
@@ -118,7 +118,7 @@
 			"label": "Maintenance: Build Documentation",
 			"description": "Build the documentation with MkDocs",
 			"type": "shell",
-			"command": "uv run mkdocs build --config-file mkdocs.yml && uv run mkdocs serve",
+			"command": "pipenv run mkdocs build --config-file mkdocs.yml && pipenv run mkdocs serve",
 			"group": "none",
 			"presentation": {
 				"echo": true,
@@ -137,7 +137,7 @@
 			"label": "Maintenance: manage.py createsuperuser",
 			"description": "Create a superuser",
 			"type": "shell",
-			"command": "uv run python manage.py createsuperuser",
+			"command": "pipenv run python manage.py createsuperuser",
 			"group": "none",
 			"presentation": {
 				"echo": true,
@@ -156,7 +156,7 @@
 			"label": "Maintenance: recreate .venv",
 			"description": "Recreate the python virtual environment and install python dependencies",
 			"type": "shell",
-			"command": "rm -rf .venv && uv venv && uv sync --dev",
+			"command": "rm -R -v .venv/* || pipenv install --dev",
 			"group": "none",
 			"presentation": {
 				"echo": true,
@@ -173,8 +173,8 @@
 		},
 		{
 			"label": "Maintenance: Install Frontend Dependencies",
-			"description": "Install frontend (pnpm) dependencies",
+			"description": "Install frontend (npm) dependencies",
-			"type": "pnpm",
+			"type": "npm",
 			"script": "install",
 			"path": "src-ui",
 			"group": "clean",
@@ -185,7 +185,7 @@
 			"description": "Clean install frontend dependencies and build the frontend for production",
 			"label": "Maintenance: Compile frontend for production",
 			"type": "shell",
-			"command": "pnpm install && ./node_modules/.bin/ng build --configuration production",
+			"command": "npm ci && ./node_modules/.bin/ng build --configuration production",
 			"group": "none",
 			"presentation": {
 				"echo": true,

.dockerignore

@@ -26,5 +26,3 @@
 ./dist
 ./scripts
 ./resources
-# Other stuff
-**/*.drawio.png

.editorconfig

@@ -27,6 +27,9 @@ indent_style = space
 [*.md]
 indent_style = space
 
+[Pipfile.lock]
+indent_style = space
+
 # Tests don't get a line width restriction.  It's still a good idea to follow
 # the 79 character rule, but in the interests of clarity, tests often need to
 # violate it.

.github/DISCUSSION_TEMPLATE/support.yml

@@ -1,55 +0,0 @@
-title: "[Support] "
-body:
-  - type: textarea
-    id: description
-    attributes:
-      label: What's your question or issue?
-      description: Provide a clear and concise description of what you're trying to do, and what's going wrong.
-      placeholder: |
-        I'm trying to...
-
-        [Include screenshots if helpful]
-    validations:
-      required: true
-  - type: textarea
-    id: steps
-    attributes:
-      label: What have you tried?
-      description: Describe any steps you've already taken to troubleshoot or solve the issue.
-      placeholder: |
-        - I checked the logs and saw...
-        - I followed the install guide and tried...
-  - type: input
-    id: version
-    attributes:
-      label: Paperless-ngx version
-      placeholder: e.g. 1.14.0
-    validations:
-      required: true
-  - type: input
-    id: host-os
-    attributes:
-      label: Host OS
-      description: Include architecture if relevant.
-      placeholder: e.g. Ubuntu 22.04 / Raspberry Pi arm64
-  - type: dropdown
-    id: install-method
-    attributes:
-      label: Installation method
-      options:
-        - Docker - official image
-        - Docker - linuxserver.io image
-        - Bare metal
-        - Other (please describe above)
-  - 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: textarea
-    id: logs
-    attributes:
-      label: Relevant logs or output
-      description: If you have logs, errors that might help, paste it here.
-      render: bash

.github/FUNDING.yml

@@ -1 +0,0 @@
-github: [shamoon, stumpylog]

.github/dependabot.yml

@@ -1,13 +1,12 @@
-# Please see the documentation for all configuration options:
+# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#package-ecosystem
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
 version: 2
-# Required for uv support for now
-enable-beta-ecosystems: true
 updates:
-  # Enable version updates for pnpm
+
+  # Enable version updates for npm
   - package-ecosystem: "npm"
     target-branch: "dev"
-    # Look for `pnpm-lock.yaml` file in the `/src-ui` directory
+    # Look for `package.json` and `lock` files in the `/src-ui` directory
     directory: "/src-ui"
     open-pull-requests-limit: 10
     schedule:
@@ -15,6 +14,9 @@ updates:
     labels:
       - "frontend"
       - "dependencies"
+    # Add reviewers
+    reviewers:
+      - "paperless-ngx/frontend"
     groups:
       frontend-angular-dependencies:
         patterns:
@@ -30,9 +32,11 @@ updates:
         patterns:
           - "@typescript-eslint*"
           - "eslint"
+
   # Enable version updates for Python
-  - package-ecosystem: "uv"
+  - package-ecosystem: "pip"
     target-branch: "dev"
+    # Look for a `Pipfile` in the `root` directory
     directory: "/"
     # Check for updates once a week
     schedule:
@@ -40,17 +44,20 @@ updates:
     labels:
       - "backend"
       - "dependencies"
+    # Add reviewers
+    reviewers:
+      - "paperless-ngx/backend"
+    ignore:
+      - dependency-name: "uvicorn"
     groups:
       development:
         patterns:
           - "*pytest*"
           - "ruff"
           - "mkdocs-material"
-          - "pre-commit*"
       django:
         patterns:
           - "*django*"
-          - "drf-*"
       major-versions:
         update-types:
           - "major"
@@ -58,13 +65,7 @@ updates:
         update-types:
           - "minor"
           - "patch"
-        exclude-patterns:
+
-          - "*django*"
-          - "drf-*"
-      pre-built:
-        patterns:
-          - psycopg*
-          - zxing-cpp
   # Enable updates for GitHub Actions
   - package-ecosystem: "github-actions"
     target-branch: "dev"
@@ -75,50 +76,12 @@ updates:
     labels:
       - "ci-cd"
       - "dependencies"
+    # Add reviewers
+    reviewers:
+      - "paperless-ngx/ci-cd"
     groups:
       actions:
         update-types:
           - "major"
           - "minor"
           - "patch"
-  # Update Dockerfile in root directory
-  - package-ecosystem: "docker"
-    directories:
-      - "/"
-      - "/.devcontainer/"
-    schedule:
-      interval: "weekly"
-    open-pull-requests-limit: 5
-    labels:
-      - "dependencies"
-    commit-message:
-      prefix: "docker"
-      include: "scope"
-  # Update Docker Compose files in docker/compose directory
-  - package-ecosystem: "docker-compose"
-    directory: "/docker/compose/"
-    schedule:
-      interval: "weekly"
-    open-pull-requests-limit: 5
-    labels:
-      - "dependencies"
-    commit-message:
-      prefix: "docker-compose"
-      include: "scope"
-    groups:
-      # Individual groups for each image
-      gotenberg:
-        patterns:
-          - "docker.io/gotenberg/gotenberg*"
-      tika:
-        patterns:
-          - "docker.io/apache/tika*"
-      redis:
-        patterns:
-          - "docker.io/library/redis*"
-      mariadb:
-        patterns:
-          - "docker.io/library/mariadb*"
-      postgres:
-        patterns:
-          - "docker.io/library/postgres*"

.github/labeler.yml

@@ -1,26 +0,0 @@
-backend:
-  - changed-files:
-      - any-glob-to-any-file:
-          - 'src/**'
-          - 'pyproject.toml'
-          - 'uv.lock'
-          - 'requirements.txt'
-frontend:
-  - changed-files:
-      - any-glob-to-any-file:
-          - 'src-ui/**'
-documentation:
-  - changed-files:
-      - any-glob-to-any-file:
-          - 'docs/**'
-ci-cd:
-  - changed-files:
-      - any-glob-to-any-file:
-          - '.github/**'
-# pr types
-bug:
-  - head-branch:
-      - ['^fix']
-enhancement:
-  - head-branch:
-      - ['^feature']

.github/release-drafter.yml

@@ -1,3 +1,15 @@
+autolabeler:
+  - label: "bug"
+    branch:
+      - '/^fix/'
+    title:
+      - "/^fix/i"
+      - "/^Bugfix/i"
+  - label: "enhancement"
+    branch:
+      - '/^feature/'
+    title:
+      - "/^feature/i"
 categories:
   - title: 'Breaking Changes'
     labels:
@@ -5,7 +17,7 @@ categories:
   - title: 'Notable Changes'
     labels:
       - 'notable'
-  - title: 'Features / Enhancements'
+  - title: 'Features'
     labels:
       - 'enhancement'
   - title: 'Bug Fixes'

.github/workflows/cleanup-tags.yml

@@ -4,15 +4,19 @@
 # Requires a PAT with the correct scope set in the secrets.
 #
 # This workflow will not trigger runs on forked repos.
+
 name: Cleanup Image Tags
+
 on:
   delete:
   push:
     paths:
       - ".github/workflows/cleanup-tags.yml"
+
 concurrency:
   group: registry-tags-cleanup
   cancel-in-progress: false
+
 jobs:
   cleanup-images:
     name: Cleanup Image Tags for ${{ matrix.primary-name }}
@@ -26,9 +30,10 @@ jobs:
       # Requires a personal access token with the OAuth scope delete:packages
       TOKEN: ${{ secrets.GHA_CONTAINER_DELETE_TOKEN }}
     steps:
-      - name: Clean temporary images
+      -
+        name: Clean temporary images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/ephemeral@v0.10.0
+        uses: stumpylog/image-cleaner-action/ephemeral@v0.9.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "${{ github.repository_owner }}"
@@ -38,6 +43,7 @@ jobs:
           repo_name: "paperless-ngx"
           match_regex: "(feature|fix)"
           do_delete: "true"
+
   cleanup-untagged-images:
     name: Cleanup Untagged Images Tags for ${{ matrix.primary-name }}
     if: github.repository_owner == 'paperless-ngx'
@@ -52,9 +58,10 @@ jobs:
       # Requires a personal access token with the OAuth scope delete:packages
       TOKEN: ${{ secrets.GHA_CONTAINER_DELETE_TOKEN }}
     steps:
-      - name: Clean untagged images
+      -
+        name: Clean untagged images
         if: "${{ env.TOKEN != '' }}"
-        uses: stumpylog/image-cleaner-action/untagged@v0.10.0
+        uses: stumpylog/image-cleaner-action/untagged@v0.9.0
         with:
           token: "${{ env.TOKEN }}"
           owner: "${{ github.repository_owner }}"

.github/workflows/codeql-analysis.yml

@@ -10,14 +10,16 @@
 # supported CodeQL languages.
 #
 name: "CodeQL"
+
 on:
   push:
-    branches: [main, dev]
+    branches: [ main, dev ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [dev]
+    branches: [ dev ]
   schedule:
     - cron: '28 13 * * 5'
+
 jobs:
   analyze:
     name: Analyze
@@ -26,23 +28,27 @@ jobs:
       actions: read
       contents: read
       security-events: write
+
     strategy:
       fail-fast: false
       matrix:
-        language: ['javascript', 'python']
+        language: [ 'javascript', 'python' ]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
     steps:
-      - name: Checkout repository
+    - name: Checkout repository
-        uses: actions/checkout@v4
+      uses: actions/checkout@v4
-      # Initializes the CodeQL tools for scanning.
+
-      - name: Initialize CodeQL
+    # Initializes the CodeQL tools for scanning.
-        uses: github/codeql-action/init@v3
+    - name: Initialize CodeQL
-        with:
+      uses: github/codeql-action/init@v3
-          languages: ${{ matrix.language }}
+      with:
-          # If you wish to specify custom queries, you can do so here or in a config file.
+        languages: ${{ matrix.language }}
-          # By default, queries listed here will override any specified in a config file.
+        # If you wish to specify custom queries, you can do so here or in a config file.
-          # Prefix the list here with "+" to use these queries and those in the config file.
+        # By default, queries listed here will override any specified in a config file.
-          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+        # Prefix the list here with "+" to use these queries and those in the config file.
-      - name: Perform CodeQL Analysis
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-        uses: github/codeql-action/analyze@v3
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

.github/workflows/crowdin.yml

@@ -1,30 +1,35 @@
 name: Crowdin Action
+
 on:
   workflow_dispatch:
   schedule:
     - cron: '2 */12 * * *'
   push:
-    paths: ['src/locale/**', 'src-ui/messages.xlf', 'src-ui/src/locale/**']
+    paths: [
-    branches: [dev]
+      'src/locale/**',
+      'src-ui/messages.xlf',
+      'src-ui/src/locale/**'
+    ]
+    branches: [ dev ]
+
 jobs:
   synchronize-with-crowdin:
     name: Crowdin Sync
     if: github.repository_owner == 'paperless-ngx'
     runs-on: ubuntu-24.04
+
     steps:
-      - name: Checkout
+    - name: Checkout
-        uses: actions/checkout@v4
+      uses: actions/checkout@v4
-        with:
+    - name: crowdin action
-          token: ${{ secrets.PNGX_BOT_PAT }}
+      uses: crowdin/github-action@v2
-      - name: crowdin action
+      with:
-        uses: crowdin/github-action@v2
+        upload_translations: false
-        with:
+        download_translations: true
-          upload_translations: false
+        crowdin_branch_name: 'dev'
-          download_translations: true
+        localization_branch_name: l10n_dev
-          crowdin_branch_name: 'dev'
+        pull_request_labels: 'skip-changelog, translation'
-          localization_branch_name: l10n_dev
+      env:
-          pull_request_labels: 'skip-changelog, translation'
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        env:
+        CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
-          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
-          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

.github/workflows/pr-bot.yml

@@ -1,112 +0,0 @@
-name: PR Bot
-on:
-  pull_request_target:
-    types: [opened]
-permissions:
-  contents: read
-  pull-requests: write
-jobs:
-  pr-bot:
-    name: Automated PR Bot
-    runs-on: ubuntu-latest
-    steps:
-      - name: Label PR by file path or branch name
-        # see .github/labeler.yml for the labeler config
-        uses: actions/labeler@v5
-        with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Label by size
-        uses: Gascon1/pr-size-labeler@v1.3.0
-        with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          xs_label: 'small-change'
-          xs_diff: '9'
-          s_label: 'non-trivial'
-          s_diff: '99999'
-          fail_if_xl: 'false'
-          excluded_files: /\.lock$/ /\.txt$/ ^src-ui/pnpm-lock\.yaml$ ^src-ui/messages\.xlf$ ^src/locale/en_US/LC_MESSAGES/django\.po$
-      - name: Label by PR title
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const pr = context.payload.pull_request;
-            const title = pr.title.toLowerCase();
-            const labels = [];
-
-            if (/^(fix|bugfix)/i.test(title)) {
-              labels.push('bug');
-            } else if (/^feature/i.test(title)) {
-              labels.push('enhancement');
-            } else if (!/^(dependabot)/i.test(title)) {
-              labels.push('enhancement'); // Default fallback
-            }
-
-            if (labels.length) {
-              await github.rest.issues.addLabels({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                issue_number: pr.number,
-                labels,
-              });
-              core.info(`Added labels based on title: ${labels.join(', ')}`);
-            }
-      - name: Label bot-generated PRs
-        if: ${{ contains(github.actor, 'dependabot') || contains(github.actor, 'crowdin-bot') }}
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const pr = context.payload.pull_request;
-            const user = pr.user.login.toLowerCase();
-            const labels = [];
-
-            if (user.includes('dependabot')) {
-              labels.push('dependencies');
-            }
-
-            if (user.includes('crowdin-bot')) {
-              labels.push('translation', 'skip-changelog');
-            }
-
-            if (labels.length) {
-              await github.rest.issues.addLabels({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                issue_number: pr.number,
-                labels,
-              });
-            }
-      - name: Welcome comment
-        if: ${{ !contains(github.actor, 'bot') }}
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const pr = context.payload.pull_request;
-            const user = pr.user.login;
-
-            const { data: members } = await github.rest.orgs.listMembers({
-              org: 'paperless-ngx',
-            });
-
-            const memberLogins = members.map(m => m.login.toLowerCase());
-            if (memberLogins.includes(user.toLowerCase())) {
-              core.info('Skipping comment: user is org member');
-              return;
-            }
-
-            const body =
-                "Hello @" + user + ",\n\n" +
-                "Thank you very much for submitting this PR to us!\n\n" +
-                "This is what will happen next:\n\n" +
-                "1. CI tests will run against your PR to ensure quality and consistency.\n" +
-                "2. Next, human contributors from paperless-ngx review your changes.\n" +
-                "3. Please address any issues that come up during the review as soon as you are able to.\n" +
-                "4. If accepted, your pull request will be merged into the `dev` branch and changes there will be tested further.\n" +
-                "5. Eventually, changes from you and other contributors will be merged into `main` and a new release will be made.\n\n" +
-                "You'll be hearing from us soon, and thank you again for contributing to our project.";
-
-            await github.rest.issues.createComment({
-              issue_number: pr.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body,
-            });

.github/workflows/project-actions.yml

@@ -1,4 +1,5 @@
 name: Project Automations
+
 on:
   pull_request_target: #_target allows access to secrets
     types:
@@ -7,8 +8,10 @@ on:
     branches:
       - main
       - dev
+
 permissions:
   contents: read
+
 jobs:
   pr_opened_or_reopened:
     name: pr_opened_or_reopened

.github/workflows/repo-maintenance.yml

@@ -1,14 +1,18 @@
 name: 'Repository Maintenance'
+
 on:
   schedule:
     - cron: '0 3 * * *'
   workflow_dispatch:
+
 permissions:
   issues: write
   pull-requests: write
   discussions: write
+
 concurrency:
   group: lock
+
 jobs:
   stale:
     name: 'Stale'
@@ -19,19 +23,13 @@ jobs:
         with:
           days-before-stale: 7
           days-before-close: 14
-          any-of-issue-labels: 'cant-reproduce,not a bug'
+          any-of-labels: 'stale,cant-reproduce,not a bug'
           stale-issue-label: stale
-          stale-issue-message: >
-            This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. See our [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/dev/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
-
-          days-before-pr-stale: 14
-          days-before-pr-close: 7
-          stale-pr-message: ""
           stale-pr-label: stale
-          exempt-pr-labels: 'notable'
+          stale-issue-message: >
-          close-pr-message: >
+            This issue has been automatically marked as stale because it has not had
-            This pull request has been automatically closed because it has not had recent activity. Thank you for your contributions. Please open a new pull request or discussion if you would like to continue working on this change.
+            recent activity. It will be closed if no further activity occurs. Thank you
-
+            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'
@@ -44,14 +42,20 @@ jobs:
           discussion-inactive-days: '30'
           log-output: true
           issue-comment: >
-            This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion or issue for related concerns. See our [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/dev/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
+            This issue has been automatically locked since there
-
+            has not been any recent activity after it was closed.
+            Please open a new discussion or issue for related concerns.
+            See our [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/dev/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
           pr-comment: >
-            This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion or issue for related concerns. See our [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/dev/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
+            This pull request has been automatically locked since there
-
+            has not been any recent activity after it was closed.
+            Please open a new discussion or issue for related concerns.
+            See our [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/dev/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
           discussion-comment: >
-            This discussion has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/dev/CONTRIBUTING.md#automatic-repository-maintenance) for more details.
+            This discussion has been automatically locked since there
-
+            has not been any recent activity after it was closed.
+            Please open a new discussion for related concerns.
+            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'

.github/workflows/translate-strings.yml

@@ -1,69 +0,0 @@
-name: Generate Translation Strings
-on:
-  push:
-    branches:
-      - dev
-jobs:
-  generate-translate-strings:
-    name: Generate Translation Strings
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.PNGX_BOT_PAT }}
-          ref: ${{ github.head_ref }}
-      - name: Set up Python
-        id: setup-python
-        uses: actions/setup-python@v5
-      - name: Install system dependencies
-        run: |
-          sudo apt-get update -qq
-          sudo apt-get install -qq --no-install-recommends gettext
-      - name: Install uv
-        uses: astral-sh/setup-uv@v6
-        with:
-          enable-cache: true
-      - name: Install backend python dependencies
-        run: |
-          uv sync \
-            --group dev \
-            --frozen
-      - name: Generate backend translation strings
-        run: cd src/ && uv run manage.py makemessages -l en_US -i "samples*"
-      - name: Install pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: 10
-      - name: Use Node.js 20
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          cache: 'pnpm'
-          cache-dependency-path: 'src-ui/pnpm-lock.yaml'
-      - name: Cache frontend dependencies
-        id: cache-frontend-deps
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.pnpm-store
-            ~/.cache
-          key: ${{ runner.os }}-frontenddeps-${{ hashFiles('src-ui/pnpm-lock.yaml') }}
-      - name: Install frontend dependencies
-        if: steps.cache-frontend-deps.outputs.cache-hit != 'true'
-        run: cd src-ui && pnpm install
-      - name: Re-link Angular cli
-        run: cd src-ui && pnpm link @angular/cli
-      - name: Generate frontend translation strings
-        run: |
-          cd src-ui
-          pnpm run ng extract-i18n
-      - name: Commit changes
-        uses: stefanzweifel/git-auto-commit-action@v6
-        with:
-          file_pattern: 'src-ui/messages.xlf src/locale/en_US/LC_MESSAGES/django.po'
-          commit_message: "Auto translate strings"
-          commit_user_name: "GitHub Actions"
-          commit_author: "GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>"

.gitignore

@@ -44,7 +44,6 @@ nosetests.xml
 coverage.xml
 *,cover
 .pytest_cache
-junit.xml
 
 # Translations
 *.mo

.pre-commit-config.yaml

@@ -1,6 +1,7 @@
 # This file configures pre-commit hooks.
 # See https://pre-commit.com/ for general information
 # See https://pre-commit.com/hooks.html for a listing of possible hooks
+
 repos:
   # General hooks
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -28,38 +29,35 @@ repos:
       - id: check-case-conflict
       - id: detect-private-key
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.4.1
+    rev: v2.3.0
     hooks:
       - id: codespell
-        additional_dependencies: [tomli]
+        exclude: "(^src-ui/src/locale/)|(^src-ui/e2e/)|(^src/paperless_mail/tests/samples/)"
         exclude_types:
           - pofile
           - json
   # See https://github.com/prettier/prettier/issues/15742 for the fork reason
   - repo: https://github.com/rbubley/mirrors-prettier
-    rev: 'v3.6.2'
+    rev: 'v3.3.3'
     hooks:
       - id: prettier
         types_or:
           - javascript
           - ts
           - markdown
+        exclude: "(^Pipfile\\.lock$)"
         additional_dependencies:
           - prettier@3.3.3
           - 'prettier-plugin-organize-imports@4.1.0'
   # Python hooks
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.2
+    rev: v0.9.2
     hooks:
       - id: ruff
       - id: ruff-format
-  - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: "v2.6.0"
-    hooks:
-      - id: pyproject-fmt
   # Dockerfile hooks
   - repo: https://github.com/AleksaC/hadolint-py
-    rev: v2.12.1b3
+    rev: v2.12.0.3
     hooks:
       - id: hadolint
   # Shell script hooks
@@ -75,8 +73,3 @@ repos:
     rev: "v0.10.0.1"
     hooks:
       - id: shellcheck
-  - repo: https://github.com/google/yamlfmt
-    rev: v0.17.2
-    hooks:
-      - id: yamlfmt
-        exclude: "^src-ui/pnpm-lock.yaml"

.python-version

@@ -0,0 +1 @@
+3.10.15

.ruff.toml

@@ -0,0 +1,85 @@
+fix = true
+line-length = 88
+respect-gitignore = true
+src = ["src"]
+target-version = "py310"
+output-format = "grouped"
+show-fixes = true
+
+# https://docs.astral.sh/ruff/settings/
+# https://docs.astral.sh/ruff/rules/
+[lint]
+extend-select = [
+  "W",     # https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+  "I",     # https://docs.astral.sh/ruff/rules/#isort-i
+  "UP",    # https://docs.astral.sh/ruff/rules/#pyupgrade-up
+  "COM",   # https://docs.astral.sh/ruff/rules/#flake8-commas-com
+  "DJ",    # https://docs.astral.sh/ruff/rules/#flake8-django-dj
+  "EXE",   # https://docs.astral.sh/ruff/rules/#flake8-executable-exe
+  "ISC",   # https://docs.astral.sh/ruff/rules/#flake8-implicit-str-concat-isc
+  "ICN",   # https://docs.astral.sh/ruff/rules/#flake8-import-conventions-icn
+  "G201",  # https://docs.astral.sh/ruff/rules/#flake8-logging-format-g
+  "INP",   # https://docs.astral.sh/ruff/rules/#flake8-no-pep420-inp
+  "PIE",   # https://docs.astral.sh/ruff/rules/#flake8-pie-pie
+  "Q",     # https://docs.astral.sh/ruff/rules/#flake8-quotes-q
+  "RSE",   # https://docs.astral.sh/ruff/rules/#flake8-raise-rse
+  "T20",   # https://docs.astral.sh/ruff/rules/#flake8-print-t20
+  "SIM",   # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
+  "TID",   # https://docs.astral.sh/ruff/rules/#flake8-tidy-imports-tid
+  "TCH",   # https://docs.astral.sh/ruff/rules/#flake8-type-checking-tch
+  "PLC",   # https://docs.astral.sh/ruff/rules/#pylint-pl
+  "PLE",   # https://docs.astral.sh/ruff/rules/#pylint-pl
+  "RUF",   # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
+  "FLY",   # https://docs.astral.sh/ruff/rules/#flynt-fly
+  "PTH",   # https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+]
+ignore = ["DJ001", "SIM105", "RUF012"]
+
+[lint.per-file-ignores]
+".github/scripts/*.py" = ["E501", "INP001", "SIM117"]
+"docker/wait-for-redis.py" = ["INP001", "T201"]
+"src/documents/consumer.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/file_handling.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/management/commands/document_consumer.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/management/commands/document_exporter.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/migrations/0012_auto_20160305_0040.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/migrations/0014_document_checksum.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/migrations/1003_mime_types.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/migrations/1012_fix_archive_files.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/models.py" = ["SIM115", "PTH"]  # TODO PTH Enable & remove
+"src/documents/parsers.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/signals/handlers.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tasks.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_api_app_config.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_api_bulk_download.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_api_documents.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_classifier.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_consumer.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_file_handling.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_management.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_management_consumer.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_management_exporter.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_management_thumbnails.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_migration_archive_files.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_migration_document_pages_count.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_migration_mime_type.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_sanity_check.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_tasks.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/tests/test_views.py" = ["PTH"]  # TODO Enable & remove
+"src/documents/views.py" = ["PTH"]  # TODO Enable & remove
+"src/paperless/checks.py" = ["PTH"]  # TODO Enable & remove
+"src/paperless/settings.py" = ["PTH"]  # TODO Enable & remove
+"src/paperless/tests/test_checks.py" = ["PTH"]  # TODO Enable & remove
+"src/paperless/urls.py" = ["PTH"]  # TODO Enable & remove
+"src/paperless/views.py" = ["PTH"]  # TODO Enable & remove
+"src/paperless_mail/mail.py" = ["PTH"]  # TODO Enable & remove
+"src/paperless_mail/preprocessor.py" = ["PTH"]  # TODO Enable & remove
+"src/paperless_tesseract/parsers.py" = ["PTH"]  # TODO Enable & remove
+"src/paperless_tesseract/tests/test_parser.py" = ["RUF001", "PTH"]  # TODO PTH Enable & remove
+"src/paperless_tika/tests/test_live_tika.py" = ["PTH"]  # TODO Enable & remove
+"src/paperless_tika/tests/test_tika_parser.py" = ["PTH"]  # TODO Enable & remove
+"*/tests/*.py" = ["E501", "SIM117"]
+"*/migrations/*.py" = ["E501", "SIM", "T201"]
+
+[lint.isort]
+force-single-line = true

CODEOWNERS

@@ -5,6 +5,5 @@
 /src-ui/ @paperless-ngx/frontend
 
 /src/ @paperless-ngx/backend
-pyproject.toml @paperless-ngx/backend
+Pipfile* @paperless-ngx/backend
-uv.lock @paperless-ngx/backend
 *.py @paperless-ngx/backend

CONTRIBUTING.md

@@ -37,8 +37,6 @@ Before you can run `pytest`, ensure to [properly set up your local environment](
 
 Once you have submitted a **P**ull **R**equest it will be reviewed, approved, and merged by one or more community members of any team. Automated code tests and formatting checks must be passed.
 
-Important: Pull requests that implement a new feature or enhancement _should almost always target an existing feature request_ with evidence of community interest and discussion. This is in order to balance the work of implementing and maintaining new features / enhancements. Instead of opening a PR which does not meet this requirement, please open a feature request instead, to gather feedback from both users and the project maintainers.
-
 ## Non-Trivial Requests
 
 PRs deemed `non-trivial` will go through a stricter review process before being merged into `dev`. This is to ensure code quality and complete functionality (free of side effects).
@@ -83,7 +81,7 @@ Some notes about translation:
 
 If a language has already been added, and you would like to contribute new translations or change existing translations, please read the "Translation" section in the README.md file for further details on that.
 
-If you would like the project to be translated to another language, first head over to https://crowdin.com/project/paperless-ngx to check if that language has already been enabled for translation.
+If you would like the project to be translated to another language, first head over to https://crwd.in/paperless-ngx to check if that language has already been enabled for translation.
 If not, please request the language to be added by creating an issue on GitHub. The issue should contain:
 
 - English name of the language (the localized name can be added on Crowdin).
@@ -111,12 +109,28 @@ Paperless-ngx is a community project. We do our best to delegate permission and
 
 ## Structure
 
-There are currently 2 members in paperless-ngx with complete administrative privileges to the repo:
+As of writing, there are 21 members in paperless-ngx. 4 of these people have complete administrative privileges to the repo:
 
 - [@shamoon](https://github.com/shamoon)
-- [@stumpylog](https://github.com/stumpylog)
+- [@bauerj](https://github.com/bauerj)
+- [@qcasey](https://github.com/qcasey)
+- [@FrankStrieter](https://github.com/FrankStrieter)
 
-There are other members who occasionally contribute but we are actively seeking more dedicated maintainers of the project. Please reach out if you are interested.
+There are 5 teams collaborating on specific tasks within paperless-ngx:
+
+- @paperless-ngx/backend (Python / django)
+- @paperless-ngx/frontend (JavaScript / Typescript)
+- @paperless-ngx/ci-cd (GitHub Actions / Deployment)
+- @paperless-ngx/issues (Issue triage)
+- @paperless-ngx/test (General testing for larger PRs)
+
+## Permissions
+
+All team members are notified when mentioned or assigned to a relevant issue or pull request. Additionally, each team has slightly different access to paperless-ngx:
+
+- The **test** team has no special permissions.
+- The **issues** team has `triage` access. This means they can organize issues and pull requests.
+- The **backend**, **frontend**, and **ci-cd** teams have `write` access. This means they can approve PRs and push code, containers, releases, and more.
 
 ## Joining
 
@@ -127,7 +141,7 @@ The admins occasionally invite contributors directly if we believe having them o
 # Automatic Repository Maintenance
 
 The Paperless-ngx team appreciates all effort and interest from the community in filing bug reports, creating feature requests, sharing ideas and helping other
-community members. That said, in an effort to keep the repository organized and manageable the project uses automatic handling of certain areas:
+community members. That said, in an effort to keep the repository organized and managebale the project uses automatic handling of certain areas:
 
 - Issues that cannot be reproduced will be marked 'stale' after 7 days of inactivity and closed after 14 further days of inactivity.
 - Issues, pull requests and discussions that are closed will be locked after 30 days of inactivity.

Dockerfile

@@ -4,90 +4,50 @@
 # Stage: compile-frontend
 # Purpose: Compiles the frontend
 # Notes:
-#  - Does PNPM stuff with Typescript and such
+#  - Does NPM stuff with Typescript and such
 FROM --platform=$BUILDPLATFORM docker.io/node:20-bookworm-slim AS compile-frontend
 
 COPY ./src-ui /src/src-ui
 
 WORKDIR /src/src-ui
 RUN set -eux \
-  && npm update -g pnpm \
+  && npm update npm -g \
-  && npm install -g corepack@latest \
+  && npm ci
-  && corepack enable \
-  && pnpm install
 
 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/tag: '([a-z\.]+)'/tag: '${PNGX_TAG_VERSION}'/g" /src/src-ui/src/environments/environment.prod.ts \
+    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
 
-# Stage: s6-overlay-base
+# Stage: pipenv-base
-# Purpose: Installs s6-overlay and rootfs
+# Purpose: Generates a requirements.txt file for building
 # Comments:
-#  - Don't leave anything extra in here either
+#  - pipenv dependencies are not left in the final image
-FROM ghcr.io/astral-sh/uv:0.8.13-python3.12-bookworm-slim AS s6-overlay-base
+#  - pipenv can't touch the final image somehow
+FROM --platform=$BUILDPLATFORM docker.io/python:3.12-alpine AS pipenv-base
 
-WORKDIR /usr/src/s6
+WORKDIR /usr/src/pipenv
 
-# https://github.com/just-containers/s6-overlay#customizing-s6-overlay-behaviour
+COPY Pipfile* ./
-ENV \
-    S6_BEHAVIOUR_IF_STAGE2_FAILS=2 \
-    S6_CMD_WAIT_FOR_SERVICES_MAXTIME=0 \
-    S6_VERBOSITY=1 \
-    PATH=/command:$PATH
-
-# Buildx provided, must be defined to use though
-ARG TARGETARCH
-ARG TARGETVARIANT
-# Lock this version
-ARG S6_OVERLAY_VERSION=3.2.1.0
-
-ARG S6_BUILD_TIME_PKGS="curl \
-                        xz-utils"
 
 RUN set -eux \
-    && echo "Installing build time packages" \
+  && echo "Installing pipenv" \
-      && apt-get update \
+    && python3 -m pip install --no-cache-dir --upgrade pipenv==2024.4.0 \
-      && apt-get install --yes --quiet --no-install-recommends ${S6_BUILD_TIME_PKGS} \
+  && echo "Generating requirement.txt" \
-    && echo "Determining arch" \
+    && pipenv requirements > requirements.txt
-      && S6_ARCH="" \
-      && if [ "${TARGETARCH}${TARGETVARIANT}" = "amd64" ]; then S6_ARCH="x86_64"; \
-      elif [ "${TARGETARCH}${TARGETVARIANT}" = "arm64" ]; then S6_ARCH="aarch64"; fi\
-      && if [ -z "${S6_ARCH}" ]; then { echo "Error: Not able to determine arch"; exit 1; }; fi \
-    && echo "Installing s6-overlay for ${S6_ARCH}" \
-      && curl --fail --silent --no-progress-meter --show-error --location --remote-name-all --parallel --parallel-max 4 \
-        "https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-noarch.tar.xz" \
-        "https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-noarch.tar.xz.sha256" \
-        "https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-${S6_ARCH}.tar.xz" \
-        "https://github.com/just-containers/s6-overlay/releases/download/v${S6_OVERLAY_VERSION}/s6-overlay-${S6_ARCH}.tar.xz.sha256" \
-      && echo "Validating s6-archive checksums" \
-        && sha256sum --check ./*.sha256 \
-      && echo "Unpacking archives" \
-        && tar --directory / -Jxpf s6-overlay-noarch.tar.xz \
-        && tar --directory / -Jxpf s6-overlay-${S6_ARCH}.tar.xz \
-      && echo "Removing downloaded archives" \
-        && rm ./*.tar.xz \
-        && rm ./*.sha256 \
-    && echo "Cleaning up image" \
-      && apt-get --yes purge ${S6_BUILD_TIME_PKGS} \
-      && apt-get --yes autoremove --purge \
-      && rm -rf /var/lib/apt/lists/*
-
-# Copy our service defs and filesystem
-COPY ./docker/rootfs /
 
 # Stage: main-app
 # Purpose: The final image
 # Comments:
 #  - Don't leave anything extra in here
-FROM s6-overlay-base 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/"
@@ -101,19 +61,16 @@ ARG DEBIAN_FRONTEND=noninteractive
 ARG TARGETARCH
 
 # Can be workflow provided, defaults set for manual building
-ARG JBIG2ENC_VERSION=0.30
+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 about async iterators
+    # Ignore warning from Whitenoise
     PYTHONWARNINGS="ignore:::django.http.response:517" \
-    PNGX_CONTAINERIZED=1 \
+    PNGX_CONTAINERIZED=1
-    # https://docs.astral.sh/uv/reference/settings/#link-mode
-    UV_LINK_MODE=copy \
-    UV_CACHE_DIR=/cache/uv/
 
 #
 # Begin installation and configuration
@@ -170,51 +127,118 @@ RUN set -eux \
     && apt-get update \
     && apt-get install --yes --quiet --no-install-recommends ${RUNTIME_PACKAGES} \
     && echo "Installing pre-built updates" \
-      && curl --fail --silent --no-progress-meter --show-error --location --remote-name-all --parallel --parallel-max 4 \
-        https://github.com/paperless-ngx/builder/releases/download/qpdf-${QPDF_VERSION}/libqpdf29_${QPDF_VERSION}-1_${TARGETARCH}.deb \
-        https://github.com/paperless-ngx/builder/releases/download/qpdf-${QPDF_VERSION}/qpdf_${QPDF_VERSION}-1_${TARGETARCH}.deb \
-        https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/libgs10_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
-        https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/ghostscript_${GS_VERSION}.dfsg-1_${TARGETARCH}.deb \
-        https://github.com/paperless-ngx/builder/releases/download/ghostscript-${GS_VERSION}/libgs10-common_${GS_VERSION}.dfsg-1_all.deb \
-        https://github.com/paperless-ngx/builder/releases/download/jbig2enc-${JBIG2ENC_VERSION}/jbig2enc_${JBIG2ENC_VERSION}-1_${TARGETARCH}.deb \
       && 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 \
-      && echo "Configuring imagemagick" \
-        && cp /etc/ImageMagick-6/paperless-policy.xml /etc/ImageMagick-6/policy.xml \
       && echo "Cleaning up image layer" \
         && rm --force --verbose *.deb \
-    && rm --recursive --force --verbose /var/lib/apt/lists/*
+    && rm --recursive --force --verbose /var/lib/apt/lists/* \
+  && echo "Installing supervisor" \
+    && python3 -m pip install --default-timeout=1000 --upgrade --no-cache-dir supervisor==4.2.5
+
+# Copy gunicorn config
+# Changes very infrequently
+WORKDIR /usr/src/paperless/
+
+COPY gunicorn.conf.py .
+
+# setup docker-specific things
+# These change sometimes, but rarely
+WORKDIR /usr/src/paperless/src/docker/
+
+COPY [ \
+  "docker/imagemagick-policy.xml", \
+  "docker/supervisord.conf", \
+  "docker/docker-entrypoint.sh", \
+  "docker/docker-prepare.sh", \
+  "docker/paperless_cmd.sh", \
+  "docker/wait-for-redis.py", \
+  "docker/env-from-file.sh", \
+  "docker/management_script.sh", \
+  "docker/flower-conditional.sh", \
+  "docker/install_management_commands.sh", \
+  "/usr/src/paperless/src/docker/" \
+]
+
+RUN set -eux \
+  && echo "Configuring ImageMagick" \
+    && mv imagemagick-policy.xml /etc/ImageMagick-6/policy.xml \
+  && echo "Configuring supervisord" \
+    && mkdir /var/log/supervisord /var/run/supervisord \
+    && mv supervisord.conf /etc/supervisord.conf \
+  && echo "Setting up Docker scripts" \
+    && mv docker-entrypoint.sh /sbin/docker-entrypoint.sh \
+    && chmod 755 /sbin/docker-entrypoint.sh \
+    && mv docker-prepare.sh /sbin/docker-prepare.sh \
+    && chmod 755 /sbin/docker-prepare.sh \
+    && mv wait-for-redis.py /sbin/wait-for-redis.py \
+    && chmod 755 /sbin/wait-for-redis.py \
+    && mv env-from-file.sh /sbin/env-from-file.sh \
+    && chmod 755 /sbin/env-from-file.sh \
+    && mv paperless_cmd.sh /usr/local/bin/paperless_cmd.sh \
+    && chmod 755 /usr/local/bin/paperless_cmd.sh \
+    && mv flower-conditional.sh /usr/local/bin/flower-conditional.sh \
+    && chmod 755 /usr/local/bin/flower-conditional.sh \
+  && echo "Installing management commands" \
+    && chmod +x install_management_commands.sh \
+    && ./install_management_commands.sh
 
 WORKDIR /usr/src/paperless/src/
 
 # Python dependencies
 # Change pretty frequently
-COPY --chown=1000:1000 ["pyproject.toml", "uv.lock", "/usr/src/paperless/src/"]
+COPY --from=pipenv-base /usr/src/pipenv/requirements.txt ./
 
 # 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"
 
 # hadolint ignore=DL3042
-RUN --mount=type=cache,target=${UV_CACHE_DIR},id=python-cache \
+RUN --mount=type=cache,target=/root/.cache/pip/,id=pip-cache \
   set -eux \
   && echo "Installing build system packages" \
     && apt-get update \
     && apt-get install --yes --quiet --no-install-recommends ${BUILD_PACKAGES} \
+    && python3 -m pip install --no-cache-dir --upgrade wheel \
   && echo "Installing Python requirements" \
-    && uv export --quiet --no-dev --all-extras --format requirements-txt --output-file requirements.txt \
+    && curl --fail --silent --show-error --location \
-    && uv pip install --system --no-python-downloads --python-preference system --requirements requirements.txt \
+    --output psycopg_c-3.2.3-cp312-cp312-linux_x86_64.whl \
+    https://github.com/paperless-ngx/builder/releases/download/psycopg-3.2.3/psycopg_c-3.2.3-cp312-cp312-linux_x86_64.whl \
+    && curl --fail --silent --show-error --location \
+    --output psycopg_c-3.2.3-cp312-cp312-linux_aarch64.whl  \
+    https://github.com/paperless-ngx/builder/releases/download/psycopg-3.2.3/psycopg_c-3.2.3-cp312-cp312-linux_aarch64.whl \
+    && python3 -m pip install --default-timeout=1000 --find-links . --requirement requirements.txt \
   && 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 \
@@ -239,7 +263,6 @@ COPY --from=compile-frontend --chown=1000:1000 /src/src/documents/static/fronten
 # add users, setup scripts
 # Mount the compiled frontend to expected location
 RUN set -eux \
-  && sed -i '1s|^#!/usr/bin/env python3|#!/command/with-contenv python3|' manage.py \
   && echo "Setting up user/group" \
     && addgroup --gid 1000 paperless \
     && useradd --uid 1000 --gid paperless --home-dir /usr/src/paperless paperless \
@@ -253,16 +276,18 @@ RUN set -eux \
   && echo "Adjusting all permissions" \
     && chown --from root:root --changes --recursive paperless:paperless /usr/src/paperless \
   && echo "Collecting static files" \
-    && s6-setuidgid paperless python3 manage.py collectstatic --clear --no-input --link \
+    && gosu paperless python3 manage.py collectstatic --clear --no-input --link \
-    && s6-setuidgid paperless python3 manage.py compilemessages
+    && gosu paperless python3 manage.py compilemessages
 
 VOLUME ["/usr/src/paperless/data", \
         "/usr/src/paperless/media", \
         "/usr/src/paperless/consume", \
         "/usr/src/paperless/export"]
 
-ENTRYPOINT ["/init"]
+ENTRYPOINT ["/sbin/docker-entrypoint.sh"]
 
 EXPOSE 8000
 
-HEALTHCHECK --interval=30s --timeout=10s --retries=5 CMD [ "curl", "-fs", "-S", "-L", "--max-time", "2", "http://localhost:8000" ]
+CMD ["/usr/local/bin/paperless_cmd.sh"]
+
+HEALTHCHECK --interval=30s --timeout=10s --retries=5 CMD [ "curl", "-fs", "-S", "--max-time", "2", "http://localhost:8000" ]

Pipfile

@@ -0,0 +1,100 @@
+[[source]]
+url = "https://pypi.python.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+dateparser = "~=1.2"
+# WARNING: django does not use semver.
+#          Only patch versions are guaranteed to not introduce breaking changes.
+django = "~=5.1.5"
+django-allauth = {extras = ["mfa", "socialaccount"], version = "*"}
+django-auditlog = "*"
+django-celery-results = "*"
+django-compression-middleware = "*"
+django-cors-headers = "*"
+django-extensions = "*"
+django-filter = "~=24.3"
+django-guardian = "*"
+django-multiselectfield = "*"
+django-soft-delete = "*"
+djangorestframework = "~=3.15.2"
+djangorestframework-guardian = "*"
+drf-writable-nested = "*"
+bleach = "*"
+celery = {extras = ["redis"], version = "*"}
+channels = "~=4.2"
+channels-redis = "*"
+concurrent-log-handler = "*"
+filelock = "*"
+flower = "*"
+gotenberg-client = "*"
+gunicorn = "*"
+httpx-oauth = "*"
+imap-tools = "*"
+inotifyrecursive = "~=0.3"
+jinja2 = "~=3.1"
+langdetect = "*"
+mysqlclient = "*"
+nltk = "*"
+ocrmypdf = "~=16.8"
+pathvalidate = "*"
+pdf2image = "*"
+psycopg = {version = "*", extras = ["c"]}
+python-dateutil = "*"
+python-dotenv = "*"
+python-gnupg = "*"
+python-ipware = "*"
+python-magic = "*"
+pyzbar = "*"
+rapidfuzz = "*"
+redis = {extras = ["hiredis"], version = "*"}
+scikit-learn = "~=1.6"
+setproctitle = "*"
+tika-client = "*"
+tqdm = "*"
+# See https://github.com/paperless-ngx/paperless-ngx/issues/5494
+uvicorn = {extras = ["standard"], version = "==0.25.0"}
+watchdog = "~=6.0"
+whitenoise = "~=6.8"
+whoosh = "~=2.7"
+zxing-cpp = {version = "*", platform_machine = "== 'x86_64'"}
+
+
+[dev-packages]
+# Linting
+pre-commit = "*"
+ruff = "*"
+factory-boy = "*"
+# Testing
+pytest = "*"
+pytest-cov = "*"
+pytest-django = "*"
+pytest-httpx = "*"
+pytest-env = "*"
+pytest-sugar = "*"
+pytest-xdist = "*"
+pytest-mock = "*"
+pytest-rerunfailures = "*"
+imagehash = "*"
+daphne = "*"
+# Documentation
+mkdocs-material = "*"
+mkdocs-glightbox = "*"
+
+[typing-dev]
+mypy = "*"
+types-Pillow = "*"
+django-filter-stubs = "*"
+types-python-dateutil = "*"
+djangorestframework-stubs = {extras= ["compatible-mypy"], version="*"}
+celery-types = "*"
+django-stubs = {extras= ["compatible-mypy"], version="*"}
+types-dateparser = "*"
+types-bleach = "*"
+types-redis = "*"
+types-tqdm = "*"
+types-Markdown = "*"
+types-Pygments = "*"
+types-colorama = "*"
+types-setuptools = "*"

README.md

@@ -83,7 +83,7 @@ People interested in continuing the work on paperless-ngx are encouraged to reac
 
 ## Translation
 
-Paperless-ngx is available in many languages that are coordinated on Crowdin. If you want to help out by translating paperless-ngx into your language, please head over to https://crowdin.com/project/paperless-ngx, and thank you! More details can be found in [CONTRIBUTING.md](https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md#translating-paperless-ngx).
+Paperless-ngx is available in many languages that are coordinated on Crowdin. If you want to help out by translating paperless-ngx into your language, please head over to https://crwd.in/paperless-ngx, and thank you! More details can be found in [CONTRIBUTING.md](https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md#translating-paperless-ngx).
 
 ## Feature Requests
 

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

@@ -1,10 +1,11 @@
-# Docker Compose file for running paperless testing with actual Gotenberg
+# Docker Compose file for running paperless testing with actual gotenberg
 # and Tika containers for a more end to end test of the Tika related functionality
 # Can be used locally or by the CI to start the necessary containers with the
 # correct networking for the tests
+
 services:
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:8.22
+    image: docker.io/gotenberg/gotenberg:8.7
     hostname: gotenberg
     container_name: gotenberg
     network_mode: host

docker/compose/docker-compose.env

@@ -32,6 +32,6 @@
 # Note that this is different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines
 # the language used for OCR.
 # The container installs English, German, Italian, Spanish and French by default.
-# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names
+# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
 # for available languages.
 #PAPERLESS_OCR_LANGUAGES=tur ces

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

@@ -16,26 +16,29 @@
 # - Instead of SQLite (default), MariaDB is used as the database server.
 # - Apache Tika and Gotenberg servers are started with paperless and paperless
 #   is configured to use these services. These provide support for consuming
-#   Office documents (Word, Excel, PowerPoint and their LibreOffice counter-
+#   Office documents (Word, Excel, Power Point and their LibreOffice counter-
-#   parts).
+#   parts.
 #
 # To install and update paperless with this file, do the following:
 #
 # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
 #   and '.env' into a folder.
 # - Run 'docker compose pull'.
+# - Run 'docker compose run --rm webserver createsuperuser' to create a user.
 # - Run 'docker compose up -d'.
 #
 # For more extensive installation and update instructions, refer to the
 # documentation.
+
 services:
   broker:
-    image: docker.io/library/redis:8
+    image: docker.io/library/redis:7
     restart: unless-stopped
     volumes:
       - redisdata:/data
+
   db:
-    image: docker.io/library/mariadb:12
+    image: docker.io/library/mariadb:11
     restart: unless-stopped
     volumes:
       - dbdata:/var/lib/mysql
@@ -45,6 +48,7 @@ services:
       MARIADB_USER: paperless
       MARIADB_PASSWORD: paperless
       MARIADB_ROOT_PASSWORD: paperless
+
   webserver:
     image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
@@ -71,8 +75,9 @@ services:
       PAPERLESS_TIKA_ENABLED: 1
       PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
+
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:8.22
+    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.
@@ -80,9 +85,11 @@ services:
       - "gotenberg"
       - "--chromium-disable-javascript=true"
       - "--chromium-allow-list=file:///tmp/.*"
+
   tika:
     image: docker.io/apache/tika:latest
     restart: unless-stopped
+
 volumes:
   data:
   media:

docker/compose/docker-compose.mariadb.yml

@@ -20,18 +20,21 @@
 # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
 #   and '.env' into a folder.
 # - Run 'docker compose pull'.
+# - Run 'docker compose run --rm webserver createsuperuser' to create a user.
 # - Run 'docker compose up -d'.
 #
 # For more extensive installation and update instructions, refer to the
 # documentation.
+
 services:
   broker:
-    image: docker.io/library/redis:8
+    image: docker.io/library/redis:7
     restart: unless-stopped
     volumes:
       - redisdata:/data
+
   db:
-    image: docker.io/library/mariadb:12
+    image: docker.io/library/mariadb:11
     restart: unless-stopped
     volumes:
       - dbdata:/var/lib/mysql
@@ -41,6 +44,7 @@ services:
       MARIADB_USER: paperless
       MARIADB_PASSWORD: paperless
       MARIADB_ROOT_PASSWORD: paperless
+
   webserver:
     image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
@@ -62,6 +66,7 @@ services:
       PAPERLESS_DBUSER: paperless # only needed if non-default username
       PAPERLESS_DBPASS: paperless # only needed if non-default password
       PAPERLESS_DBPORT: 3306
+
 volumes:
   data:
   media:

docker/compose/docker-compose.portainer.yml

@@ -22,17 +22,23 @@
 # - Upload 'docker-compose.env' by clicking on 'Load variables from .env file'
 # - Modify the environment variables as needed
 # - Click 'Deploy the stack' and wait for it to be deployed
+# - Open the list of containers, select paperless_webserver_1
+# - Click 'Console' and then 'Connect' to open the command line inside the container
+# - Run 'python3 manage.py createsuperuser' to create a user
+# - Exit the console
 #
 # For more extensive installation and update instructions, refer to the
 # documentation.
+
 services:
   broker:
-    image: docker.io/library/redis:8
+    image: docker.io/library/redis:7
     restart: unless-stopped
     volumes:
       - redisdata:/data
+
   db:
-    image: docker.io/library/postgres:17
+    image: docker.io/library/postgres:16
     restart: unless-stopped
     volumes:
       - pgdata:/var/lib/postgresql/data
@@ -40,6 +46,7 @@ services:
       POSTGRES_DB: paperless
       POSTGRES_USER: paperless
       POSTGRES_PASSWORD: paperless
+
   webserver:
     image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
@@ -58,6 +65,7 @@ services:
       PAPERLESS_DBHOST: db
     env_file:
       - stack.env
+
 volumes:
   data:
   media:

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

@@ -16,26 +16,29 @@
 # - Instead of SQLite (default), PostgreSQL is used as the database server.
 # - Apache Tika and Gotenberg servers are started with paperless and paperless
 #   is configured to use these services. These provide support for consuming
-#   Office documents (Word, Excel, PowerPoint and their LibreOffice counter-
+#   Office documents (Word, Excel, Power Point and their LibreOffice counter-
-#   parts).
+#   parts.
 #
 # To install and update paperless with this file, do the following:
 #
 # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
 #   and '.env' into a folder.
 # - Run 'docker compose pull'.
+# - Run 'docker compose run --rm webserver createsuperuser' to create a user.
 # - Run 'docker compose up -d'.
 #
 # For more extensive installation and update instructions, refer to the
 # documentation.
+
 services:
   broker:
-    image: docker.io/library/redis:8
+    image: docker.io/library/redis:7
     restart: unless-stopped
     volumes:
       - redisdata:/data
+
   db:
-    image: docker.io/library/postgres:17
+    image: docker.io/library/postgres:16
     restart: unless-stopped
     volumes:
       - pgdata:/var/lib/postgresql/data
@@ -43,6 +46,7 @@ services:
       POSTGRES_DB: paperless
       POSTGRES_USER: paperless
       POSTGRES_PASSWORD: paperless
+
   webserver:
     image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
@@ -65,18 +69,22 @@ services:
       PAPERLESS_TIKA_ENABLED: 1
       PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
+
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:8.22
+    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.
     command:
       - "gotenberg"
       - "--chromium-disable-javascript=true"
       - "--chromium-allow-list=file:///tmp/.*"
+
   tika:
     image: docker.io/apache/tika:latest
     restart: unless-stopped
+
 volumes:
   data:
   media:

docker/compose/docker-compose.postgres.yml

@@ -20,18 +20,21 @@
 # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
 #   and '.env' into a folder.
 # - Run 'docker compose pull'.
+# - Run 'docker compose run --rm webserver createsuperuser' to create a user.
 # - Run 'docker compose up -d'.
 #
 # For more extensive installation and update instructions, refer to the
 # documentation.
+
 services:
   broker:
-    image: docker.io/library/redis:8
+    image: docker.io/library/redis:7
     restart: unless-stopped
     volumes:
       - redisdata:/data
+
   db:
-    image: docker.io/library/postgres:17
+    image: docker.io/library/postgres:16
     restart: unless-stopped
     volumes:
       - pgdata:/var/lib/postgresql/data
@@ -39,6 +42,7 @@ services:
       POSTGRES_DB: paperless
       POSTGRES_USER: paperless
       POSTGRES_PASSWORD: paperless
+
   webserver:
     image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
@@ -56,6 +60,7 @@ services:
     environment:
       PAPERLESS_REDIS: redis://broker:6379
       PAPERLESS_DBHOST: db
+
 volumes:
   data:
   media:

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

@@ -16,24 +16,27 @@
 #
 # - Apache Tika and Gotenberg servers are started with paperless and paperless
 #   is configured to use these services. These provide support for consuming
-#   Office documents (Word, Excel, PowerPoint and their LibreOffice counter-
+#   Office documents (Word, Excel, Power Point and their LibreOffice counter-
-#   parts).
+#   parts.
 #
 # To install and update paperless with this file, do the following:
 #
 # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
 #   and '.env' into a folder.
 # - Run 'docker compose pull'.
+# - Run 'docker compose run --rm webserver createsuperuser' to create a user.
 # - Run 'docker compose up -d'.
 #
 # For more extensive installation and update instructions, refer to the
 # documentation.
+
 services:
   broker:
-    image: docker.io/library/redis:8
+    image: docker.io/library/redis:7
     restart: unless-stopped
     volumes:
       - redisdata:/data
+
   webserver:
     image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
@@ -54,18 +57,22 @@ services:
       PAPERLESS_TIKA_ENABLED: 1
       PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
       PAPERLESS_TIKA_ENDPOINT: http://tika:9998
+
   gotenberg:
-    image: docker.io/gotenberg/gotenberg:8.22
+    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.
     command:
       - "gotenberg"
       - "--chromium-disable-javascript=true"
       - "--chromium-allow-list=file:///tmp/.*"
+
   tika:
     image: docker.io/apache/tika:latest
     restart: unless-stopped
+
 volumes:
   data:
   media:

docker/compose/docker-compose.sqlite.yml

@@ -17,16 +17,19 @@
 # - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
 #   and '.env' into a folder.
 # - Run 'docker compose pull'.
+# - Run 'docker compose run --rm webserver createsuperuser' to create a user.
 # - Run 'docker compose up -d'.
 #
 # For more extensive installation and update instructions, refer to the
 # documentation.
+
 services:
   broker:
-    image: docker.io/library/redis:8
+    image: docker.io/library/redis:7
     restart: unless-stopped
     volumes:
       - redisdata:/data
+
   webserver:
     image: ghcr.io/paperless-ngx/paperless-ngx:latest
     restart: unless-stopped
@@ -42,6 +45,7 @@ services:
     env_file: docker-compose.env
     environment:
       PAPERLESS_REDIS: redis://broker:6379
+
 volumes:
   data:
   media:

docker/docker-entrypoint.sh

@@ -0,0 +1,179 @@
+#!/usr/bin/env bash
+
+set -e
+
+# Source: https://github.com/sameersbn/docker-gitlab/
+map_uidgid() {
+	local -r usermap_original_uid=$(id -u paperless)
+	local -r usermap_original_gid=$(id -g paperless)
+	local -r usermap_new_uid=${USERMAP_UID:-$usermap_original_uid}
+	local -r usermap_new_gid=${USERMAP_GID:-${usermap_original_gid:-$usermap_new_uid}}
+	if [[ ${usermap_new_uid} != "${usermap_original_uid}" || ${usermap_new_gid} != "${usermap_original_gid}" ]]; then
+		echo "Mapping UID and GID for paperless:paperless to $usermap_new_uid:$usermap_new_gid"
+		usermod --non-unique --uid "${usermap_new_uid}" paperless
+		groupmod --non-unique --gid "${usermap_new_gid}" paperless
+	fi
+}
+
+map_folders() {
+	# Export these so they can be used in docker-prepare.sh
+	export DATA_DIR="${PAPERLESS_DATA_DIR:-/usr/src/paperless/data}"
+	export MEDIA_ROOT_DIR="${PAPERLESS_MEDIA_ROOT:-/usr/src/paperless/media}"
+	export CONSUME_DIR="${PAPERLESS_CONSUMPTION_DIR:-/usr/src/paperless/consume}"
+}
+
+custom_container_init() {
+	# Mostly borrowed from the LinuxServer.io base image
+	# https://github.com/linuxserver/docker-baseimage-ubuntu/tree/bionic/root/etc/cont-init.d
+	local -r custom_script_dir="/custom-cont-init.d"
+	# Tamper checking.
+	# Don't run files which are owned by anyone except root
+	# Don't run files which are writeable by others
+	if [ -d "${custom_script_dir}" ]; then
+		if [ -n "$(/usr/bin/find "${custom_script_dir}" -maxdepth 1 ! -user root)" ]; then
+			echo "**** Potential tampering with custom scripts detected ****"
+			echo "**** The folder '${custom_script_dir}' must be owned by root ****"
+			return 0
+		fi
+		if [ -n "$(/usr/bin/find "${custom_script_dir}" -maxdepth 1 -perm -o+w)" ]; then
+			echo "**** The folder '${custom_script_dir}' or some of contents have write permissions for others, which is a security risk. ****"
+			echo "**** Please review the permissions and their contents to make sure they are owned by root, and can only be modified by root. ****"
+			return 0
+		fi
+
+		# Make sure custom init directory has files in it
+		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
+				NAME="$(basename "${SCRIPT}")"
+				if [ -f "${SCRIPT}" ]; then
+					echo "[custom-init] ${NAME}: executing..."
+					/bin/bash "${SCRIPT}"
+					echo "[custom-init] ${NAME}: exited $?"
+				elif [ ! -f "${SCRIPT}" ]; then
+					echo "[custom-init] ${NAME}: is not a file"
+				fi
+			done
+		else
+			echo "[custom-init] no custom files found exiting..."
+		fi
+
+	fi
+}
+
+initialize() {
+
+	# Setup environment from secrets before anything else
+	# Check for a version of this var with _FILE appended
+	# and convert the contents to the env var value
+	# Source it so export is persistent
+	# shellcheck disable=SC1091
+	source /sbin/env-from-file.sh
+
+	# Change the user and group IDs if needed
+	map_uidgid
+
+	# Check for overrides of certain folders
+	map_folders
+
+	local -r export_dir="/usr/src/paperless/export"
+
+	for dir in \
+		"${export_dir}" \
+		"${DATA_DIR}" "${DATA_DIR}/index" \
+		"${MEDIA_ROOT_DIR}" "${MEDIA_ROOT_DIR}/documents" "${MEDIA_ROOT_DIR}/documents/originals" "${MEDIA_ROOT_DIR}/documents/thumbnails" \
+		"${CONSUME_DIR}"; do
+		if [[ ! -d "${dir}" ]]; then
+			echo "Creating directory ${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 --verbose "${tmp_dir}"
+
+	set +e
+	echo "Adjusting permissions of paperless files. This may take a while."
+	chown -R paperless:paperless "${tmp_dir}"
+	for dir in \
+		"${export_dir}" \
+		"${DATA_DIR}" \
+		"${MEDIA_ROOT_DIR}" \
+		"${CONSUME_DIR}"; do
+		find "${dir}" -not \( -user paperless -and -group paperless \) -exec chown --changes paperless:paperless {} +
+	done
+	set -e
+
+	"${gosu_cmd[@]}" /sbin/docker-prepare.sh
+
+	# Leave this last thing
+	custom_container_init
+
+}
+
+install_languages() {
+	echo "Installing languages..."
+
+	read -ra langs <<<"$1"
+
+	# Check that it is not empty
+	if [ ${#langs[@]} -eq 0 ]; then
+		return
+	fi
+
+	# Build list of packages to install
+	to_install=()
+	for lang in "${langs[@]}"; do
+		pkg="tesseract-ocr-$lang"
+
+		if dpkg --status "$pkg" &>/dev/null; then
+			echo "Package $pkg already installed!"
+			continue
+		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 --user)" == "$(id --user paperless)" ]; then
+	gosu_cmd=()
+fi
+
+# Install additional languages if specified
+if [[ -n "$PAPERLESS_OCR_LANGUAGES" ]]; then
+	install_languages "$PAPERLESS_OCR_LANGUAGES"
+fi
+
+initialize
+
+if [[ "$1" != "/"* ]]; then
+	echo Executing management command "$@"
+	exec "${gosu_cmd[@]}" python3 manage.py "$@"
+else
+	echo Executing "$@"
+	exec "$@"
+fi

docker/docker-prepare.sh

@@ -0,0 +1,120 @@
+#!/usr/bin/env bash
+
+set -e
+
+wait_for_postgres() {
+	local attempt_num=1
+	local -r max_attempts=5
+
+	echo "Waiting for PostgreSQL to start..."
+
+	local -r host="${PAPERLESS_DBHOST:-localhost}"
+	local -r port="${PAPERLESS_DBPORT:-5432}"
+
+	# Disable warning, host and port can't have spaces
+	# shellcheck disable=SC2086
+	while [ ! "$(pg_isready --host ${host} --port ${port})" ]; do
+
+		if [ $attempt_num -eq $max_attempts ]; then
+			echo "Unable to connect to database."
+			exit 1
+		else
+			echo "Attempt $attempt_num failed! Trying again in 5 seconds..."
+		fi
+
+		attempt_num=$(("$attempt_num" + 1))
+		sleep 5
+	done
+	echo "Connected to PostgreSQL"
+}
+
+wait_for_mariadb() {
+	echo "Waiting for MariaDB to start..."
+
+	local -r host="${PAPERLESS_DBHOST:=localhost}"
+	local -r port="${PAPERLESS_DBPORT:=3306}"
+
+	local attempt_num=1
+	local -r max_attempts=5
+
+	# Disable warning, host and port can't have spaces
+	# shellcheck disable=SC2086
+	while ! true > /dev/tcp/$host/$port; do
+
+		if [ $attempt_num -eq $max_attempts ]; then
+			echo "Unable to connect to database."
+			exit 1
+		else
+			echo "Attempt $attempt_num failed! Trying again in 5 seconds..."
+
+		fi
+
+		attempt_num=$(("$attempt_num" + 1))
+		sleep 5
+	done
+	echo "Connected to MariaDB"
+}
+
+wait_for_redis() {
+	# We use a Python script to send the Redis ping
+	# instead of installing redis-tools just for 1 thing
+	if ! python3 /sbin/wait-for-redis.py; then
+		exit 1
+	fi
+}
+
+migrations() {
+	(
+		# flock is in place to prevent multiple containers from doing migrations
+		# simultaneously. This also ensures that the db is ready when the command
+		# of the current container starts.
+		flock 200
+		echo "Apply database migrations..."
+		python3 manage.py migrate --skip-checks --no-input
+	) 200>"${DATA_DIR}/migration_lock"
+}
+
+django_checks() {
+	# Explicitly run the Django system checks
+	echo "Running Django checks"
+	python3 manage.py check
+}
+
+search_index() {
+
+	local -r index_version=9
+	local -r index_version_file=${DATA_DIR}/.index_version
+
+	if [[ (! -f "${index_version_file}") || $(<"${index_version_file}") != "$index_version" ]]; then
+		echo "Search index out of date. Updating..."
+		python3 manage.py document_index reindex --no-progress-bar
+		echo ${index_version} | tee "${index_version_file}" >/dev/null
+	fi
+}
+
+superuser() {
+	if [[ -n "${PAPERLESS_ADMIN_USER}" ]]; then
+		python3 manage.py manage_superuser
+	fi
+}
+
+do_work() {
+	if [[ "${PAPERLESS_DBENGINE}" == "mariadb" ]]; then
+		wait_for_mariadb
+	elif [[ -n "${PAPERLESS_DBHOST}" ]]; then
+		wait_for_postgres
+	fi
+
+	wait_for_redis
+
+	migrations
+
+	django_checks
+
+	search_index
+
+	superuser
+
+}
+
+do_work

docker/env-from-file.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+
+# Scans the environment variables for those with the suffix _FILE
+# When located, checks the file exists, and exports the contents
+# of the file as the same name, minus the suffix
+# This allows the use of Docker secrets or mounted files
+# to fill in any of the settings configurable via environment
+# variables
+
+set -eu
+
+for line in $(printenv)
+do
+	# Extract the name of the environment variable
+	env_name=${line%%=*}
+	# Check if it starts with "PAPERLESS_" and ends in "_FILE"
+	if [[ ${env_name} == PAPERLESS_*_FILE ]]; then
+		# This should have been named different..
+		if [[ ${env_name} == "PAPERLESS_OCR_SKIP_ARCHIVE_FILE" || ${env_name} == "PAPERLESS_MODEL_FILE" ]]; then
+			continue
+		fi
+		# Extract the value of the environment
+		env_value=${line#*=}
+
+		# Check the file exists
+		if [[ -f ${env_value} ]]; then
+
+			# Trim off the _FILE suffix
+			non_file_env_name=${env_name%"_FILE"}
+			echo "Setting ${non_file_env_name} from file"
+
+			# Reads the value from th file
+			val="$(< "${!env_name}")"
+
+			# Sets the normal name to the read file contents
+			export "${non_file_env_name}"="${val}"
+
+		else
+			echo "File ${env_value} referenced by ${env_name} doesn't exist"
+		fi
+	fi
+done

docker/flower-conditional.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+echo "Checking if we should start flower..."
+
+if [[ -n  "${PAPERLESS_ENABLE_FLOWER}" ]]; then
+	# Small delay to allow celery to be up first
+	echo "Starting flower in 5s"
+	sleep 5
+	celery --app paperless flower --conf=/usr/src/paperless/src/paperless/flowerconfig.py
+else
+	echo "Not starting flower"
+fi

docker/install_management_commands.sh

@@ -1,7 +1,5 @@
 #!/usr/bin/env bash
 
-# Run this script to generate the management commands again (for example if a new command is create or the template is updated)
-
 set -eu
 
 for command in decrypt_documents \
@@ -18,10 +16,9 @@ for command in decrypt_documents \
 	document_fuzzy_match \
 	manage_superuser \
 	convert_mariadb_uuid \
-	prune_audit_logs \
+	prune_audit_logs;
-	createsuperuser;
 do
 	echo "installing $command..."
-	sed "s/management_command/$command/g" management_script.sh >"$PWD/rootfs/usr/local/bin/$command"
+	sed "s/management_command/$command/g" management_script.sh > /usr/local/bin/$command
-	chmod u=rwx,g=rwx,o=rx "$PWD/rootfs/usr/local/bin/$command"
+	chmod +x /usr/local/bin/$command
 done

docker/management_script.sh

@@ -1,13 +1,17 @@
-#!/command/with-contenv /usr/bin/bash
+#!/usr/bin/env bash
-# shellcheck shell=bash
 
 set -e
 
-cd "${PAPERLESS_SRC_DIR}"
+cd /usr/src/paperless/src/
+# This ensures environment is setup
+# shellcheck disable=SC1091
+source /sbin/env-from-file.sh
 
-if [[ $(id -u) == 0 ]]; then
+if [[ $(id -u) == 0 ]] ;
-	s6-setuidgid paperless python3 manage.py management_command "$@"
+then
-elif [[ $(id -un) == "paperless" ]]; then
+	gosu paperless python3 manage.py management_command "$@"
+elif [[ $(id -un) == "paperless" ]] ;
+then
 	python3 manage.py management_command "$@"
 else
 	echo "Unknown user."

docker/paperless_cmd.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+SUPERVISORD_WORKING_DIR="${PAPERLESS_SUPERVISORD_WORKING_DIR:-$PWD}"
+rootless_args=()
+if [ "$(id -u)" == "$(id -u paperless)" ]; then
+	rootless_args=(
+		--user
+		paperless
+		--logfile
+		"${SUPERVISORD_WORKING_DIR}/supervisord.log"
+		--pidfile
+		"${SUPERVISORD_WORKING_DIR}/supervisord.pid"
+	)
+fi
+
+exec /usr/local/bin/supervisord -c /etc/supervisord.conf "${rootless_args[@]}"

docker/rootfs/etc/s6-overlay/s6-rc.d/init-complete/run

@@ -1,8 +0,0 @@
-#!/command/with-contenv /usr/bin/bash
-# shellcheck shell=bash
-declare -r log_prefix="[init-complete]"
-declare -r end_time=$(date +%s)
-declare -r start_time=${PAPERLESS_START_TIME_S}
-
-echo "${log_prefix} paperless-ngx docker container init completed in $(($end_time-$start_time)) seconds"
-echo "${log_prefix} Starting services"

docker/rootfs/etc/s6-overlay/s6-rc.d/init-complete/type

@@ -1 +0,0 @@
-oneshot

docker/rootfs/etc/s6-overlay/s6-rc.d/init-complete/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-complete/run

docker/rootfs/etc/s6-overlay/s6-rc.d/init-custom-init/run

@@ -1,44 +0,0 @@
-#!/command/with-contenv /usr/bin/bash
-# shellcheck shell=bash
-
-declare -r log_prefix="[custom-init]"
-
-# Mostly borrowed from the LinuxServer.io base image
-# https://github.com/linuxserver/docker-baseimage-ubuntu/tree/bionic/root/etc/cont-init.d
-declare -r custom_script_dir="/custom-cont-init.d"
-
-# Tamper checking.
-# Don't run files which are owned by anyone except root
-# Don't run files which are writeable by others
-if [ -d "${custom_script_dir}" ]; then
-	if [ -n "$(/usr/bin/find "${custom_script_dir}" -maxdepth 1 ! -user root)" ]; then
-		echo "${log_prefix} **** Potential tampering with custom scripts detected ****"
-		echo "${log_prefix} **** The folder '${custom_script_dir}' must be owned by root ****"
-		exit 0
-	fi
-	if [ -n "$(/usr/bin/find "${custom_script_dir}" -maxdepth 1 -perm -o+w)" ]; then
-		echo "${log_prefix} **** The folder '${custom_script_dir}' or some of contents have write permissions for others, which is a security risk. ****"
-		echo "${log_prefix} **** Please review the permissions and their contents to make sure they are owned by root, and can only be modified by root. ****"
-		exit 0
-	fi
-
-	# Make sure custom init directory has files in it
-	if [ -n "$(/bin/ls --almost-all "${custom_script_dir}" 2>/dev/null)" ]; then
-		echo "${log_prefix} files found in ${custom_script_dir} executing"
-		# Loop over files in the directory
-		for SCRIPT in "${custom_script_dir}"/*; do
-			NAME="$(basename "${SCRIPT}")"
-			if [ -f "${SCRIPT}" ]; then
-				echo "${log_prefix} ${NAME}: executing..."
-				/command/with-contenv /bin/bash "${SCRIPT}"
-				echo "${log_prefix} ${NAME}: exited $?"
-			elif [ ! -f "${SCRIPT}" ]; then
-				echo "${log_prefix} ${NAME}: is not a file"
-			fi
-		done
-	else
-		echo "${log_prefix} no custom files found exiting..."
-	fi
-else
-	echo "${log_prefix} ${custom_script_dir} doesn't exist, nothing to do"
-fi

docker/rootfs/etc/s6-overlay/s6-rc.d/init-custom-init/type

@@ -1 +0,0 @@
-oneshot

docker/rootfs/etc/s6-overlay/s6-rc.d/init-custom-init/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-custom-init/run

docker/rootfs/etc/s6-overlay/s6-rc.d/init-env-file/run

@@ -1,33 +0,0 @@
-#!/command/with-contenv /usr/bin/bash
-# shellcheck shell=bash
-
-declare -r log_prefix="[env-init]"
-
-echo "${log_prefix} Checking for environment from files"
-
-if find /run/s6/container_environment/*"_FILE" -maxdepth 1 > /dev/null 2>&1; then
-	for FILENAME in /run/s6/container_environment/*; do
-		if [[ "${FILENAME##*/}" == PAPERLESS_*_FILE ]]; then
-			# This should have been named different..
-			if [[ "${FILENAME##*/}" == "PAPERLESS_OCR_SKIP_ARCHIVE_FILE" || "${FILENAME##*/}" == "PAPERLESS_MODEL_FILE" ]]; then
-				continue
-			fi
-			SECRETFILE=$(cat "${FILENAME}")
-			# Check the file exists
-			if [[ -f ${SECRETFILE} ]]; then
-				# Trim off trailing _FILE
-				FILESTRIP=${FILENAME//_FILE/}
-				if [[ $(tail -n1 "${SECRETFILE}" | wc -l) != 0 ]]; then
-					echo "${log_prefix} Your secret: ${FILENAME##*/} contains a trailing newline and may not work as expected"
-				fi
-				# Set environment variable
-				cat "${SECRETFILE}" > "${FILESTRIP}"
-				echo "${log_prefix} ${FILESTRIP##*/} set from ${FILENAME##*/}"
-			else
-				echo "${log_prefix} cannot find secret in ${FILENAME##*/}"
-			fi
-		fi
-	done
-else
-		echo "${log_prefix} No *_FILE environment found"
-fi

docker/rootfs/etc/s6-overlay/s6-rc.d/init-env-file/type

@@ -1 +0,0 @@
-oneshot

docker/rootfs/etc/s6-overlay/s6-rc.d/init-env-file/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-env-file/run

docker/rootfs/etc/s6-overlay/s6-rc.d/init-folders/run

@@ -1,65 +0,0 @@
-#!/command/with-contenv /usr/bin/bash
-# shellcheck shell=bash
-
-declare -r log_prefix="[init-folders]"
-
-declare -r export_dir="/usr/src/paperless/export"
-declare -r data_dir="${PAPERLESS_DATA_DIR:-/usr/src/paperless/data}"
-declare -r media_root_dir="${PAPERLESS_MEDIA_ROOT:-/usr/src/paperless/media}"
-declare -r consume_dir="${PAPERLESS_CONSUMPTION_DIR:-/usr/src/paperless/consume}"
-declare -r tmp_dir="${PAPERLESS_SCRATCH_DIR:=/tmp/paperless}"
-
-declare -r main_dirs=(
-	"${export_dir}"
-	"${data_dir}"
-	"${media_root_dir}"
-	"${consume_dir}"
-	"${tmp_dir}"
-)
-
-declare -r extra_dirs=(
-	"${main_dirs[@]}"
-	"${data_dir}/index"
-	"${media_root_dir}/documents"
-	"${media_root_dir}/documents/originals"
-	"${media_root_dir}/documents/thumbnails"
-)
-
-if [[ -n "${USER_IS_NON_ROOT}" ]]; then
-	# Non-root mode: Create directories as current user, warn about permission issues
-	echo "${log_prefix} Running in non-root mode, checking directories"
-	current_uid=$(id --user)
-	current_gid=$(id --group)
-
-	for dir in "${extra_dirs[@]}"; do
-		if [[ ! -d "${dir}" ]]; then
-			mkdir --parents --verbose "${dir}" || echo "${log_prefix} WARNING: Could not create ${dir} - permission denied"
-		fi
-		# Check permissions on existing directories too
-		if [[ -d "${dir}" && ! -w "${dir}" ]]; then
-			echo "${log_prefix} WARNING: No write permission to ${dir}"
-		fi
-	done
-
-	# Warn about ownership issues
-	for dir in "${main_dirs[@]}"; do
-		if [[ -d "${dir}" ]]; then
-			find "${dir}" -not \( -user ${current_uid} -and -group ${current_gid} \) -exec echo "${log_prefix} WARNING: Permission issue on {}: not owned by current user (${current_uid}:${current_gid})" \; 2>/dev/null || echo "${log_prefix} WARNING: Cannot check permissions on ${dir}"
-		fi
-	done
-else
-	# Root mode: Create and fix permissions as needed
-	echo "${log_prefix} Running with root privileges, adjusting directories and permissions"
-
-	# First create directories
-	for dir in "${extra_dirs[@]}"; do
-		if [[ ! -d "${dir}" ]]; then
-			mkdir --parents --verbose "${dir}"
-		fi
-	done
-
-	# Then fix permissions on all directories
-	for dir in "${main_dirs[@]}"; do
-		find "${dir}" -not \( -user paperless -and -group paperless \) -exec chown --changes paperless:paperless {} +
-	done
-fi

docker/rootfs/etc/s6-overlay/s6-rc.d/init-folders/type

@@ -1 +0,0 @@
-oneshot

docker/rootfs/etc/s6-overlay/s6-rc.d/init-folders/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-folders/run

docker/rootfs/etc/s6-overlay/s6-rc.d/init-migrations/run

@@ -1,18 +0,0 @@
-#!/command/with-contenv /usr/bin/bash
-# shellcheck shell=bash
-declare -r log_prefix="[init-migrations]"
-
-declare -r data_dir="${PAPERLESS_DATA_DIR:-/usr/src/paperless/data}"
-
-echo "${log_prefix} Apply database migrations..."
-
-cd "${PAPERLESS_SRC_DIR}"
-
-# The whole migrate, with flock, needs to run as the right user
-if [[ -n "${USER_IS_NON_ROOT}" ]]; then
-	exec s6-setlock -n "${data_dir}/migration_lock" python3 manage.py migrate --skip-checks --no-input
-else
-	exec s6-setuidgid paperless \
-		s6-setlock -n "${data_dir}/migration_lock" \
-		python3 manage.py migrate --skip-checks --no-input
-fi

docker/rootfs/etc/s6-overlay/s6-rc.d/init-migrations/type

@@ -1 +0,0 @@
-oneshot

docker/rootfs/etc/s6-overlay/s6-rc.d/init-migrations/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-migrations/run

docker/rootfs/etc/s6-overlay/s6-rc.d/init-modify-user/run

@@ -1,22 +0,0 @@
-#!/command/with-contenv /usr/bin/bash
-# shellcheck shell=bash
-declare -r log_prefix="[init-user]"
-
-declare -r usermap_original_uid=$(id -u paperless)
-declare -r usermap_original_gid=$(id -g paperless)
-declare -r usermap_new_uid=${USERMAP_UID:-$usermap_original_uid}
-declare -r usermap_new_gid=${USERMAP_GID:-${usermap_original_gid:-$usermap_new_uid}}
-
-if [[ ${usermap_new_uid} != "${usermap_original_uid}" ]]; then
-	echo "${log_prefix} Mapping UID for paperless to $usermap_new_uid"
-	usermod --non-unique --uid "${usermap_new_uid}" paperless
-else
-	echo "${log_prefix} No UID changes for paperless"
-fi
-
-if [[ ${usermap_new_gid} != "${usermap_original_gid}" ]]; then
-	echo "${log_prefix} Mapping GID for paperless to $usermap_new_gid"
-	groupmod --non-unique --gid "${usermap_new_gid}" paperless
-else
-	echo "${log_prefix} No GID changes for paperless"
-fi

docker/rootfs/etc/s6-overlay/s6-rc.d/init-modify-user/type

@@ -1 +0,0 @@
-oneshot

docker/rootfs/etc/s6-overlay/s6-rc.d/init-modify-user/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-modify-user/run

docker/rootfs/etc/s6-overlay/s6-rc.d/init-search-index/run

@@ -1,28 +0,0 @@
-#!/command/with-contenv /usr/bin/bash
-# shellcheck shell=bash
-
-declare -r log_prefix="[init-index]"
-
-declare -r index_version=9
-declare -r data_dir="${PAPERLESS_DATA_DIR:-/usr/src/paperless/data}"
-declare -r index_version_file="${data_dir}/.index_version"
-
-update_index () {
-	echo "${log_prefix} Search index out of date. Updating..."
-	cd "${PAPERLESS_SRC_DIR}"
-	if [[ -n "${USER_IS_NON_ROOT}" ]]; then
-		python3 manage.py document_index reindex --no-progress-bar
-		echo ${index_version} | tee "${index_version_file}" > /dev/null
-	else
-		s6-setuidgid paperless python3 manage.py document_index reindex --no-progress-bar
-		echo ${index_version} | s6-setuidgid paperless tee "${index_version_file}" > /dev/null
-	fi
-}
-
-if [[ (! -f "${index_version_file}") ]]; then
-	echo "${log_prefix} No index version file found"
-	update_index
-elif [[ $(<"${index_version_file}") != "$index_version" ]]; then
-	echo "${log_prefix} index version updated"
-	update_index
-fi

docker/rootfs/etc/s6-overlay/s6-rc.d/init-search-index/type

@@ -1 +0,0 @@
-oneshot

docker/rootfs/etc/s6-overlay/s6-rc.d/init-search-index/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-search-index/run

docker/rootfs/etc/s6-overlay/s6-rc.d/init-start/run

@@ -1,20 +0,0 @@
-#!/command/with-contenv /usr/bin/bash
-# shellcheck shell=bash
-
-declare -r log_prefix="[init-start]"
-
-echo "${log_prefix} paperless-ngx docker container starting..."
-
-# Set some directories into environment for other steps to access via environment
-# Sort of like variables for later
-printf "/usr/src/paperless/src" > /var/run/s6/container_environment/PAPERLESS_SRC_DIR
-echo $(date +%s) > /var/run/s6/container_environment/PAPERLESS_START_TIME_S
-
-# Check if we're starting as a non-root user
-if [ "$(id --user)" != "0" ]; then
-	printf "true" > /var/run/s6/container_environment/USER_IS_NON_ROOT
-	echo "${log_prefix} paperless-ngx docker container running under a user ($(id --user):$(id --group))"
-else
-	printf "/usr/src/paperless" > /var/run/s6/container_environment/HOME
-	echo "${log_prefix} paperless-ngx docker container starting init as root"
-fi

docker/rootfs/etc/s6-overlay/s6-rc.d/init-start/type

@@ -1 +0,0 @@
-oneshot

docker/rootfs/etc/s6-overlay/s6-rc.d/init-start/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-start/run

docker/rootfs/etc/s6-overlay/s6-rc.d/init-superuser/run

@@ -1,20 +0,0 @@
-#!/command/with-contenv /usr/bin/bash
-# shellcheck shell=bash
-
-declare -r log_prefix="[init-superuser]"
-
-if [[ -n "${PAPERLESS_ADMIN_USER}" ]]; then
-	echo "${log_prefix} Creating superuser..."
-	cd "${PAPERLESS_SRC_DIR}"
-
-	if [[ -n "${USER_IS_NON_ROOT}" ]]; then
-		python3 manage.py manage_superuser
-	else
-		s6-setuidgid paperless python3 manage.py manage_superuser
-	fi
-
-	echo "${log_prefix} Superuser creation done"
-
-else
-	echo "${log_prefix} Not creating superuser"
-fi