← Directory

Paperless-ng

Paperless-ng is an archived self-hosted document management system for homelab users that indexes scanned documents, stores metadata, and makes them…

  • Productivity
  • Tools & Utilities
Paperless-ng is an archived self-hosted document management system for homelab users that indexes scanned documents, stores metadata, and makes them searchable; it is now maintained as Paperless-ngx, a direct continuation and drop-in replacement.

Platform availability

Available on 1 of 9 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

35/100 Low

Maintained
0GitHub repository is archived
Popular
755,409 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
602 GB minimum RAM, runs on ARM

Availability: platform listings confirmed today, links checked 10 days ago

GitHub stars
5,409
Open issues
246
Last commit
2023-01-12
Latest release
ng-1.5.0
License
GPL-3.0
Activity
stale

Checked 4 days ago - source: GitHub (jonaswinkler/paperless-ng)

Resources & Compatibility

Minimum requirements: 2 GB RAM, 1 CPU core(s). ARM (e.g. Raspberry Pi) is supported.

Checked 14 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Start it with Docker Compose If you are using Docker, run docker compose up -d to start Paperless-ngx in the background and have it start after a reboot. If you skip this, the server will not be available in your browser. source
  • Create consume and media folders Make the consume and media folders before using Paperless-ngx, for example with mkdir -p consume media. consume is where you drop new documents, and media is where your files are stored; without them, document intake or saving can fail. source
  • Run both the web server and consumer If you are not using Docker Compose, start the webserver and the document_consumer background command. The webserver gives you the web page and API (the service's data connections), while the consumer watches the consume folder; missing either leaves the site incomplete or files unprocessed. source
  • Archived — superseded by Paperless-ngx This repository is archived and no longer actively maintained. Paperless-ngx is a direct continuation and drop-in replacement — prefer it for new installations. source

Fetched 3 days ago - each note links to its source

Alternatives (3)

  • Genius Scan - Genius Scan is a scanner in your pocket.
  • Paperless-ngx - Paperless-ngx is a self-hosted document management system that converts scanned and digital documents into a searchable archive using optic…
  • Paperwork - Paperwork is a personal document manager for scanned documents (and PDFs).

Checked 11 days ago - source: AlternativeTo

Common questions

Where should new and stored documents be placed?

Create the consume and media folders before use. New documents go into consume, and stored files are kept in media; without these folders, document intake or saving can fail.

Do I need to run a separate consumer process?

If you are not using Docker Compose, run both the web server and the document_consumer background command. The consumer watches the consume folder, and missing either component can leave the site incomplete or files unprocessed.

Can the app control my scanner?

No, it only processes files the scanner produces. The scanner should push scanned images to the server, for example via scan-to-FTP, or files can be added manually.

What storage should a Raspberry Pi install use?

Use an external drive instead of the SD card and keep regular backups.

Does Paperless-ng still support GnuPG?

No, Paperless-ng does not support GnuPG anymore. Storing data on encrypted file systems can achieve a similar result.

Answers sourced from docs.paperless-ngx.com, docs.paperless-ngx.com, github.com, www.reddit.com

Community

Collected 13 days ago - public community threads