V0.1 · Architecture & service documentation
← All services

Applications / SERVICE DOCUMENTATION

Paperless-ngx

Document intake, OCR, organisation and retrieval in a self-hosted application.

V0.1 · Reviewed 29 October 2026Documentation snapshot · Not live status

01 / THE ROLE

In this lab.

The active Paperless stack combines the web application with a dedicated Redis broker, an external PostgreSQL database and NAS-backed persistent document storage. The catalogue describes this active stack rather than a separate historical project that was removed.

02 / THE CONNECTIONS

Follow the flow.

Paperless-ngx · component viewConceptual relationships
Document intakeA file enters the processing workflow
Paperless-ngxWeb interface & background processing
Connected responsibilities & state
PostgreSQLDocument metadata
Persistent filesNAS-backed documents
Dedicated RedisBackground-work broker

A responsibility view: branches show related components, rather than physical placement or a single request path.

03 / How it works

How it works.

The application accepts documents, performs processing and exposes their metadata and searchable content. Work queued for background processing and stored document files have different lifecycles. PostgreSQL holds application metadata while persistent file storage holds the corresponding documents and supporting state.

04 / Persistent data & recovery

Persistent data & recovery.

A valid recovery must keep database contents and document files consistent. Restoring only the web container loses the unique state; restoring only metadata can leave records with missing documents. Required application settings and secure access material must accompany the data.

05 / How to check it

How to check it.

Check the web interface and a safe functional path such as importing a neutral test document and finding it afterwards. A working login page does not verify OCR, task processing or access to stored files. Real document contents and identities never belong in public screenshots.

06 / Decisions & limits

Decisions & limits.

The useful unit of recovery is the whole application, not one container or one volume. This stack makes the distinction between code, a broker, relational metadata and document storage particularly visible.

KEEP EXPLORING

Related parts of the lab.