Explore thepopebot documentation
mainThe project includes comprehensive documentation for various aspects of the system. Key areas include:
Core System
- Architecture: Details the two-layer design, file structure, API endpoints, GitHub Actions, and the Docker agent.
- CLI Reference: Documentation for
init, managed vs user files, template conventions, and all CLI commands. - Configuration: Covers the Admin UI, DB-backed configuration, infrastructure variables, and Docker Compose.
- Security: Important security disclaimers and risks associated with local development.
Features & Customization
- Customization: How to modify personality, skills, and operating system files.
- Chat Integrations: Instructions for Web chat, Telegram, and adding new channels.
- Different Models: Information on the 10 built-in LLM providers, the helper LLM vs coding agent split, and per-job overrides.
- Coding Agents: Details on the 6 coding agent backends, OAuth tokens, LiteLLM proxy, and per-agent configuration.
- How to Build Skills: A guide to building and activating agent skills.
- Code Workspaces: Information on interactive Docker containers with in-browser terminals.
- Clusters: Explains agent clusters (groups of Docker containers spawned from role definitions).
- Auto-Merge: Controls for auto-merging and
ALLOWED_PATHSconfiguration.
Operations & Deployment
- Deployment: Setup guides for VPS, Docker Compose, and HTTPS with Let's Encrypt.
- Upgrading: Information on automated upgrades and recovering from failed upgrades.
- Pre-Release: How to install beta or alpha builds.
- Mobile Testing: Testing the system on mobile devices.
- Hacks: Tips, tricks, and workarounds.