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-ngxSpecification
- 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
- License
- Copyleft license, GPL-3.0
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.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| 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.
| Service | Variable | Value |
|---|---|---|
| paperless | PAPERLESS_REDIS | Preset by the template |
| paperless | PAPERLESS_SECRET_KEY | Generated at deploy |
| paperless | PAPERLESS_URL | Preset by the template |
Install Paperless-ngx on a VPS
-
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 -
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 | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get paperless-ngx -
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.
Docs and upstream
More in Productivity
- PairDropAn AirDrop-style app for sending files and messages between devices on the same network, from any browser.
- PenpotAn open-source design and prototyping platform, a self-hosted alternative to Figma.
- OutlineA fast, structured team wiki and knowledge base with real-time collaborative editing.
- osTicketA widely used open-source support ticket system for teams handling customer requests.
- PlaneAn open-source project management tool for tracking issues and cycles, an alternative to Linear and Jira.
- PlankaA Trello-style kanban board for visualizing and tracking work across a team.