paperless-ngx

Product Introduction

1. Definition: Paperless-ngx is an open-source, self-hosted document management system (DMS) designed for the archival, indexing, and retrieval of digitized documents. It is a fork and the official successor to the original Paperless and Paperless-ng projects, built with a Python/Django backend and a modern Vue.js frontend.
2. Core Value Proposition: Paperless-ngx exists to provide individuals, families, and businesses with a private, secure, and fully searchable digital archive for their physical documents. Its primary value is eliminating paper clutter through intelligent Optical Character Recognition (OCR), automated organization, and a powerful search engine, all while keeping user data entirely under their own control on their own server.

Main Features

1. Intelligent Document Processing & OCR: Paperless-ngx automatically processes uploaded documents. It performs OCR using the open-source Tesseract engine, supporting over 100 languages, to extract searchable text from image-based scans. It can also optionally use Azure AI for remote OCR. The system converts documents to the archival-standard PDF/A format for long-term preservation while retaining the original files.
2. Automated Metadata Tagging with Machine Learning: The system uses a machine learning model to automatically suggest and assign metadata such as tags, correspondents (senders), and document types (e.g., invoice, receipt, contract). This drastically reduces manual data entry and improves organization. Advanced, opt-in AI features using Large Language Models (LLMs) can provide document suggestions, chat functionality, and similar-document retrieval.
3. Advanced Search & Organizational Framework: It features a full-text search engine with auto-completion, relevance ranking, and in-document match highlighting. Documents can be organized using a multi-faceted system of tags, correspondents, document types, and custom storage paths. Users can create and save custom filtered views for rapid access to specific document sets.
4. Multi-User System with Granular Permissions: Paperless-ngx includes a robust permissions system supporting multiple users. Administrators can assign "global" permissions (e.g., view all documents) as well as granular, object-specific permissions (e.g., edit permissions for a specific tag or document), making it suitable for team and business use.
5. Flexible Consumption Workflows: Documents can be ingested via a watched folder (consumption directory), direct web upload, drag-and-drop, or through a built-in email processing system (powered by Apache Tika). The email system allows for rules-based filtering and actions (mark as read, delete). A visual workflow editor provides fine-grained control over the document processing pipeline.

Problems Solved

1. Pain Point: Physical document disorganization and the inability to quickly find specific paperwork. Paperless-ngx solves the problem of "I know I have that document, but where is it?" by creating a instantly searchable digital archive.
2. Target Audience: The primary user personas are privacy-conscious individuals and families, small to medium-sized businesses (SMBs) handling invoices and contracts, legal professionals managing case files, and administrators in any organization needing a compliant, self-hosted document archive. It is ideal for Linux enthusiasts, homelab users, and anyone avoiding proprietary cloud services.
3. Use Cases: Essential scenarios include digitizing and archiving tax records and receipts for long-term retrieval, managing incoming supplier invoices and automating their categorization, creating a searchable archive of client contracts or patient records under data sovereignty laws (like GDPR), and processing scanned mail automatically via email rules.

Unique Advantages

1. Differentiation: Unlike proprietary cloud DMS solutions (e.g., Dropbox, Evernote) or expensive enterprise systems, Paperless-ngx is free, open-source, and self-hosted, ensuring complete data privacy and ownership. Compared to simple folder structures on a NAS, it adds powerful OCR, intelligent tagging, and a dedicated search interface. It is the actively maintained, community-driven evolution of the original Paperless projects.
2. Key Innovation: Its core innovation is the seamless integration of a modern web application with local, automated document intelligence. The combination of offline Tesseract OCR, an optional on-device machine learning model for auto-tagging, and the opt-in use of LLMs for advanced document interaction, all within a private deployment, sets it apart from both simplistic scanners and invasive cloud services.

Frequently Asked Questions (FAQ)

1. Is Paperless-ngx really free and open source? Yes, Paperless-ngx is completely free and open-source software (FOSS) released under the GPLv3 license. You can review, modify, and distribute the source code, and there are no subscription fees or hidden costs.
2. How does Paperless-ngx handle data privacy and security? Paperless-ngx is a self-hosted document management system, meaning all your documents, metadata, and the OCR text are stored exclusively on your own server or computer. No data is sent to external servers unless you explicitly enable optional features like remote Azure OCR or LLM integration.
3. What file formats does Paperless-ngx support for document ingestion? It natively supports PDFs, common image formats (JPEG, PNG, TIFF), and plain text files. With the optional Apache Tika integration, it can also process and perform OCR on Microsoft Office (Word, Excel, PowerPoint) and LibreOffice documents, as well as email files (.eml).
4. Can I access my Paperless-ngx archive from my phone or tablet? Yes, the Paperless-ngx web application is fully responsive and works on mobile browsers. The interface adapts to smaller screens, allowing you to search, view, and manage your documents from smartphones and tablets.
5. What is the difference between Paperless, Paperless-ng, and Paperless-ngx? Paperless was the original project. Paperless-ng was a significant rewrite with new features. Paperless-ngx is the current, community-supported fork and official successor to Paperless-ng, focused on continued development, stability, and distributing maintenance responsibility across a team.