Add Paperless-ngx app #9

Merged

backmeupplz merged 1 commit from symphony/MYG-KANEO-6-paperless-ngx into master

2026-05-25 14:57:29 +00:00

backmeupplz commented

2026-05-25 14:40:13 +00:00

(Migrated from github.com)

Summary

Add Paperless-ngx to the embedded MyGround app catalog with metadata, SVG icon, README catalog row, and post-install notes.
Add a three-service Compose template based on current Paperless-ngx Docker Compose guidance: app, Redis broker, and PostgreSQL.
Define generated install-time secrets, OCR/time zone variables, persistent data/media/consume/export/PostgreSQL/Redis storage, and PostgreSQL dump/restore backup config.
Add registry coverage plus setup-only install coverage to prove MyGround can write state, storage paths, .env, and generated compose for the new app.

Official docs referenced:

Validation

bun run build - passed; generated web/dist needed by Rust embedding.
rustfmt --check src/registry.rs - passed.
cargo test registry::tests::paperless_ngx - passed.
cargo test - passed: 278 lib tests, 6 main tests, 83 API tests; 12 ignored backup e2e tests unchanged.
Docker Compose smoke: docker compose -f apps/paperless-ngx.yml config --quiet with concrete Paperless env/storage values - passed.
git diff --check - passed.

Notes

cargo fmt --check still fails on pre-existing unrelated rustfmt differences across the repo; this branch formats only the touched src/registry.rs file to avoid unrelated churn.
Docker daemon is available locally, but I did not pull/start the full Paperless stack to avoid heavy image pulls and long-running service state in this task workspace. The setup-only test and Compose config smoke cover catalog/install template correctness.

Manual QA: not required for this catalog-level change. Automated validation covers registry parsing, app setup file generation, compose syntax, and existing API/frontend-embed tests.

## Summary - Add Paperless-ngx to the embedded MyGround app catalog with metadata, SVG icon, README catalog row, and post-install notes. - Add a three-service Compose template based on current Paperless-ngx Docker Compose guidance: app, Redis broker, and PostgreSQL. - Define generated install-time secrets, OCR/time zone variables, persistent data/media/consume/export/PostgreSQL/Redis storage, and PostgreSQL dump/restore backup config. - Add registry coverage plus setup-only install coverage to prove MyGround can write state, storage paths, `.env`, and generated compose for the new app. Official docs referenced: - https://docs.paperless-ngx.com/setup/ - https://docs.paperless-ngx.com/configuration/ - https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose ## Validation - `bun run build` - passed; generated `web/dist` needed by Rust embedding. - `rustfmt --check src/registry.rs` - passed. - `cargo test registry::tests::paperless_ngx` - passed. - `cargo test` - passed: 278 lib tests, 6 main tests, 83 API tests; 12 ignored backup e2e tests unchanged. - Docker Compose smoke: `docker compose -f apps/paperless-ngx.yml config --quiet` with concrete Paperless env/storage values - passed. - `git diff --check` - passed. ## Notes - `cargo fmt --check` still fails on pre-existing unrelated rustfmt differences across the repo; this branch formats only the touched `src/registry.rs` file to avoid unrelated churn. - Docker daemon is available locally, but I did not pull/start the full Paperless stack to avoid heavy image pulls and long-running service state in this task workspace. The setup-only test and Compose config smoke cover catalog/install template correctness. Manual QA: not required for this catalog-level change. Automated validation covers registry parsing, app setup file generation, compose syntax, and existing API/frontend-embed tests.