Paperless-ngx

A self-hosted document management system that transforms physical documents into a searchable online archive. Scan, index, and archive all your paper documents with OCR and full-text search.

What You Can Do After Deployment

Visit your domain and log in with the superuser account you configured via environment variables.

Document ingestion: Upload documents through the web UI, email, or drop files into the consume volume. Supported formats include PDF, images, Office documents, and plain text.

OCR and search: All documents are automatically processed with OCR (Tesseract) and indexed for full-text search. Find any document instantly by searching its content, tags, correspondents, or document types.

Organization: Create tags, correspondents, document types, and storage paths. Paperless-ngx can automatically assign these based on matching rules you define.

Workflows: Set up automatic processing rules that trigger on document consumption — assign tags, set correspondents, move to storage paths, or run custom scripts.

Multi-user: Create multiple user accounts with granular permissions for shared document management.

First-Time Setup

Set PAPERLESS_ADMIN_USER and PAPERLESS_ADMIN_PASSWORD environment variables to create the initial superuser account. If not set, you will need to create one via the management command.

Configuration

• Language: Set PAPERLESS_OCR_LANGUAGE to your language code (e.g., eng, chi_tra, jpn, deu)
• Time zone: Set PAPERLESS_TIME_ZONE (e.g., Asia/Taipei, America/New_York)
• Secret key: PAPERLESS_SECRET_KEY is auto-generated — change it for production use

License

GPL-3.0 — GitHub