Self-host Paperless-ngx on a VPS

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

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

Specification

Status
Verified on arm64 with image tag 2.14.5
Category
Productivity
Services
paperless, redis
Ports
8000
Volumes
3
Memory
about 512 MiB
arm64
tested
amd64
image published
Settings to fill in
none

About Paperless-ngx

Scan, index, and archive your paper documents into a searchable digital library. Runs 2 containers (paperless, redis), with paperless listening on port 8000; data is kept in named volumes.

What it deploys

Paperless-ngx runs as 2 services in a single Compose app, listening on port 8000, with 3 named volume mounts.

ServiceImageTagPortsVolumes
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

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Verified. Verified on arm64 with image tag 2.14.5. Verified means our CI ran this exact image version and it answered on its health path. Evidence
  • Host ports. It publishes port 8000 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. 1 secret is generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
paperlessPAPERLESS_REDISPreset by the template
paperlessPAPERLESS_SECRET_KEYGenerated at deploy
paperlessPAPERLESS_URLPreset by the template

Install Paperless-ngx on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get paperless-ngx
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

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

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Paperless-ngx.

More in Productivity

All Productivity templates