docs: add deployment guide for Robrix + Palpo + Octos#40
Open
TigerInYourDream wants to merge 6 commits intomainfrom
Open
docs: add deployment guide for Robrix + Palpo + Octos#40TigerInYourDream wants to merge 6 commits intomainfrom
TigerInYourDream wants to merge 6 commits intomainfrom
Conversation
Add a comprehensive, self-contained deployment guide (English + Chinese) with ready-to-run Docker Compose example configs. Users can go from zero to a working Robrix → Palpo → Octos → LLM setup in 5 steps. Includes: - Step-by-step quick start with setup.sh for repo cloning - Full configuration reference (palpo.toml, appservice registration, botfather.json, compose.yml) with field-level explanations - Robrix client usage guide (registration, bot interaction, bot management) - End-to-end verification checklist and troubleshooting tables - Example configs that work out of the box (only API key needed) - Registration screenshot - README link to the deployment guide
Restructure the monolithic deployment guide into a clear documentation hierarchy with two categories and descriptive filenames: - robrix/ — standalone Robrix getting-started guide - robrix-with-palpo-and-octos/ — integrated system docs: 01-deploying-palpo-and-octos (deployment) 02-how-robrix-palpo-octos-work-together (architecture/App Service) 03-using-robrix-with-palpo-and-octos (usage with screenshots) 04-federation-with-palpo (federation deployment and usage) Move deployment configs from docs/examples/ to palpo-and-octos-deploy/ at the project root, separating runnable files from documentation. Each document now has a clear goal statement at the top. Bilingual (EN/ZH) versions maintained for all files.
… visibility Add Section 7 to usage guides (EN/ZH) covering: - BotFather slash commands (/createbot, /deletebot, /listbots, /bothelp) - BotFather vs child bot comparison table - Public/private bot visibility model with examples - Owner-based delete permissions and operator override Based on octos-org/octos#69 (owner & visibility model).
- Add login screen and registration screenshots (compressed via pngquant) - Add bot naming explanation in usage guide Section 5.2 - Extract Palpo Dockerfile from compose.yml inline to standalone file - Update compose.yml to reference palpo.Dockerfile
- Add compressed search-invite-bot.png showing the search → People workflow - Update Section 5.2 (EN/ZH) with step-by-step bot search instructions - Fix image tags to use <img width="600"> for consistent display - Add "Download pre-built release" section to Chinese getting-started
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a one-stop deployment guide that walks users through setting up the complete Robrix + Palpo + Octos AI chat system.
docs/deployment-guide.md) + Chinese (docs/deployment-guide-zh.md)docs/examples/— user only needs to set one API keyWhat's included
docs/deployment-guide.mddocs/deployment-guide-zh.mddocs/examples/compose.ymldocs/examples/palpo.tomldocs/examples/appservices/octos-registration.yamldocs/examples/config/botfather.jsondocs/examples/config/octos.jsondocs/examples/setup.shdocs/examples/.env.exampledocs/images/register-account.pngREADME.mdKey design decisions
server_name = "127.0.0.1:8128"— works with matrix-rust-sdk'sserver_name_or_homeserver_url()discoverycreated_at/updated_atin botfather.json — required by Octos profile loader (missing = bot silently skipped)Test plan
rm -rf data/→./setup.sh→docker compose up -d→ all 3 services healthyhttp://127.0.0.1:8128succeeds