Google Git
Sign in
apache/fineract-chat-archive

Slack Chat Archiver

Mirrored from https://github.com/apache/fineract-chat-archive.git
Clone this repo:

Branches

  1. b1dff1b use Java 25 by Adam Monsen · 16 hours ago main
  2. 4183305 upgrade gradle 8.14.3 → 9.3.1 by Adam Monsen · 16 hours ago
  3. 7243e0a reword headers by Adam Monsen · 16 hours ago
  4. ad2f731 fix: preserve archive state in workflow by Adam Monsen · 16 hours ago
  5. e7a7468 improve install, test, and run instructions by Adam Monsen · 16 hours ago

Slack Chat Archiver

A standalone tool for archiving Slack messages into a static site.

Install

GitHub Actions can run the archive update daily and commit new output.

Run local

  • Clone this repo
  • Install Java 25
  • Set SLACK_TOKEN and CHANNELS_ALLOWLIST env vars
  • Set up Slack app (see below)
  • Run (see below)

Run on GitHub Actions

  • Set up Slack app (see below)
  • Create a new repo
  • Copy update-archive.yml to a folder named .github/workflows/
  • Customize CHANNELS_ALLOWLIST env var in update-archive.yml
  • Add repository secret SLACK_TOKEN

Test

./gradlew test

Run

./gradlew --quiet updateChatArchive

Configuration (environment variables):

  • SLACK_TOKEN (required; Slack Bot token) ⚠️ warning: keep this secret!
  • CHANNELS_ALLOWLIST (required; comma-separated channel names, e.g. #general,#random)
  • OUTPUT_DIR (optional; relative path for site output, default docs)
  • STATE_DIR (optional; relative path for cursor state, default state)
  • LOOKBACK_DAYS (optional; 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.

Slack app setup:

  1. Create a Slack app (from scratch) in the target workspace.
  2. Add a bot user.
  3. Add the required scopes listed below.
  4. Install the app to the workspace.
  5. Copy the Bot User OAuth Token (starts with xoxb-) into SLACK_TOKEN.
  6. Join the bot to all channels in CHANNELS_ALLOWLIST.

Required Slack scopes:

  • channels:read (list public channels)
  • channels:history (read public channel history)
  • users:read (resolve user display names)

Permalinks are resolved via chat.getPermalink. If Slack returns missing_scope, add the scope Slack reports and re-install the app.

GitHub Pages:

  • The docs/ directory is intended for publishing via GitHub Pages.

Instances

If you run this bot and archive data relevant to Fineract, please list your instance here. These also serve as working examples if you're looking for extra help installing the archiver.

  • #fineract unofficial main public chat (PENDING) - source code

History

The original intent of this code was to archive every public Fineract chat message into a public, index-able, simple/static HTML website.

Copyright and License

See LICENSE and NOTICE.