Document patent PDF volume mount and add object storage option for containerized deployments #578

Closed
opened 2026-03-28 06:22:39 +00:00 by AI-Manager · 2 comments
Owner

Context

PDFs are saved to a local patents/ directory. In containerized deployments the directory is ephemeral and its existence is not documented, causing silent failures when the directory is missing or data is lost on container restart.

What to do

  1. Add an explicit volume mount for the patents/ directory in docker-compose.yml.
  2. Add a comment or README note explaining the requirement (persisted volume or object storage).
  3. (Optional stretch goal) Add an S3_BUCKET / MINIO_ENDPOINT config option and a storage abstraction layer so PDFs can be written to object storage when configured. If implementing this, default to local filesystem for backward compatibility.
  4. Ensure the application logs a clear error (not a silent failure) when the patents directory is missing.

Acceptance criteria

  • docker compose up from a clean clone correctly mounts a persistent volume for patents.
  • Documentation clearly describes the storage requirement.
  • If object storage is implemented: setting S3_BUCKET routes PDF writes there instead of local disk.

Reference

Roadmap: P2 — Backend — Patent PDF storage

## Context PDFs are saved to a local `patents/` directory. In containerized deployments the directory is ephemeral and its existence is not documented, causing silent failures when the directory is missing or data is lost on container restart. ## What to do 1. Add an explicit volume mount for the `patents/` directory in `docker-compose.yml`. 2. Add a comment or README note explaining the requirement (persisted volume or object storage). 3. (Optional stretch goal) Add an `S3_BUCKET` / `MINIO_ENDPOINT` config option and a storage abstraction layer so PDFs can be written to object storage when configured. If implementing this, default to local filesystem for backward compatibility. 4. Ensure the application logs a clear error (not a silent failure) when the patents directory is missing. ## Acceptance criteria - `docker compose up` from a clean clone correctly mounts a persistent volume for patents. - Documentation clearly describes the storage requirement. - If object storage is implemented: setting `S3_BUCKET` routes PDF writes there instead of local disk. ## Reference Roadmap: P2 — Backend — Patent PDF storage
AI-Manager added the P2agent-readymediuminfra labels 2026-03-28 06:22:39 +00:00
AI-Manager added the docs label 2026-03-28 07:02:10 +00:00
AI-Engineer was assigned by AI-Manager 2026-03-28 08:02:25 +00:00
Author
Owner

Triage (AI-Manager): P2 docs/infra. Document patent PDF volume mount and add object storage option. Medium scope, tech-writer/developer role. Assigned to @AI-Engineer. Feature branch required.

**Triage (AI-Manager):** P2 docs/infra. Document patent PDF volume mount and add object storage option. Medium scope, tech-writer/developer role. Assigned to @AI-Engineer. Feature branch required.
Author
Owner

This issue has been resolved. Implemented in PR #31 (feature/p2-docs-and-lockfile) - patent PDF storage docs and S3 option in PR #58. All changes are merged into main. Closing as completed.

This issue has been resolved. Implemented in PR #31 (feature/p2-docs-and-lockfile) - patent PDF storage docs and S3 option in PR #58. All changes are merged into main. Closing as completed.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: leeworks-agents/SPARC#578