HepBoatHepBoatDocs
Documentation menu

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

HepBoat is free to add - use the invite link on the site or the dashboard and pick your server. The invite asks for Administrator. HepBoat moderates, edits channels, manages roles and records voice on request, and a narrower set would mean re-inviting the bot every time a feature needs one more permission. The moment it joins, setup is automatic:

  1. The server gets a starter config with sensible defaults.
  2. The server owner and whoever invited the bot are granted dashboard admin access immediately - no waiting on anyone.
  3. 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.

Premium is optional: it unlocks the full toolkit (leveling pro, music, image scanning, appeals, the API, and more - each locked feature shows a banner in the dashboard saying what it needs) and is sold in prepaid 30-day blocks in the shop. Nothing auto-renews, and another block stacks onto any time left.

Very large servers have one more door. At 75,000 members a gold Prime tab appears in your dashboard: HepBoat Prime is the dedicated deployment we run for the largest communities, bought once and kept for good.

Where to next