SyncBot is a Slack app for syncing messages across workspaces. Once configured, this app will sync messages, threads, edits, deletes, reactions, images, videos, and GIFs to every channel in a SyncBot group.
Using SyncBot in Slack? See the User Guide.
Do this before you deploy or run locally:
- api.slack.com/apps → Create New App → From an app manifest → paste
slack-manifest.json. - Upload
assets/icon.pngunder Basic Information → Display Information. - Copy Signing Secret, Client ID, and Client Secret (needed for deploy). For local dev, install the app under OAuth & Permissions and copy the Bot User OAuth Token (
xoxb-...).
From the repo root, run the deploy script once for test and once for prod to automatically deploy to your infrastructure provider (currently AWS and GCP are supported).
| OS | Command |
|---|---|
| macOS / Linux | ./deploy.sh |
| Windows (PowerShell) | .\deploy.ps1 |
You can also fork the repo, set GitHub variables/secrets, and push to test or prod to trigger CI — see DEPLOYMENT.md.
In order for the deploy script to work, you need Git and Bash (on Windows, use Git for Windows / Git Bash or WSL).
AWS: AWS CLI v2, SAM CLI, Docker (for sam build --use-container), Python 3, and curl. Optional: gh for GitHub Actions setup.
GCP: Terraform, gcloud, Python 3, and curl. Optional: gh.
Full prerequisite checks, manual sam / Terraform, Slack URLs after deploy, and CI variables: docs/DEPLOYMENT.md.
See docs/DEVELOPMENT.md for Dev Container, Docker Compose, native Python, project layout, and refreshing syncbot/requirements.txt after dependency changes.
| Doc | Contents |
|---|---|
| USER_GUIDE.md | End-user features (Home tab, syncs, groups) |
| DEPLOYMENT.md | Guided + manual AWS/GCP deploy, CI, GitHub |
| DEVELOPMENT.md | Local dev, branching for forks, dependencies |
| INFRA_CONTRACT.md | Environment variables and platform expectations |
| ARCHITECTURE.md | Sync flow, AWS reference architecture |
| BACKUP_AND_MIGRATION.md | Backup/restore and federation migration |
| API_REFERENCE.md | HTTP routes and Slack events |
| CHANGELOG.md | Release history |
| CONTRIBUTING.md | How to contribute |
AGPL-3.0 — see LICENSE.