Self-host Paperless-ngx with Levelrail

Verified

Scan, index, and archive your paper documents into a searchable digital library.

  • Authorpaperless-ngxVerified by Levelrail
  • LicenceGPL-3.0
  • Memory512 MiB
  • Archarm64
  • Services2

How to self-host Paperless-ngx

  1. Pull the images

    2 images are pulled on your server.

    Show images
    • paperlessngx/paperless-ngx:2.14.5
    • redis:7.4
  2. Create the app

    2 services start in a single Compose app, with 3 named volume mounts for your data, on port 8000.

  3. Fill in the secrets

    1 secret is generated and stored encrypted, 2 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

Paperless-ngx requirements

Memory
About 512 MiB
Architectures
amd64 image published, arm64 tested
Ports
8000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
GPL-3.0, copyleft license
  • Verified. Verified on arm64 with image tag 2.14.5. Our CI ran this exact image version and it answered on its health path. Evidence
  • Host ports. It publishes port 8000 on the host, so open them in the VPS firewall only if you want that.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Paperless-ngx. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Paperless-ngx docs page.

Deploy Paperless-ngx your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Paperless-ngx from the CLI

levelrail-cli templates deploy paperless-ngx --name my-paperless-ngx

Deploy Paperless-ngx with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/paperless-ngx/deploy

Paperless-ngx configuration

Paperless-ngx services

ServiceImagePortsVolumes
paperless paperlessngx/paperless-ngx:2.14.5 8000 paperless_data -> /usr/src/paperless/datapaperless_media -> /usr/src/paperless/media
redis redis:7.4 none paperless_redis_data -> /data

Paperless-ngx environment variables

VariableServiceValue
PAPERLESS_REDIS paperless Preset by the template
PAPERLESS_SECRET_KEY paperless Generated at deploy
PAPERLESS_URL paperless Preset by the template

Ports and volumes

Ports
8000
Volumes
3 named mounts: paperless_data -> /usr/src/paperless/data, paperless_media -> /usr/src/paperless/media, paperless_redis_data -> /data

Paperless-ngx FAQ

How much memory does Paperless-ngx need?

The catalog lists about 512 MiB of memory for Paperless-ngx across its 2 services.

Does Paperless-ngx run on arm64?

For Paperless-ngx, arm64 is tested; amd64 is image published.

What licence is Paperless-ngx under?

Paperless-ngx is licensed under GPL-3.0, which is copyleft, so changes you distribute must be shared under the same terms.

Does Paperless-ngx need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which database does Paperless-ngx bundle?

The template includes Redis, running as its own service.

Which ports does Paperless-ngx use?

Paperless-ngx listens on port 8000 inside the stack.

Where does Paperless-ngx keep its data?

In named volumes: paperless_data mounted at /usr/src/paperless/data, paperless_media mounted at /usr/src/paperless/media and paperless_redis_data mounted at /data.

Can I deploy Paperless-ngx on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id paperless-ngx for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image paperlessngx/paperless-ngx:2.14.5, redis:7.4 is what you deploy there.

levelrail-cli templates deploy paperless-ngx --name my-paperless-ngx