Docs/Getting Started/Getting Started
Getting Started
What HepBoat is, how it gets into your server, and where everything lives.
HepBoat is a heavy-duty moderation bot for Discord, paired with a full web dashboard. Every part of a server's behaviour lives in one YAML config document you can read at a glance, and everything the dashboard does is an edit to that document - with history, restore, and live reload built in.
The three pieces
- The bot - moderation commands, filters, logging, leveling, and more,
organised into plugins. Commands work as classic prefix commands (
!ban) and as slash commands you opt into per server. - The dashboard - configure every plugin with guided forms or edit the raw YAML directly, browse infractions and mod logs, manage custom commands, and see server stats. Every save is validated before it applies.
- The docs - you are here. Each plugin has its own page with its commands and configuration.
Getting HepBoat into your server
Access is a monthly subscription per server, handled in the shop on the dashboard: sign in with Discord, invite the bot, and subscribe. Once the bot joins an activated server, setup is automatic:
- The server gets a starter config with sensible defaults.
- The server owner and whoever invited the bot are granted dashboard admin access immediately - no waiting on anyone.
- The owner receives a DM with links to the dashboard and these docs.
From there, open the dashboard, pick your server, and work through the setup guide.
Where to next
- What is HepBoat? - the longer tour.
- Setting up HepBoat - first-day configuration: access, mod roles, logging, filters.
- Plugins overview - every plugin at a glance.
- Moderator quick reference - the commands your mods will actually use day to day.