11notes/paperless-ngx repository overview

⁠PAPERLESS-NGX

Run paperless-ngx rootless by default (no SUID)!

⁠INTRODUCTION 📢

A community-supported supercharged document management system: scan, index and archive all your documents.

⁠SYNOPSIS 📖

What can I do with this? This image will run paperless-ngx with s6, but rootless.

⁠UNIQUE VALUE PROPOSITION 💶

Why should I run this image and not the other image(s) that already exist? Good question! Because ...

• ... this image runs rootless⁠ as 1000:1000
• ... this image is auto updated to the latest version via CI/CD
• ... this image has a health check
• ... this image is automatically scanned for CVEs before and after publishing
• ... this image is created via a secure and pinned CI/CD process

If you value security, simplicity and optimizations to the extreme, then this image might be for you.

⁠VOLUMES 📁

• /usr/src/paperless/consume - Directory of the documents you want to consume
• /usr/src/paperless/media/documents/originals - Directory of the original imported documents
• /usr/src/paperless/media/documents/archive - Directory of the processed documents
• /usr/src/paperless/media/documents/thumbnails - Directory of the thumbnails of each document
• /usr/src/paperless/data - Directory of internal app relevant files and configs
• /usr/src/paperless/export - Directory of document exports

⁠COMPOSE ✂️

name: "dms"
services:
  paperless-ngx:
    depends_on:
      postgres:
        condition: "service_healthy"
        restart: true
      redis:
        condition: "service_healthy"
        restart: true
    image: "11notes/paperless-ngx:3.2.0"
    environment:
      TZ: "Europe/Zurich"
      PAPERLESS_REDIS: "redis://:${REDIS_PASSWORD}@redis:6379"
      PAPERLESS_DBPASS: ${POSTGRES_PASSWORD}
      PAPERLESS_CONSUMER_POLLING: "60"
      PAPERLESS_CONSUMER_POLLING_DELAY: "30"
      PAPERLESS_CONSUMER_POLLING_RETRY_COUNT: "3"
      PAPERLESS_OCR_SKIP_ARCHIVE_FILE: "never"
      PAPERLESS_CONSUMER_RECURSIVE: "false"
      PAPERLESS_OCR_LANGUAGES: "eng deu"
      PAPERLESS_OCR_LANGUAGE: "deu"
      PAPERLESS_SECRET_KEY: ${PAPERLESS_NGX_SECRET_KEY}
      PAPERLESS_TIME_ZONE: "Europe/Zurich"
      PAPERLESS_URL: "https://${PAPERLESS_NGX_FQDN}"
      # LDAP module for ADDS with UPN as login
      DJANGO_SETTINGS_MODULE: "paperless.settings_ldap"
      PAPERLESS_AD_AUTH_URL: "ldaps://${PAPERLESS_NGX_LDAP_FQDN}:636"
      PAPERLESS_AD_DOMAIN: ${PAPERLESS_NGX_LDAP_FQDN}
      PAPERLESS_AD_UPN_DOMAIN: ${PAPERLESS_NGX_LDAP_UPN}
      PAPERLESS_AD_AUTH_SEARCH_BASE: ${PAPERLESS_NGX_LDAP_SEARCH_CN}
      PAPERLESS_AD_AUTH_USER: ${PAPERLESS_NGX_LDAP_USER}
      PAPERLESS_AD_AUTH_PASSWORD: ${PAPERLESS_NGX_LDAP_PASSWORD}
      PAPERLESS_AD_USER_GROUP_CN: ${PAPERLESS_NGX_LDAP_USERS_CN}
      PAPERLESS_AD_ADMIN_GROUP_CN: ${PAPERLESS_NGX_LDAP_ADMINS_CN}
    volumes:
      - "paperless-ngx.consume:/usr/src/paperless/consume"
      - "paperless-ngx.originals:/usr/src/paperless/media/documents/originals"
      - "paperless-ngx.archive:/usr/src/paperless/media/documents/archive"
      - "paperless-ngx.data:/usr/src/paperless/data"
      - "paperless-ngx.export:/usr/src/paperless/export"
      - "paperless-ngx.thumbnails:/usr/src/paperless/media/documents/thumbnails"
    networks:
      frontend:
      backend:
    ports:
      - "3000:8000/tcp"
    restart: "always"

  postgres:
    # for more information about this image checkout:
    # https://github.com/11notes/docker-postgres
    image: "11notes/postgres:18"
    read_only: true
    environment:
      TZ: "Europe/Zurich"
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
      POSTGRES_BACKUP_SCHEDULE: "0 3 * * *"
    volumes:
      - "postgres.etc:/postgres/etc"
      - "postgres.var:/postgres/var"
      - "postgres.backup:/postgres/backup"
    tmpfs:
      - "/postgres/run:uid=1000,gid=1000"
      - "/postgres/log:uid=1000,gid=1000"
    networks:
      backend:
    restart: "always"

  redis:
    # for more information about this image checkout:
    # https://github.com/11notes/docker-redis
    image: "11notes/redis:7.4.0"
    environment:
      REDIS_PASSWORD: ${REDIS_PASSWORD}
      TZ: Europe/Zurich
    volumes:
      - "redis.etc:/redis/etc"
      - "redis.var:/redis/var"
    networks:
      backend:
    restart: always

volumes:
  paperless-ngx.consume:
  paperless-ngx.originals:
  paperless-ngx.archive:
  paperless-ngx.data:
  paperless-ngx.export:
  paperless-ngx.thumbnails:
  postgres.etc:
  postgres.var:
  postgres.backup:
  redis.etc:
  redis.var:

networks:
  frontend:
  backend:
    internal: true

To find out how you can change the default UID/GID of this container image, consult the RTFM⁠.

⁠DEFAULT SETTINGS 🗃️

⁠ENVIRONMENT 📝

⁠MAIN TAGS 🏷️

These are the main tags for the image. There is also a tag for each commit and its shorthand sha256 value.

• 3.2.0⁠
• 3.2.0-unraid⁠
• 3.2.0-nobody⁠

⁠There is no latest tag, what am I supposed to do about updates?

It is my opinion that the :latest tag is a bad habbit and should not be used at all. Many developers introduce breaking changes in new releases. This would messed up everything for people who use :latest. If you don’t want to change the tag to the latest semver⁠, simply use the short versions of semver⁠. Instead of using :3.2.0 you can use :3 or :3.2. Since on each new version these tags are updated to the latest version of the software, using them is identical to using :latest but at least fixed to a major or minor version. Which in theory should not introduce breaking changes.

If you still insist on having the bleeding edge release of this app, simply use the :rolling tag, but be warned! You will get the latest version of the app instantly, regardless of breaking changes or security issues or what so ever. You do this at your own risk!

⁠REGISTRIES ☁️

docker pull 11notes/paperless-ngx:3.2.0
docker pull ghcr.io/11notes/paperless-ngx:3.2.0
docker pull quay.io/11notes/paperless-ngx:3.2.0

⁠UNRAID VERSION 🟠

This image supports unraid by default. Simply add -unraid to any tag and the image will run as 99:100 instead of 1000:1000.

⁠NOBODY VERSION 👻

This image supports nobody by default. Simply add -nobody to any tag and the image will run as 65534:65534 instead of 1000:1000.

⁠SOURCE 💾

• 11notes/paperless-ngx⁠

⁠PARENT IMAGE 🏛️

• paperlessngx/paperless-ngx⁠

⁠BUILT WITH 🧰

• paperless-ngx⁠
• 11notes/util⁠

⁠GENERAL TIPS 📌

• Use a reverse proxy like Traefik, Nginx, HAproxy to terminate TLS and to protect your endpoints
• Use Let’s Encrypt DNS-01 challenge to obtain valid SSL certificates for your services

⁠CAUTION ⚠️

• Since this image is rootless, unlike the official one, it will only work with EN, DE, FR, IT and ES. If you need another language for OCR, please fork this image and install the tesseract-ocr-{LANGUAGE} package that you need. I can't add all the languages to this image by default

⁠ElevenNotes™️

This image is provided to you at your own risk. Always make backups before updating an image to a different version. Check the releases⁠ for breaking changes. If you have any problems with using this image simply raise an issue⁠, thanks. If you have a question or inputs please create a new discussion⁠ instead of an issue. You can find all my other repositories on github⁠.

created 20.09.2026, 06:06:04 (CET)