airajena commented on code in PR #8: URL: https://github.com/apache/fineract-chat-archive/pull/8#discussion_r2777020173
########## Readme.md: ########## @@ -1 +1,41 @@ -#fineract chat message archive +# Fineract Chat Archive + +A standalone tool that will archive public Slack messages for Apache Fineract into a static site. + +## Local run + +``` +./gradlew updateChatArchive +``` + +Configuration: +- File: `config/archive.properties` +- Key: `channels.allowlist` (comma-separated channel names, e.g. `#fineract`) +- Key: `output.dir` (relative path for site output, default `docs`) +- Key: `state.dir` (relative path for cursor state, default `state`) +- Key: `fetch.lookback.days` (how many days to re-fetch, default `1`) + +Output: +- Daily pages: `docs/daily/<channel>/<YYYY-MM-DD>.md` +- Channel index: `docs/daily/<channel>/index.md` +- Global index: `docs/index.md` +- Thread replies are rendered below parent messages with a simple prefix. + +Environment: +- `SLACK_TOKEN` (Slack Bot token) + +Required Slack scopes: +- `channels:read` (list public channels) +- `channels:history` (read public channel history) +- `chat:write` (resolve permalinks) Review Comment: Removed chat:write to keep least-privilege. Added note: if Slack returns missing_scope, add the reported scope and reinstall. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
