Skip to content
github-actions[bot] edited this page May 9, 2026 · 4 revisions

squawk

A Bun-based Discord bot that monitors public status pages — Statuspage.io and incident.io are supported — and posts incident updates to Discord as threaded conversations.

What It Does

  • Polls one or more public status pages on a configurable interval (auto-detects provider)
  • Creates Discord threads for each incident, posting updates as they arrive
  • Pins active incidents and unpins them when resolved
  • Ghosts incidents that vanish from the API (strikethrough + grey)
  • Tracks open incidents server-side for reliable ghost detection
  • Provides slash commands for status checks, replays, cleanup, and runtime monitor management

Wiki Pages

Page Description
Architecture System design, data flow, and module structure
Configuration Environment variables, multi-monitor setup, feature flags
Commands All slash commands with usage and permissions
Incident Lifecycle How incidents are tracked from creation to resolution or deletion
State Management Persistence format, migration, and locking
API Integration Supported providers, endpoints, and how to add a new provider
Deployment Docker, Docker Compose, CI/CD, and production notes
Development Local setup, tooling, and contribution guide
Contributing How to contribute, code conventions, and documentation rules

Quick Start

cp .env.example .env    # Fill in DISCORD_TOKEN, DISCORD_APPLICATION_ID, etc.
bun install
bun dev                 # Watch mode

Or with Docker:

docker compose up -d

See Configuration and Deployment for details.

Clone this wiki locally