Skip to content

Paperless-ngx

Document management system that transforms your physical documents into a searchable online archive with OCR.

Imageghcr.io/paperless-ngx/paperless-ngx:latest
Web UIhttp://your-server:8000
Config path{BASE_DIR}/paperlessngx/data
Websitedocs.paperless-ngx.com
Source codeGitHub

Resource Impact

PerformanceMedium — OCR processing with Redis broker and SQLite database
StorageMedium — Stores original documents and OCR data

Installation

sh
mithrandir install paperlessngx

Architecture

Paperless-ngx runs as a multi-container stack:

ContainerDescription
paperlessngx_webserverMain application with web UI (port 8000)
paperlessngx_brokerRedis broker for task queue

Data is stored using SQLite (no separate database container needed). Documents are stored in four directories under {BASE_DIR}/paperlessngx/:

  • data/ — Application data and SQLite database
  • media/ — Processed documents and thumbnails
  • export/ — Document export directory
  • consume/ — Drop files here to be automatically imported

Configuration

VariableDescription
PAPERLESS_OCR_LANGUAGELanguage for OCR processing (default: eng). See available languages

When HTTPS is enabled via Caddy, PAPERLESS_URL is automatically set to the correct HTTPS URL.

Setup

  • Open the web UI at http://your-server:8000
  • Create a superuser account: you'll be prompted on first access
  • Drop documents into the consume/ directory or upload them via the web UI