Language: English | 中文
This directory contains user-facing, administrator-facing, and operations-facing documentation. Start here if you are new to Cheers. For architecture background, use Documentation Index and the docs/arch/ documents; when they conflict, help docs, README, and current code are authoritative.
| Reader | Start Here | Covers |
|---|---|---|
| Anyone deploying | Deployment Guide | The three methods — from source, Docker Compose, Helm/Kubernetes — and when to use each |
| First-time deployer (Compose) | Docker Compose Deployment Guide | Single-host Compose stack: JWT keys, .env, core stack, OpenCode bot, TLS, ops |
| First-time deployer (legacy) | Installation Guide | Older combined install notes (predates the Rust gateway; being revised) |
| Daily user | User Guide | Entering channels, sending messages, mentioning Bots, uploading files |
| Frontend operator | Frontend Operation Manual | Main UI entry points, controls, and common operations |
| UI reviewer | Interface Interaction Guide | Layout, interaction rules, and usage recommendations |
| System administrator | Admin Guide | Workspaces, channels, members, Bots, Agent Bridge |
| Prompt operator | Prompt Template Operations Guide | Prompt template variables, runtime priority, Bot binding, overrides, and troubleshooting |
| Agent provider author | Agent Bridge Integration Guide | Registering Agent Bridge Bots and connecting local ACP-capable agents; OpenClaw links are legacy/deprecated |
| Local ACP agent (developer) | Local Bot Setup Guide | Host daemon: one TOML per bot, sidecar-file tokens, multi-bot management, full field reference, troubleshooting |
| Anyone asking "what is a Bot?" | MCP Cheers: Bots vs. Users | The MCP tool surface, the bot auth chain, and how a Bot is the same as / different from a regular user |
| Object storage operator | RustFS Object Storage Guide | S3-compatible storage, bucket, and key setup |
| Troubleshooter | Troubleshooting Q&A | Health checks, logs, database, Bot no-response, preview failures |
- Frontend:
http://localhost - Backend API:
http://localhost:8000 - Main database and Context Store: PostgreSQL
- Redis, RustFS, and Gotenberg (office→PDF preview) are started by Docker Compose
- For public deployment, use
docker-compose.production.tls.yml(Caddy + HTTPS + strictCORS_ALLOWED_ORIGINS) withAPP_DOMAINandTLS_*configured in.env. - No built-in assistant: Cheers is external-agent-first — connect an ACP agent (OpenCode, Claude, Codex) and
@-mention it in a channel. - Chinese versions are available next to each document as
*.zh-CN.md