Paperless-ngx
Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive.
Backup & Restore
Here is the procedure to backup and restore the Paperless-NGX application and all of its data.
Backup
On a terminal, enter the following command:
docker compose exec -T <paperless_webserver> document_exporter -z ../export
Where:
-
-Tis used to suppress "The input device is not a TTY" error ; -
-zis used to zip the export ; -
../exportis used because this path inside the container is automatically mounted on your host on the folder export.
Restore
You'll need to unzip the previous export!
On a terminal, enter the following command:
docker compose exec -T <paperless_webserver> document_importer ../export/<unzipped_directory>/
Where:
-
-Tis used to suppres "The device is not a TTY" error ; -
../export/<unzipped_directory>/is the path to your previous backup unzipped.
Consumption fails with "Ghostscript PDF/A rendering failed"
When updating Paperless-NGX, you may get the following error:
Consumption fails with "Ghostscript PDF/A rendering failed" Newer versions of OCRmyPDF will fail if it encounters errors during processing. This is intentional as the output archive file may differ in unexpected or undesired ways from the original. As the logs indicate, if you encounter this error you can set PAPERLESS_OCR_USER_ARGS: '{"continue_on_soft_render_error": true}' to try to 'force' processing documents with this issue.
To fix this, you can:
- Go to your paperless web interface
- Go to Configuration menu
- Go to OCR Settings tab
- In the OCR Arguments tile, enter
{"continue_on_soft_render_error": true} - Save
And, the error is fixed!
Creating a Super User
If you don't have a super user with your Paperless-NGX installation, you can create one with a command.
docker compose exec -it <PAPERLESS CONTAINER> createsuperuser
> Username (leave blank to use 'paperless'):
> Email address:
> Password:
> Password (again):
> Superuser created successfully.