# Paperless-ngx

Paperless-ngx is a self-hosted document management system that converts scanned and digital documents into a searchable archive using optical character recognition, tagging, and metadata storage for homelab users who. It is open source and self-hosted, installable on Umbrel, Proxmox, Kubernetes (Helm), ZimaOS, TrueNAS, Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1088/paperless-ngx

## Description

Paperless-ngx is a self-hosted document management system that converts scanned and digital documents into a searchable archive using optical character recognition, tagging, and metadata storage for homelab users who want a paperless, organized records repository.

## Platform availability

Available on 6 of 9 platforms: Unraid, TrueNAS, Umbrel, ZimaOS, Proxmox, Helm.

## Health score

92/100 (Excellent), based on 4 of 4 factors.
- Maintained: 100 (last commit 16 days ago)
- Popular: 93 (46,443 GitHub stars)
- Easy to install: 100 (6 install platforms, install notes, setup guide, Docker image)
- Light to run: 60 (2 GB minimum RAM, runs on ARM)

## Links

- Umbrel: https://apps.umbrel.com/app/paperless
- GitHub: https://github.com/paperless-ngx/paperless-ngx
- Documentation: https://docs.paperless-ngx.com
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=paperless-ngx
- Kubernetes (Helm): https://artifacthub.io/packages/helm/gabe565/paperless-ngx
- ZimaOS: https://github.com/bigbeartechworld/big-bear-casaos/tree/master/Apps/paperless-ngx
- TrueNAS: https://apps.truenas.com/catalog/paperless-ngx/
- Docker Hub: https://hub.docker.com/r/linuxserver/paperless-ngx
- Unraid: https://ca.unraid.net/apps/paperless-ngx-0mnwff00ajlp1s?q=paperless-ngx

## Common questions

### Why is backup especially important for a Paperless-ngx server?

Paperless-ngx is meant to replace paper for important documents, so it should run on a server with proper backup in place.

### What command should I run to start a Docker Compose installation?

Run docker compose up -d from the folder with docker-compose.yml. Without this, the app and its document-processing services are not running.

### What should I install on Debian if I do not use Docker?

Install the listed apt packages first. These tools handle images, PDFs, and scanning, so document processing can fail without them.

### How do I migrate from Paperless-ng to Paperless-ngx?

Migrating from Paperless-ng is easy: just drop in the new docker image.

### What basic setup topics should a new user review?

A community guide covers basic configuration choices, tags, document types, and Docker Compose setup.

## Alternatives

- Genius Scan: Genius Scan is a scanner in your pocket.
- Mayan EDMS: Mayan EDMS is a web-based open-source electronic document management system that helps individuals and teams organize, index, and share doc…
- Papermerge: Papermerge is an open-source document management system that archives, organizes, and retrieves digital documents from scanner uploads and…
- Paperwork: Paperwork is a personal document manager for scanned documents (and PDFs).
- Papra: Papra is a lightweight, self-hosted document management and archiving platform that automatically imports, stores, and organises files for…
- Teedy: Teedy is an open-source, lightweight document management system for individuals and small businesses that provides optical character recogn…
- docspell: Docspell assists in organizing your piles of digital documents, resulting from scanners, e-mails and other sources with minimal effort.
- ecodms: EcoDMS is an audit-compliant document management system for self-hosted users that scans, stores, manages, and retrieves data and documents…
- paperless-ng: Paperless-ng is an archived self-hosted document management system for homelab users that indexes scanned documents, stores metadata, and m…

---
Source: Our Local Host (https://ourlocalhost.com/app/1088/paperless-ngx), the self-hosted and open-source app directory.