dankhostself-host anything

Stirling-PDF with Docker Compose

Stirling PDF is a powerful, open-source PDF editing platform. Run it as a personal desktop app, in the browser, or deploy it on your own servers with a private API. In the project's words: Stirling-PDF README 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 Stirling-PDF to the builder to use your own domain and combine it with other apps in one file.

What Stirling-PDF needs

Only figures Stirling-PDF'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
RAMnot stated4 GB
For a small team of 1-10 users; the same page recommends 8-16 GB for 10-50 users. A 50 MB PDF with complex graphics can take 200-500 MB of memory while it is processed, and OCR and PDF-to-image are the heaviest operations. Source: Stirling-PDF docs: Performance Optimization (Resource Recommendations) checked 2026-09-23
CPU2 cores4 cores
Given as "2 cores (4+ recommended)" for a small team of 1-10 users; 4-8 cores for 10-50 users. Source: Stirling-PDF docs: Performance Optimization (Resource Recommendations) checked 2026-09-23
Disknot stated10 GB free space
For a small team of 1-10 users; 50 GB (SSD recommended) for 10-50 users. Source: Stirling-PDF docs: Performance Optimization (Resource Recommendations) checked 2026-09-23

On top of this, Caddy (the reverse proxy in the file) is a single small container.

Which hardware Stirling-PDF 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 stirling-pdf. No image for this hardware; the builder leaves the app out.
ServiceImagePlatforms in the manifestDigestRegistryChecked
stirling-pdfdocker.stirlingpdf.com/stirlingtools/stirling-pdf:latestamd64, arm64sha256:66b6edb8ee62e307a8b335166e8931a6e65b39c9bf73b5e517fbfe9c613ba221docker.stirlingpdf.com2026-09-25

A manifest says an image exists for a CPU, not how well Stirling-PDF 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 Stirling-PDF 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 Stirling-PDF alone on example.org: the official definition with its published ports removed and Caddy added in front.

# docker-compose.yml built at dankhost.com for: Stirling-PDF
# 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"

  # ---- Stirling-PDF (pdf.example.org) ----
  # Source: https://docs.stirlingpdf.com/Installation/Docker%20Install (checked 2026-09-23)
  # Source: https://docs.stirlingpdf.com/Production-Deployment-Guide/ (checked 2026-09-23)
  # Source: https://docs.stirlingpdf.com/FAQ (checked 2026-09-23)
  # Changed: Removed the documented '8080:8080' port; Caddy reaches stirling-pdf:8080 on the proxy network.
  stirling-pdf:
    image: "docker.stirlingpdf.com/stirlingtools/stirling-pdf:latest"
    container_name: "stirling-pdf"
    volumes:
      - "./stirling-pdf/stirling-data:/configs"
    restart: "unless-stopped"
    networks:
      proxy: {}

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"

volumes:
  caddy-data:
  caddy-config:

Caddyfile save as caddy/Caddyfile

Caddy gets and renews the HTTPS certificate for pdf.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.

# Stirling-PDF
pdf.example.org {
	reverse_proxy stirling-pdf:8080
}

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

.env

Stirling-PDF needs no secret here; the builder adds nothing you have to fill in by hand.

# .env for Stirling-PDF, from dankhost.com/app/stirling-pdf/. Nothing here is secret.
# Keep this file private (chmod 600).
# None of the chosen apps needs a variable here.

Changes from the official file

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

  • Removed the documented '8080:8080' port; Caddy reaches stirling-pdf:8080 on the proxy network.

Notes for Stirling-PDF behind the proxy

  • Login is on by default and the account is documented: sign in as admin with the password stirling and change it immediately. Until you do, anyone who finds the address can log in with those credentials.
  • Caddy keeps the public hostname and sends X-Forwarded-Proto: https, which Stirling-PDF's production guide asks a reverse proxy to do so that login redirects work. Caddy sets no upload size limit of its own.
  • OCR language files, logs and automation pipelines need the extra volumes from the docs' 'Full Setup' section. If docker.stirlingpdf.com cannot be reached, the FAQ names stirlingtools/stirling-pdf:latest on Docker Hub as the same image.

How to run it

  1. At your DNS provider, add an A record named pdf 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. Nothing in .env needs filling in; chmod 600 .env all the same.
  4. Start it:
    docker compose up -d
    docker compose logs -f caddy   # watch the certificate arrive
  5. Open the new address (pdf. plus your domain) in a browser and follow the notes above.

Back it up

Stirling-PDF's production guide lists what to back up: the local user database (stirling-pdf-DB-<version>.mv.db), settings.yml, custom files and OCR languages, and says the simplest way is to back up the whole configs directory. In this compose /configs is ./stirling-pdf/stirling-data.

Below is the BACKUP.md the builder writes next to the compose file above: which of its folders and volumes hold data, 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: Stirling-PDF

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)

## Stirling-PDF

Stirling-PDF's production guide lists what to back up: the local user database (stirling-pdf-DB-<version>.mv.db), settings.yml, custom files and OCR languages, and says the simplest way is to back up the whole configs directory. In this compose /configs is ./stirling-pdf/stirling-data.

What this compose mounts:
- ./stirling-pdf/stirling-data (/configs in stirling-pdf)
  BACK UP: Stirling-PDF's /configs: settings.yml and the local H2 user database.

1. Stop stirling-pdf. The guide does not say to stop it; stopping it for the copy keeps the H2 database file from changing mid-copy.

    docker compose stop stirling-pdf

2. Copy while stirling-pdf is stopped:

    tar czf "$BACKUP/stirling-pdf-stirling-data.tar.gz" ./stirling-pdf/stirling-data

3. Start it again:

    docker compose start stirling-pdf

Restore check:

    tar tzf "$BACKUP/stirling-pdf-stirling-data.tar.gz" > /dev/null && echo OK

Put a copy back (with stirling-pdf stopped):

    tar xzf "$BACKUP/stirling-pdf-stirling-data.tar.gz"   # recreates ./stirling-pdf/stirling-data; move the old folder aside first

Stop it, put ./stirling-pdf/stirling-data back, start it.

Sources:
- Stirling-PDF docs: Production Deployment Guide, Step 8 Backup & Disaster Recovery: https://docs.stirlingpdf.com/Production-Deployment-Guide/ (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 Stirling-PDF 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.
stirling-pdfdocker.stirlingpdf.com/stirlingtools/stirling-pdf:latestNot pinned: moving tag latestMoves to the newest image published as latest, which can be a new major version.

What Stirling-PDF's docs say about updating

Stirling-PDF's Docker page: docker compose down, docker compose pull, docker compose up -d. Its settings and database are in the mounted /configs folder and survive the update.

Source: Stirling-PDF docs: Docker Installation, Updating Stirling PDF checked 2026-09-30

The steps

  1. Back up first, as in Back it up above. An update can migrate Stirling-PDF's data on its first start; 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 Stirling-PDF start (Ctrl+C stops following the log, not the app):
    docker compose logs -f stirling-pdf
  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

Stirling-PDF's docs give no way to reset a lost admin password.

  1. Login is on by default in this image. An account locked after too many failed logins (loginAttemptCount) unlocks itself after loginResetTimeMinutes. Source: Stirling-PDF docs: System and Security read 2026-10-03
  2. The only other documented route is turning login off (SECURITY_ENABLELOGIN set to false). Behind this file's proxy that would leave every PDF tool open to anyone who finds the address. Source: Stirling-PDF docs: System and Security read 2026-10-03

Sources

Every page below was fetched on the date shown.

Add Stirling-PDF to the builder All one hundred apps

Made with AI tools. ยท Privacy