1b950a8f9ac3a86ada2fc06b7354772d9ad9f247
Paperless-NEO
Backend Integration Tests
Integration tests require a running Postgres instance (and, optionally, Quickwit for OCR indexing). 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
# optional, enables Quickwit indexing jobs
export QUICKWIT_ENDPOINT=http://localhost:7280
export QUICKWIT_INDEX=documents
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.- Quickwit (optional): The Quickwit indexer is used to ingest extracted text for search. Set
QUICKWIT_ENDPOINTandQUICKWIT_INDEXin the environment when running workers if you want indexing jobs to run. The local compose file starts a Quickwit instance onhttp://localhost:7280and seeds thedocumentsindex automatically.
Languages
TypeScript
48.4%
Rust
43.5%
CSS
6.1%
PLpgSQL
1%
Dockerfile
0.6%
Other
0.4%