Deployn
Paperless-ngx Guide: Install on Synology, VPS and Home Server-heroimage

Paperless-ngx: Your Path to the Paperless Office

Set up Paperless-ngx: installation on a Synology NAS, VPS and home server, plus costs, hardware, workflows, scanners, apps, GoBD and alternatives.

Paperless-ngx is a self-hosted document management system (DMS) and the way to a paperless office. You can digitize documents: you upload letters, invoices and contracts, or scan them straight in. Paperless recognizes the text with OCR (Tesseract), assigns correspondent, document types and tags, archives everything and makes it searchable. The software is open source and free.

This guide is the central hub for all posts about Paperless-ngx. It answers the questions before installation (costs, hardware, platform) and then points to the guides for installation, storage, workflows and scanners.

Start page of Paperless-ngx 3 with the saved views Eingang and Fristen prüfen

What is Paperless-ngx?

The history is a typical open-source story. On 1 January 2017 Daniel Quinn released the first version of “Paperless” because he no longer wanted to search dusty folders. In early 2019 he ended development. Jonas Winkler continued the project as Paperless-ng (“NG” stands for Angular and “next-gen”). When that project was no longer maintained in 2021, the community fork Paperless-ngx emerged in 2022. It prevailed and is still actively developed.

What Paperless-ngx does:

  • OCR: Makes scanned documents and images searchable. The original is kept, and a PDF/A archive version is created in addition.
  • Metadata: Correspondent, document type, date, tags and custom fields. Paperless learns from documents you already filed and suggests assignments.
  • Full-text search with filters and saved views.
  • Automatic import from a folder, from mailboxes, or by upload and API.
  • Office documents and emails with Tika and Gotenberg in addition to PDFs and images.
  • Workflows that tag, sort and forward new documents automatically.
  • Multiple users with permissions per document. How to set up Paperless for a family is covered in Use Paperless-ngx with your family.
  • AI features from version 3: Metadata suggestions, document chat and search through a language model when you connect a provider, for example a local model through Ollama. They are optional and off by default.

Costs

The software costs nothing. You pay for the place where it runs. Three typical options:

Option Running costs One-time
VPS at a provider Server and domain none
Own NAS or home server Electricity Device and disks
Cloud DMS subscription Subscription per month none

A calculation for the VPS: the Hetzner server CAX11 with 2 cores and 4 GB RAM costs 7.13 euros gross per month according to the price list (November 2026), so about 86 euros a year. The IPv4 address and a domain (roughly 10 to 15 euros a year, depending on the extension) come on top. Check the provider’s current price list. An alternative is a VPS from netcup (affiliate link).

A calculation for a NAS: a device averaging 25 watts around the clock uses about 219 kilowatt-hours a year. At 0.30 euros per kilowatt-hour that is about 66 euros of electricity. The purchase price for device and disks comes on top.

A backup in a second location is needed in every case. It must not sit on the same device.

Hardware

Measured values from my installation with PostgreSQL, Valkey, Tika, Gotenberg and Caddy on a Debian 13 server: at idle the stack uses about 1.2 GB of memory. Most of it is Paperless itself (about 730 MB) and Tika (about 270 MB).

  • RAM: 2 GB is the minimum, 4 GB runs comfortably. Without Tika and Gotenberg you save about 300 MB.
  • CPU: Text recognition uses the processor. Two cores are enough; a larger stack simply takes longer.
  • Storage: An export of twelve sample documents takes about 640 KB. For normal scans count on 100 to 300 KB per page, and plan for originals plus the archive version. An SSD is faster than a hard disk but not required.
  • Raspberry Pi: Runs with a 64-bit system from the Pi 4 on. The home server guide lists settings for weak devices.

Choose a platform and install

Platform Fits when Guide
VPS you want access from anywhere and know some Linux Install Paperless-ngx on a VPS
Synology NAS you already own one and use Docker (Container Manager) with Portainer Install Paperless-ngx on a Synology NAS
Home server, mini PC, Raspberry Pi you want to run it on your home network Paperless-ngx on a home server
Other NAS (QNAP, Ugreen) the NAS supports Docker The Synology guide serves as a template; folders and users differ

Setup works on every platform with Docker. All guides use Docker Compose with PostgreSQL and Valkey in Docker containers. I recommend the Synology NAS if you own one, because it draws little power and the documents stay on your home network. Without a NAS a VPS is the easiest route, and a Proxmox VM works too. For Tika and Gotenberg: you only need them if you want to store more than PDFs and images.

Document storage

In Paperless you organize documents with five tools. How you use them decides how tidy things stay later:

  • Correspondent: Sender or recipient, for example your electricity provider.
  • Document type: Invoice, contract, notice, bank statement.
  • Tags: Everything that cuts across, such as “tax deductible” or “check deadline”.
  • Storage path: Decides where the file lies on disk.
  • Custom fields: Your own fields such as amount or contract number.

My advice: few document types, few tags, but clean correspondents. Full-text search finds the rest. You build the folder structure on the server with storage paths, as Paperless-ngx: Storage paths and folder structure shows step by step. It pays off before you import hundreds of documents.

Workflows

Workflows replace manual filing. You define triggers and actions: if a document matches a file name, a source or words in the text, Paperless sets tags, type, correspondent and storage path. Sending email and webhooks are possible too. Four ready-made examples and the pitfalls are in Paperless-ngx workflows.

Scanners and apps

Scanners: The most elegant option is a network scanner that saves to a folder on the network. The consume folder is the entrance for that. You share it with Samba, assign tags while scanning with subfolders, and split a stack into single documents with separator sheets. The setup is in Paperless-ngx: Set up a scanner. As a pure document scanner, I recommend the Brother ADS-1700W (Amazon affiliate link).

Apps: On the go you upload documents with a phone app. The Paperless developers keep a list of projects in their wiki. Examples:

The apps are third-party projects. Before using one, check how current it is and whether it supports Paperless 3.

GoBD, GDPR and retention periods

This section is not legal advice. For business use, clarify the details with your tax advisor. The rules below are German.

Retention periods (businesses): Since 1 January 2025 the Fourth Bureaucracy Relief Act sets these periods under the German Commercial Code and Fiscal Code:

Documents Period
Accounting vouchers (invoices, bank statements, receipts) 8 years
Commercial and business letters without voucher function 6 years
Books, inventories, annual accounts 10 years

The period starts at the end of the calendar year in which the document was created or received. Different rules apply to banks, insurers and securities institutions.

Retention periods (private): The law sets few fixed periods. A useful rule of thumb: invoices for craftsmen’s work on property two years, purchase receipts at least as long as the warranty, contracts as long as they run, tax notices and receipts at least until the notice becomes final. Pension records, certificates and deeds you keep permanently.

GoBD: The German principles for proper keeping and retention of books require that electronic vouchers are stored unchanged and traceably. Paperless-ngx does not enforce that. Anyone with the rights can change metadata and delete documents, and the administrator has access to the database and files. The software is not certified as GoBD compliant. So you establish immutability through measures:

  • Permissions: Everyday users get view and add only, no edit and delete. Use the administrator account for administration only.
  • Log: The Paperless audit log (on by default) records changes to documents, document types, correspondents and tags. Keep it enabled. Deleted documents first land in the trash.
  • Checksums: Paperless stores a checksum for every file, and the sanity checker reports deviations. That detects corrupted files, but does not protect against someone with access to the database.
  • Immutable storage: Export regularly to a target where files can be neither overwritten nor deleted afterwards, such as S3-compatible storage with Object Lock or a Borg repository in append-only mode. Keep the exports as long as the retention period.
  • Procedure documentation: Describe how vouchers arrive, are checked and filed, and who has access. For replacement scanning also document when the paper is destroyed.

For tax-relevant documents in a business, clarify with your tax advisor whether these measures suffice or a certified archive system is needed.

GDPR: If you run Paperless privately for yourself, the household exemption applies. If you use it for business or for third parties, you are the controller. Then:

  • Conclude a data processing agreement with your hosting provider. Large providers supply one.
  • Encrypt the connection (HTTPS) and, where possible, the disk.
  • Assign permissions per user and enable two-factor authentication.
  • Decide when you delete documents.
  • Connect AI features only if you know where data is sent. A local model keeps documents on your server.

Security, backup and updates

  • Access: HTTPS through a reverse proxy such as Caddy, strong passwords, two-factor and your provider’s firewall. If you are the only user, you can hide Paperless behind a VPN.
  • Backup: Essential. The built-in exporter writes documents and metadata to the export folder. Copy it to a second device and test the restore. More in Paperless backup and restore and the Ofelia backup.
  • Updates: With fixed image tags such as 3.4 you get all patch versions automatically. Read the release notes before a new series. Never replace the PostgreSQL major version in the tag alone; follow this guide.

Alternatives

Paperless-ngx is not the best choice for everyone. These projects take other routes:

Software In short
Docspell Open-source DMS focused on automatic recognition and email import.
Mayan EDMS Extensive document management with workflows, more for organizations.
Teedy Lean DMS with a web interface, tags and full-text search.
Nextcloud with recognition apps If you already run Nextcloud and need files rather than a DMS.
Paid cloud DMS Less effort, but you give up data and control.

I stay with Paperless-ngx because the community is large, updates come regularly and the files lie as normal PDFs in a folder. So you are not locked in.

Frequently Asked Questions (FAQ)

  • Is Paperless-ngx really free? Yes, the software is open source. Costs arise for server or hardware, electricity, domain and a backup.
  • How much RAM does Paperless-ngx need? The stack with database, Valkey, Tika and Gotenberg uses about 1.2 GB at idle. Plan for 4 GB, at least 2 GB.
  • Does Paperless-ngx run on a Raspberry Pi? Yes, from the Raspberry Pi 4 with a 64-bit system. Reduce the number of workers and use an SSD.
  • Is Paperless-ngx GoBD compliant? Not out of the box. Paperless does not enforce immutability, and the software is not certified. With restricted permissions, audit log, immutable backup and procedure documentation you can support the requirements. Clarify this with your tax advisor.
  • How long must I keep invoices? Businesses keep accounting vouchers for eight years since 2025 and commercial letters for six years. For private use few fixed periods apply.
  • How secure is my data? It depends on your setup: HTTPS, two-factor, firewall, updates and a tested backup are the most important building blocks.
  • Can I export documents again? Yes. The document exporter writes originals and metadata, and the media folder holds the files as normal PDFs.
  • Which scanners work well? Scanners with a Scan to SMB or Scan to Folder function. How to set them up is in the scanner guide.
  • Are there apps for Paperless-ngx? Yes, for Android and iOS, for example Paperless Mobile and Swift Paperless.
  • Can I use Paperless-ngx with AI? From version 3 there are built-in AI features that you connect to a language model. They are off by default.

As an Amazon Associate I earn from qualifying purchases.

Related Blog Posts for Paperless-ngx Guide: Install on Synology, VPS and Home Server

Use Paperless-ngx with Your Family: Users, Groups and Permissions

Set up Paperless-ngx for several people: separate accounts, private and shared documents, groups, permissions, one mailbox per person and two-factor sign-in.

Install Paperless-ngx on a VPS: Docker, Caddy and Valkey

Install Paperless-ngx 3 on a Debian 13 VPS: Docker Compose with PostgreSQL, Valkey and Tika, HTTPS through Caddy, backup and update, step by step.

Paperless-ngx: Set Up a Scanner with Samba, Barcodes and an App

Scan documents into Paperless-ngx: share the consume folder via Samba, use subfolders as tags, split stacks with barcodes and upload with a phone app.

Paperless-ngx: Set Up Storage Paths and Folder Structure

Paperless-ngx stores files as 0000001.pdf by default. Get readable file names and folders with storage paths, placeholders and the document_renamer command.

Install Paperless-ngx 3 on a Synology NAS with Docker and Portainer

Install Paperless-ngx 3 on a Synology NAS with Docker Compose in Portainer, including PostgreSQL, Valkey and Tika, folder permissions and a scanner inbox.

Paperless-ngx Workflows: Sort Documents Automatically

Paperless-ngx workflows assign tags, document types, correspondents and storage paths automatically. Triggers, actions and four ready-made examples.

Install Paperless-ngx on a Home Server: Docker Compose Guide

Install Paperless-ngx 3 on a home server, mini PC or Raspberry Pi with Docker Compose, including PostgreSQL, Valkey and Tika. Guide for your local network.

Paperless-ngx Backup & Restore: The Right Strategy

Create a secure, incremental Paperless-ngx backup with Docker and restore your documents in an emergency. Includes instructions for PostgreSQL and MariaDB, step by step.

Paperless-ngx: Upgrade PostgreSQL to Version 18

Move Paperless-ngx on Docker to PostgreSQL 18, for example from version 13 or 14: create a dump, adjust the data path, restore your data and then update to Paperless 3.

Paperless-ngx: Set Up Automated Docker Backup with Ofelia

Set up automated backups for Paperless-ngx directly in your Docker stack using Ofelia. Schedule reliable cron jobs — no external server needed. Full guide.