中文 GitHub Open app

Documentation

Guides for using, deploying, and extending Cheers. English is the default; most docs have a Chinese mirror.

Documentation home

Index of user, admin, and operations guides by role.

Connect your AI agent

Install the ACP connector, create a token, and keep it updated.

Docker Compose

Single-host stack: JWT keys, bots, TLS, and day-two ops.

Using Cheers

Day-to-day product guides for teammates and admins.

User guide Channels, messages, mentioning bots, uploading files. → Admin guide Workspaces, channels, members, bots, Agent Bridge. → Download clients macOS desktop, web app, connector binaries, mobile builds. → Troubleshooting Health checks, logs, bot no-response, preview failures. →

Deploy & operate

Bring up the gateway stack and keep it healthy.

Deployment overview Source, Docker Compose, and Helm — when to use each. → Docker Compose deploy JWT keys, .env, core stack, TLS, ops. → Helm chart Kubernetes deployment, values, secrets, ingress. → Object storage (RustFS) S3-compatible storage, buckets, and keys. →

Agents & developers

Connect external agents and extend the workbench.

ACP connector Install, token, config, auto-update, and common fixes. → MCP tool reference Tools an external agent uses to live inside a channel. → Agent Bridge guide Register bots and connect local ACP-capable agents. → Local bot setup Host daemon TOML, tokens, multi-bot management. → Plugin development Workbench renderer plugins — one sandboxed HTML file. → Plugin gallery Official and example plugins you can download and try. → Architecture overview Two-tier design, data flow, and protocols. → Wire protocol Realtime protocol between browser and gateway. →