Skip to content

Paperless-ngx App


Paperless-ngx is an application that manages your personal documents. With the help of a document scanner (see Scanner recommendations), paperless transforms your wieldy physical document binders into a searchable archive and provides many utilities for finding and managing your documents.

Custom config

Custom configuration can be set in /app/data/paperless.conf using the File manager. See upstream docs for various options.


Files should be uploaded to /app/data/consume using the File manager. Once uploaded, a background task scans the documents automatically.

Document retagger

To run the document retagger, open a Web Terminal and execute:

# cd /app/code/src
# python3 document_retagger -T


To export existing documents, open a Web Terminal and execute:

# cd /app/code/src
# mkdir -p /app/data/out
# python3 document_exporter /app/data/out
100%|████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00, 545.92it/s]


To import an existing export at /app/data/in, open a Web Terminal and execute:

# cd /app/code/src
# python3 document_importer /app/data/in
Installed 4 object(s) from 1 fixture(s)
Copy files into paperless...
100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00, 34.11it/s]
Updating search index...
100%|████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00, 104.00it/s]