Docs: hosted-instance usage (bot invite links) + step-by-step Discord bot registration guide for self-hosting (with screenshots) #58
Labels
No labels
bug
duplicate
enhancement
help wanted
invalid
question
wontfix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
dark/nether-voicebridge#58
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
The current README covers self-hosting requirements tersely (Requirements / Quickstart / Configuration notes), but two documentation gaps keep coming up:
1. Hosted-instance usage docs (once the hosted instance is set up)
For people who just want to bridge their Discord server / Matrix room using our hosted instance rather than self-hosting:
org.matrix.msc3401.call.memberPL 0 room requirement — including the gotcha that Element's "Join Element calls: Default" label is unreliable and the rawm.room.power_levelsmust be checked.Blocked on the hosted instance actually existing (groundwork: #43 feasibility analysis, #45 tenants, #46 per-(bot,guild) allocation) — but the doc structure can be drafted now with placeholders for the invite URLs.
2. Self-hosting: detailed Discord bot registration guide (with screenshots)
Registering the puppet-pool bot applications is the most confusing part of self-hosting and the README currently compresses it to one bullet. We need a dedicated walkthrough (e.g.
docs/discord-bot-setup.md, screenshots underdocs/images/) covering, for each puppet bot:botscope + the exact permission set (Connect, Speak, Use Voice Activity, Change Nickname), with a screenshot of the URL generator and a ready-made URL template (just substitute the client id).config.toml[puppets](and the env-var alternative for Docker/systemd deployments).While we're in there, consider consolidating the Matrix-side setup (appservice registration,
sender_localpartnamespace stem, room PL requirement) into a parallel self-hosting walkthrough so the README can link out to both instead of carrying all the detail inline.Acceptance
Docs shipped to master (
5b4ee91):docs/hosted-instance.md— the "use the hosted instance" page: what it is, cost (free), data flow (links the privacy policy), Matrix-side steps (invite for restricted rooms; the PL-0org.matrix.msc3401.call.memberrequirement with the Element "Default"-label gotcha spelled out), and how to request a bridge in #nether-voicebridge:nether.im.docs/discord-bot-setup.md— the self-hosting puppet-bot walkthrough: portal app creation, Bot tab / token / intents (GUILDS | GUILD_VOICE_STATESonly), the OAuth2 invite URL (ready-made template, permission integer103809024), per-guild invites with the per-(bot,guild) allocation explainer, avatar/nickname guidance, the deliberate-creation warning, and wiring tokens into[puppets].Left open — two items need a human/the live instance:
hosted-instance.mdhas<!-- TODO(operator) -->placeholders; the real per-bot OAuth2 URLs can only be filled once the hosted pool's applications exist. Blocked on the hosted instance going public.discord-bot-setup.mdreferences 7docs/images/discord-setup-*.pngshots, listed in an HTML comment at the bottom of the file, still to be captured from the Developer Portal.Keeping this open to track those two follow-ups.