dankhostself-host anything

Paperless-ngx with Docker Compose

A community-supported open-source document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper. In the project's words: Paperless-ngx docs: Home (docs/index.md) checked 2026-09-23

Runs on: amd64, arm64 from each image's registry manifest, checked 2026-09-25; a CPU counts only if every image has a build for it. Image by image

Add Paperless-ngx to the builder to use your own domain, get its passwords generated in your browser, and combine it with other apps in one file.

What Paperless-ngx needs

Only figures Paperless-ngx's own documentation publishes, each linked to the page it is on. Where the project gives no number, this page does not invent one.

ResourceMinimumRecommended
RAMThe project publishes no figure
CPUThe project publishes no figure
No figure. The FAQ says it runs on a Raspberry Pi 3 B but OCR is very slow there; the setup guide lists settings for less powerful devices (fewer task workers, OCR only the first page, one web worker). Source: Paperless-ngx docs: FAQ (Will paperless-ngx run on Raspberry Pi?) checked 2026-09-23
DiskThe project publishes no figure

On top of this, Caddy (the reverse proxy in the file) is a single small container. Paperless-ngx itself runs as 3 containers: paperless-broker, paperless-db, paperless-webserver.

Which hardware Paperless-ngx has images for

Read from each image's manifest list in its registry (anonymous, read-only) when this page was built. An app counts for a CPU only if every one of its images lists it.

  • x86-64 PC or NAS (linux/amd64): every image has a build.
  • Raspberry Pi 4/5, 64-bit OS (linux/arm64): every image has a build.
  • Raspberry Pi 3 or Zero 2 W, 32-bit OS (linux/arm/v7): no image for webserver. No image for this hardware; the builder leaves the app out.
ServiceImagePlatforms in the manifestDigestRegistryChecked
brokerdocker.io/valkey/valkey:9-alpineamd64, arm64, arm/v7, ppc64lesha256:48332870af354a799964c0012ae1194a0bf2bf894eb508f945810596dc2d8d11registry-1.docker.io2026-09-25
dbdocker.io/library/postgres:18amd64, arm/v5, arm/v7, arm64, 386, ppc64le, riscv64, s390xsha256:5a5a84b19854a9ffaa54082c166ff4ec27473a361e496e5ea167f298f2da9722registry-1.docker.io2026-09-25
webserverghcr.io/paperless-ngx/paperless-ngx:latestamd64, arm64sha256:5fa76604a81df6945086e0837b14b56543d137e8ce4f311cc5d9ebe907e74e79ghcr.io2026-09-25

A manifest says an image exists for a CPU, not how well Paperless-ngx runs on it: a build for arm64 or arm/v7 can still be too slow or need more memory than the board has. The RAM and disk Paperless-ngx publishes are in the table above and, for a whole set of apps against a Raspberry Pi, on Will it run on my machine?. A tag like latest can move to a new digest after the date checked.

docker-compose.yml

This is exactly what the builder writes for Paperless-ngx alone on example.org: the official definition with its published ports removed and Caddy added in front. The time zone is Etc/UTC here; the builder uses your browser's. Every ${VARIABLE} is defined in the .env below.

# docker-compose.yml built at dankhost.com for: Paperless-ngx
# Each app block is its official compose definition. Only the names were prefixed with
# the app slug (services, containers, volumes, bind folders, .env variables) so any set of
# apps can share one file; other differences are listed under "Changed:" in each block.
# Only Caddy publishes ports. Secrets live in .env next to this file.

services:
  # ---- Caddy: the one reverse proxy, HTTPS certificates from Let's Encrypt ----
  # Source: https://caddyserver.com/docs/running (checked 2026-09-23)
  # Source: https://github.com/dani-garcia/vaultwarden/wiki/Using-Docker-Compose (checked 2026-09-23)
  # Caddyfile goes in ./caddy/Caddyfile. Fixed address 172.30.0.2 so apps can trust it exactly.
  caddy:
    image: "caddy:2"
    container_name: "caddy"
    restart: "unless-stopped"
    ports:
      - "80:80"
      - "443:443"
      - "443:443/udp"
    volumes:
      - "./caddy:/etc/caddy"
      - "caddy-data:/data"
      - "caddy-config:/config"
    networks:
      proxy:
        ipv4_address: "172.30.0.2"

  # ---- Paperless-ngx (docs.example.org) ----
  # Source: https://github.com/paperless-ngx/paperless-ngx/blob/main/docker/compose/docker-compose.postgres.yml (checked 2026-09-23)
  # Source: https://github.com/paperless-ngx/paperless-ngx/blob/main/docker/compose/docker-compose.env (checked 2026-09-23)
  # Source: https://github.com/paperless-ngx/paperless-ngx/blob/main/docs/configuration.md (checked 2026-09-23)
  # Changed: Removed the documented '8000:8000' port; Caddy reaches the webserver on the proxy network.
  #          The documented 'env_file: docker-compose.env' is replaced by explicit environment entries, and its required PAPERLESS_SECRET_KEY ('change-me') is generated.
  #          The documented fixed database password 'paperless' is replaced by a generated one, passed to Postgres as POSTGRES_PASSWORD and to Paperless as PAPERLESS_DBPASS (whose default is 'paperless').
  #          Added PAPERLESS_URL (the env file says it is required on a public domain), PAPERLESS_TRUSTED_PROXIES, PAPERLESS_TIME_ZONE and PAPERLESS_ADMIN_USER/PASSWORD from the configuration reference.
  paperless-broker:
    image: "docker.io/valkey/valkey:9-alpine"
    container_name: "paperless-broker"
    restart: "unless-stopped"
    volumes:
      - "paperless-redisdata:/data"
    networks:
      paperless-backend:
        aliases:
          - "broker"
  paperless-db:
    image: "docker.io/library/postgres:18"
    container_name: "paperless-db"
    restart: "unless-stopped"
    volumes:
      - "paperless-pgdata:/var/lib/postgresql"
    environment:
      POSTGRES_DB: "paperless"
      POSTGRES_USER: "paperless"
      POSTGRES_PASSWORD: "${PAPERLESS_DB_PASSWORD}"
    networks:
      paperless-backend:
        aliases:
          - "db"
  paperless-webserver:
    image: "ghcr.io/paperless-ngx/paperless-ngx:latest"
    container_name: "paperless-webserver"
    restart: "unless-stopped"
    depends_on:
      - "paperless-db"
      - "paperless-broker"
    volumes:
      - "paperless-data:/usr/src/paperless/data"
      - "paperless-media:/usr/src/paperless/media"
      - "./paperless/export:/usr/src/paperless/export"
      - "./paperless/consume:/usr/src/paperless/consume"
    environment:
      PAPERLESS_REDIS: "redis://broker:6379"
      PAPERLESS_DBHOST: "db"
      PAPERLESS_DBENGINE: "postgresql"
      PAPERLESS_DBPASS: "${PAPERLESS_DB_PASSWORD}"
      PAPERLESS_SECRET_KEY: "${PAPERLESS_SECRET_KEY}"
      PAPERLESS_URL: "${PAPERLESS_URL}"
      PAPERLESS_TRUSTED_PROXIES: "172.30.0.2"
      PAPERLESS_TIME_ZONE: "Etc/UTC"
      PAPERLESS_ADMIN_USER: "admin"
      PAPERLESS_ADMIN_PASSWORD: "${PAPERLESS_ADMIN_PASSWORD}"
    networks:
      proxy: {}
      paperless-backend:
        aliases:
          - "webserver"

networks:
  # Pinned so the trusted-proxy address given to each app (172.30.0.2) is exact.
  # If "docker compose up" reports "Pool overlaps", change 172.30.0 here, in Caddy's
  # ipv4_address and in every trusted-proxy value to a free 172.x.0 range.
  proxy:
    ipam:
      config:
        - subnet: "172.30.0.0/24"
          ip_range: "172.30.0.128/25"
          gateway: "172.30.0.1"
  paperless-backend:
    internal: true

volumes:
  caddy-data:
  caddy-config:
  paperless-data:
  paperless-media:
  paperless-pgdata:
  paperless-redisdata:

Caddyfile save as caddy/Caddyfile

Caddy gets and renews the HTTPS certificate for docs.example.org by itself once the DNS record points at your server and ports 80 and 443 reach it.

# Caddyfile built at dankhost.com. Save it as ./caddy/Caddyfile next to docker-compose.yml.
# Caddy gets and renews a Let's Encrypt certificate for each name below by itself,
# once the DNS records point at this server and ports 80 and 443 reach it.

# Paperless-ngx
docs.example.org {
	reverse_proxy paperless-webserver:8000
}

Already running nginx, Nginx Proxy Manager, Caddy or Traefik? The reverse-proxy settings Paperless-ngx needs, for all four, each cited to Paperless-ngx's own docs.

.env

The secrets are left blank here on purpose: a password printed on a public page is the same for everyone who copies it. The builder fills them with random letters and digits made in your browser.

# .env for Paperless-ngx, from dankhost.com/app/paperless/. Fill the blank secrets before starting.
# Keep this file private (chmod 600).

# Paperless-ngx
# 32 random letters and digits: the builder fills this in your browser
PAPERLESS_DB_PASSWORD=
# 64 random letters and digits: the builder fills this in your browser
PAPERLESS_SECRET_KEY=
# 24 random letters and digits: the builder fills this in your browser
PAPERLESS_ADMIN_PASSWORD=
PAPERLESS_URL=https://docs.example.org

Changes from the official file

Besides prefixing every service, container, volume, folder and variable with paperless (so any set of apps can share one file), these are all the differences from what the project documents:

  • Removed the documented '8000:8000' port; Caddy reaches the webserver on the proxy network.
  • The documented 'env_file: docker-compose.env' is replaced by explicit environment entries, and its required PAPERLESS_SECRET_KEY ('change-me') is generated.
  • The documented fixed database password 'paperless' is replaced by a generated one, passed to Postgres as POSTGRES_PASSWORD and to Paperless as PAPERLESS_DBPASS (whose default is 'paperless').
  • Added PAPERLESS_URL (the env file says it is required on a public domain), PAPERLESS_TRUSTED_PROXIES, PAPERLESS_TIME_ZONE and PAPERLESS_ADMIN_USER/PASSWORD from the configuration reference.

Notes for Paperless-ngx behind the proxy

  • Log in as 'admin' with PAPERLESS_ADMIN_PASSWORD from .env. Drop files into ./paperless/consume and they are imported.
  • OCR defaults to English. Set PAPERLESS_OCR_LANGUAGE (for example 'deu') in the webserver's environment if most of your documents are in another language.

How to run it

  1. At your DNS provider, add an A record named docs on your domain pointing at the server's public IP address, and forward TCP 80, TCP 443 and UDP 443 to it.
  2. Save the three files in one folder: docker-compose.yml and .env side by side, the Caddyfile at ./caddy/Caddyfile. Replace example.org with your domain in the Caddyfile, the compose file and the .env, or let the builder do it.
  3. Fill the blank PAPERLESS_DB_PASSWORD, PAPERLESS_SECRET_KEY, PAPERLESS_ADMIN_PASSWORD in .env. The builder generates them; on the server, tr -dc A-Za-z0-9 </dev/urandom | head -c 32 prints 32 random letters and digits. Then chmod 600 .env.
  4. Start it:
    docker compose up -d
    docker compose logs -f caddy   # watch the certificate arrive
  5. Open the new address (docs. plus your domain) in a browser and follow the notes above.

Back it up

Paperless-ngx documents the document exporter as the backup that works for every install: it writes all documents, thumbnails, settings and database contents to the export folder, and on later runs only updates what changed.

Below is the BACKUP.md the builder writes next to the compose file above: which of its folders and volumes hold data, the dump command the project documents, rewritten for this file's service names, what to copy with which container stopped, and a restore check. Pick more apps in the builder and it covers them all in one file.

# BACKUP.md built at dankhost.com for: Paperless-ngx

What to copy from the docker-compose.yml built with this file, the database dump each project documents (rewritten for the service names in that file), what to copy with which container stopped, and how to check the result. Run every command in the folder that holds docker-compose.yml.

The folders are owned by the containers' users: put sudo in front of tar if it says "Permission denied". Named volumes live under /var/lib/docker/volumes, not next to the compose file, so they are copied through a throwaway ubuntu container (Docker's documented --volumes-from method). tar makes a full copy each run; for large folders an incremental tool (restic, borg, rsync) saves time and space.

Never run "docker compose down -v" on this file: it deletes the named volumes of every app in it.

## Before you start

    BACKUP=/mnt/backup/selfhost   # change this: a disk or machine other than this server's system disk
    mkdir -p "$BACKUP"

## Every time: the three stack files

    tar czf "$BACKUP/stack-files.tar.gz" docker-compose.yml .env caddy

.env holds the database passwords and secret keys the apps were set up with; keep this archive as private as the data.

## Caddy (the reverse proxy)

Caddy's docs: 'The data directory must not be treated as a cache.' It holds the TLS certificates and their private keys; without it Caddy has to ask Let's Encrypt for every certificate again.

- caddy-data (named volume, /data in caddy)
  BACK UP: TLS certificates, private keys, OCSP staples.
- caddy-config (named volume, /config in caddy)
  SKIP: the last active configuration, kept for 'caddy run --resume', which this setup does not use: it starts from the Caddyfile.
- ./caddy (/etc/caddy in caddy)
  IN stack-files.tar.gz: the Caddyfile, copied with the stack files above.

Copy (Caddy keeps serving while you copy):

    docker run --rm --volumes-from caddy -v "$BACKUP":/backup ubuntu tar cvf /backup/caddy-data.tar /data

Restore check:

    tar tf "$BACKUP/caddy-data.tar" > /dev/null && echo OK
    docker run --rm --volumes-from caddy -v "$BACKUP":/backup ubuntu bash -c "cd /data && tar xvf /backup/caddy-data.tar --strip 1"

Sources:
- Caddy docs: Conventions, Data directory: https://caddyserver.com/docs/conventions#data-directory (checked 2026-09-24)
- Docker docs: Volumes, Back up, restore, or migrate data volumes: https://docs.docker.com/engine/storage/volumes/#back-up-restore-or-migrate-data-volumes (checked 2026-09-24)

## Paperless-ngx

Paperless-ngx documents the document exporter as the backup that works for every install: it writes all documents, thumbnails, settings and database contents to the export folder, and on later runs only updates what changed.

What this compose mounts:
- paperless-redisdata (named volume, /data in paperless-broker)
  SKIP: the Valkey task-queue broker; not among the volumes Paperless lists for backup.
- paperless-pgdata (named volume, /var/lib/postgresql in paperless-db)
  COVERED BY THE COMMAND BELOW: Postgres data files; the exporter copies the database contents.
- paperless-data (named volume, /usr/src/paperless/data in paperless-webserver)
  OPTIONAL: auxiliary data, in Paperless's words. The exporter does not need it; Paperless's other Docker option is to copy this volume together with media and pgdata.
- paperless-media (named volume, /usr/src/paperless/media in paperless-webserver)
  COVERED BY THE COMMAND BELOW: your documents (originals and archived versions); the exporter copies them.
- ./paperless/export (/usr/src/paperless/export in paperless-webserver)
  BACK UP: the exporter's target: after the command below it holds a complete export.
- ./paperless/consume (/usr/src/paperless/consume in paperless-webserver)
  SKIP: the inbox Paperless watches for new files; files leave it once consumed.

1. Database dump for paperless-db (runs in paperless-webserver):

    docker compose exec -T paperless-webserver document_exporter ../export

   The documented cron form (-T avoids 'The input device is not a TTY'); ../export inside the container is ./paperless/export here. It also covers the media volume. The export leaves out API tokens, which must be made again after an import, and can only be imported into the same Paperless version.

2. Copy (Paperless-ngx keeps running):
   Paperless's only condition is to make sure it is not busy consuming documents while the exporter runs.

    tar czf "$BACKUP/paperless-export.tar.gz" ./paperless/export

Restore check:

    test -s ./paperless/export/manifest.json && echo OK   # the export writes all database metadata to manifest.json
    tar tzf "$BACKUP/paperless-export.tar.gz" > /dev/null && echo OK

Put a copy back (with Paperless-ngx stopped):

    tar xzf "$BACKUP/paperless-export.tar.gz"   # recreates ./paperless/export; move the old folder aside first

Restore with the document importer into a completely empty install of the same version: put the export back into ./paperless/export, then

    docker compose exec -T paperless-webserver document_importer ../export

Sources:
- Paperless-ngx docs: Administration (Making backups, Document exporter and importer): https://github.com/paperless-ngx/paperless-ngx/blob/main/docs/administration.md (checked 2026-09-24)

Update it

What docker compose pull does depends only on how each image line in the compose file above is tagged. For Paperless-ngx as this page writes it:

ServiceImageHow it is pinnedWhat docker compose pull does
caddycaddy:2Major version only (tag 2)Takes the newest image tagged 2: minor and patch releases of 2, never 3. A new major version needs a tag edit.
paperless-brokerdocker.io/valkey/valkey:9-alpineMajor version only (tag 9-alpine)Takes the newest image tagged 9-alpine: minor and patch releases of 9, never 10. A new major version needs a tag edit.
paperless-db databasedocker.io/library/postgres:18Major version only (tag 18)Takes the newest image tagged 18: minor and patch releases of 18, never 19. A new major version needs a tag edit.
paperless-webserverghcr.io/paperless-ngx/paperless-ngx:latestNot pinned: moving tag latestMoves to the newest image published as latest, which can be a new major version.

Do not raise the major version of paperless-db by editing its tag. Keep its tag, 18, as it is when you update Paperless-ngx.

PostgreSQL's docs: a new major version may change how data is stored on disk, so a data folder written by an older major version will not start under a newer one (the server refuses it). Moving needs a dump and restore (pg_dumpall, then load the dump into the new version) or pg_upgrade. Minor releases of the same major version never change the storage format. Source: PostgreSQL docs: Upgrading a PostgreSQL Cluster checked 2026-09-30

What Paperless-ngx's docs say about updating

Paperless-ngx's docs: check that nothing is being consumed, make a backup, stop it with docker compose down, then docker compose pull and docker compose up. Starting the new image applies any new database migrations.

  • Before moving to v3.0, read Paperless-ngx's v3 migration instructions: it has breaking changes that need manual steps before the upgrade. Upgrading to v3 also clears the task history.
  • The docs start it once in the foreground (docker compose up without -d) to watch the migrations, then stop it with Ctrl+C and start it with -d. The steps below use -d and follow the same output with docker compose logs -f.
  • The latest tag is always the latest stable release. Since 1.7.1 Paperless-ngx also publishes release-series tags that get only bugfix releases; its docs still recommend reading the release notes before any upgrade.

Source: Paperless-ngx docs: Administration, Updating Paperless (Docker Route) checked 2026-09-30

The steps

  1. Back up first, as in Back it up above. An update can migrate Paperless-ngx's data on its first start and its database with it; the copy is the way back.
  2. Download the new images. Running containers are not touched yet:
    docker compose pull
  3. Recreate the containers whose image changed. Volumes and bind-mounted folders stay as they are:
    docker compose up -d
  4. Watch Paperless-ngx start (Ctrl+C stops following the log, not the app):
    docker compose logs -f paperless-webserver
  5. Optional: remove the old images the pull left without a tag. This covers every stack on the machine, not only this one:
    docker image prune

Docker's reference for these commands: Docker docs: docker compose pull checked 2026-09-30; Docker docs: docker compose up (recreates changed containers, keeps volumes) checked 2026-09-30; Docker docs: docker image prune checked 2026-09-30

Locked out? Reset the admin password

Paperless-ngx's docs give no command that resets an existing password.

  1. Their password reset is by email, and it works only once Paperless can send mail (PAPERLESS_EMAIL_HOST and the other email settings; this file already sets PAPERLESS_URL). Source: Paperless-ngx docs (repository): Usage, Password reset read 2026-10-03
  2. Their documented command-line way back in is a new superuser, run through docker compose exec like every Paperless management command. It asks for the name, email and password. Source: Paperless-ngx docs (repository): Administration, Management utilities and Create superuser read 2026-10-03
    docker compose exec paperless-webserver createsuperuser

Run the commands in the folder that holds docker-compose.yml. docker compose exec runs the command in the container that is already running: Docker docs: docker compose exec read 2026-10-03

Sources

Every page below was fetched on the date shown.

Add Paperless-ngx to the builder All one hundred apps

Made with AI tools. ยท Privacy