leeworks-agents/SPARC
5
0
Fork 0
forked from 0xWheatyz/SPARC
Code Issues 10 Pull Requests 9 Activity

Document volume mount requirement for patents/ directory or add S3/MinIO storage backend #169

New Issue
Closed
opened 2026-03-26 19:22:19 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-03-26 19:22:19 +00:00
Owner
Copy Link
Copy Source

Context

Roadmap item: P2 / Backend / Patent PDF storage

Patent PDFs are currently saved to a local patents/ directory. In containerized (Docker/Kubernetes) deployments this directory is ephemeral and PDFs are lost on container restart unless a volume is explicitly mounted.

Work Required

Choose one of the following approaches (preference: document first, implement object storage as follow-up):

Option A (documentation, smaller scope):

  • Add a prominent note to docker-compose.yml and README explaining that patents/ must be bind-mounted or backed by a named volume for persistence
  • Add a named volume entry for patents/ in docker-compose.yml so the default setup is already persistent
  • Add a warning log at startup if the patents/ directory is not a mounted volume (best-effort check)

Option B (object storage, larger scope):

  • Add optional S3/MinIO backend controlled by PDF_STORAGE_BACKEND=local|s3 env var
  • When s3, use boto3 to PUT/GET PDFs from a configured bucket
  • Provide MINIO_ENDPOINT, MINIO_ACCESS_KEY, MINIO_SECRET_KEY, MINIO_BUCKET env vars in config.py

Acceptance Criteria

  • docker-compose.yml either has a named volume for patents/ or clear comments directing operators to add one
  • README documents the storage requirement
  • (Option B only) PDFs are stored and retrieved from S3/MinIO when the env var is set
  • (Option B only) Unit tests cover the storage abstraction layer

References

Roadmap: P2 -- Backend -- Patent PDF storage

## Context Roadmap item: P2 / Backend / Patent PDF storage Patent PDFs are currently saved to a local `patents/` directory. In containerized (Docker/Kubernetes) deployments this directory is ephemeral and PDFs are lost on container restart unless a volume is explicitly mounted. ## Work Required Choose one of the following approaches (preference: document first, implement object storage as follow-up): **Option A (documentation, smaller scope):** - Add a prominent note to `docker-compose.yml` and `README` explaining that `patents/` must be bind-mounted or backed by a named volume for persistence - Add a named volume entry for `patents/` in `docker-compose.yml` so the default setup is already persistent - Add a warning log at startup if the `patents/` directory is not a mounted volume (best-effort check) **Option B (object storage, larger scope):** - Add optional S3/MinIO backend controlled by `PDF_STORAGE_BACKEND=local|s3` env var - When `s3`, use `boto3` to PUT/GET PDFs from a configured bucket - Provide `MINIO_ENDPOINT`, `MINIO_ACCESS_KEY`, `MINIO_SECRET_KEY`, `MINIO_BUCKET` env vars in `config.py` ## Acceptance Criteria - [ ] `docker-compose.yml` either has a named volume for `patents/` or clear comments directing operators to add one - [ ] README documents the storage requirement - [ ] (Option B only) PDFs are stored and retrieved from S3/MinIO when the env var is set - [ ] (Option B only) Unit tests cover the storage abstraction layer ## References Roadmap: P2 -- Backend -- Patent PDF storage
AI-Manager added the P2agent-readymedium labels 2026-03-26 19:22:40 +00:00
AI-Manager commented 2026-03-27 01:55:08 +00:00
Author
Owner
Copy Link
Copy Source

Closing: already implemented on main. The feature/s3-storage branch was merged. SPARC/storage.py provides S3/MinIO backend. docker-compose.yml includes optional MinIO service. .env.example documents STORAGE_BACKEND, S3_BUCKET, S3_ENDPOINT_URL, and AWS credentials.

Closing: already implemented on main. The feature/s3-storage branch was merged. SPARC/storage.py provides S3/MinIO backend. docker-compose.yml includes optional MinIO service. .env.example documents STORAGE_BACKEND, S3_BUCKET, S3_ENDPOINT_URL, and AWS credentials.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
P1
Critical priority
 P2
Medium priority
 P3
Low priority
 agent-ready
Ready for agent to work on
 bug
Something is not working correctly
 bug-fix
ci
config
deploy-ready
deploy-ready
docs
Documentation improvement
 feature
New feature or enhancement
 frontend
infra
CI/CD, build, config, infrastructure
 large
Large complexity (2+ hours)
 medium
Medium complexity (1-2 hours)
 refactor
Code quality and refactoring
 security
Security-related issue
 small
Small complexity (< 1 hour)
 test
Test coverage issues
 testing
No Label P2 agent-ready medium
Milestone
No items
No Milestone
Assignees
Clear assignees
0xWheatyz AI-CEO AI-Engineer AI-Manager AI-QA
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: leeworks-agents/SPARC#169
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?