Skip to content

Update README for file exchange path and new env vars#189

Merged
dcellison merged 1 commit intomainfrom
docs/readme-updates
Mar 26, 2026
Merged

Update README for file exchange path and new env vars#189
dcellison merged 1 commit intomainfrom
docs/readme-updates

Conversation

@dcellison
Copy link
Copy Markdown
Owner

Summary

Update README to reflect recent PRs:

  1. File exchange section - files are now saved to per-user directories under the data directory (not inside the workspace), and FILE_RETENTION_DAYS enables automatic cleanup
  2. Env var table - add GITHUB_NOTIFY_CHAT_ID (PR Route GitHub notifications to a separate Telegram group #182) and FILE_RETENTION_DAYS (PR Add age-based cleanup for uploaded files #188)

- File exchange section: files now saved to DATA_DIR, mention
  FILE_RETENTION_DAYS cleanup
- Env var table: add GITHUB_NOTIFY_CHAT_ID and FILE_RETENTION_DAYS
@dcellison
Copy link
Copy Markdown
Owner Author

Review by Kai

This is a documentation-only PR. The changes are accurate, internally consistent, and well-scoped.

One suggestion worth checking:

suggestionREADME.md (lines ~78-79): The updated paths use DATA_DIR as a placeholder (DATA_DIR/memory/MEMORY.md, DATA_DIR/history/<chat_id>/), but the diff doesn't show DATA_DIR in the env var table. If it isn't already documented there (above the visible diff hunk), it should be added alongside GITHUB_NOTIFY_CHAT_ID and FILE_RETENTION_DAYS for consistency.

Everything else looks clean:

  • The security bullet additions (history/memory directory blocking, per-service SSRF controls) are additive and not contradictory.
  • The file exchange description correctly drops the old hardcoded files/ path in favor of the per-user data dir.
  • FILE_RETENTION_DAYS=0 defaulting to disabled is clearly documented.
  • The new GitHub notification routing section matches the env var entry.

@dcellison dcellison merged commit 17f18cb into main Mar 26, 2026
1 check passed
@dcellison dcellison deleted the docs/readme-updates branch March 26, 2026 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants