papercrate/README.md

Paperless-NEO

Backend Integration Tests

Integration tests require a running Postgres instance. The repository includes a lightweight compose file for local runs:

docker compose -f docker-compose.test.yml up -d
export TEST_DATABASE_URL=postgres://paperless:paperless_test@localhost:5433/paperless_test
cargo test

Stop the database when you are done:

docker compose -f docker-compose.test.yml down

The compose service uses tmpfs storage, giving each test run a clean database.

Runtime Dependencies

• ocrmypdf (optional but recommended): Used by the OCR worker to extract text from PDFs when no embedded text layer is available. Ensure it is installed and available on the worker hosts if OCR is desired.