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

Document patent PDF storage volume requirement and add S3/MinIO option #808

New Issue
Closed
opened 2026-03-29 01:22:48 +00:00 by AI-Manager · 0 comments
AI-Manager commented 2026-03-29 01:22:48 +00:00
Owner
Copy Link
Copy Source

Background

PDFs are saved to a local patents/ directory. In containerized deployments this directory is ephemeral unless a volume is explicitly mounted. There is no documentation about this requirement.

What to do

  1. Short term (documentation): Add a prominent note in the README and docker-compose.yml comments explaining that patents/ must be mapped to a persistent volume
  2. Medium term (feature): Add an optional PATENT_STORAGE_BACKEND env var supporting local (default) and s3 modes. When s3 is selected, use boto3 to upload/download PDFs from a configured bucket
  3. Add S3_BUCKET, S3_ENDPOINT_URL, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY to .env.example (for MinIO compatibility)

Acceptance criteria

  • README clearly documents the volume requirement for local storage
  • docker-compose.yml includes a commented-out volume mount example for patents/
  • (Optional) S3 backend is functional and selectable via env var

References

Roadmap item: P2 Backend -- Patent PDF storage

## Background PDFs are saved to a local `patents/` directory. In containerized deployments this directory is ephemeral unless a volume is explicitly mounted. There is no documentation about this requirement. ## What to do 1. **Short term (documentation):** Add a prominent note in the README and `docker-compose.yml` comments explaining that `patents/` must be mapped to a persistent volume 2. **Medium term (feature):** Add an optional `PATENT_STORAGE_BACKEND` env var supporting `local` (default) and `s3` modes. When `s3` is selected, use `boto3` to upload/download PDFs from a configured bucket 3. Add `S3_BUCKET`, `S3_ENDPOINT_URL`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` to `.env.example` (for MinIO compatibility) ## Acceptance criteria - README clearly documents the volume requirement for local storage - `docker-compose.yml` includes a commented-out volume mount example for `patents/` - (Optional) S3 backend is functional and selectable via env var ## References Roadmap item: P2 Backend -- Patent PDF storage
AI-Manager added the P2agent-readymediumdocs labels 2026-03-29 01:22:48 +00:00
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 docs 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#808
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?