> ## Documentation Index
> Fetch the complete documentation index at: https://heimdall.gg/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Adding Heimdall to Your Server

> How to invite Heimdall, grant it the permissions it needs, and complete first-run setup.

## Prerequisites

You need the **Manage Server** permission in the Discord server you want to add Heimdall to.

## Inviting the bot

Visit **[bot.bifrost.gg](https://bot.bifrost.gg)** and click **Add to Server**. This is the Bifröst-hosted version of Heimdall - no self-hosting required. The invite link requests the exact permission set the bot needs. Discord will ask you to select a server from the list of servers you manage, then confirm the requested permissions.

> [!NOTE]
>
> If you are evaluating Heimdall before adding it, review the available plans at **[bifrost.gg/heimdall/pricing](https://bifrost.gg/heimdall/pricing)**. Some features are available on all plans; others require a paid tier.

> [!NOTE]
>
> You can remove permissions from Heimdall after it has joined - Discord allows this through **Server Settings > Roles** or channel-level permission overwrites. However, any feature that requires a permission you have revoked will stop working. When a member attempts to use an affected feature, Heimdall will respond with an error message that identifies exactly which Discord permission is missing, rather than failing silently. This makes it straightforward to diagnose and fix permission gaps if something stops working.

## Required permissions

The following Discord permissions are required for Heimdall to function correctly across all plugins:

| Permission | Why it's needed |
| - | - |
| Manage Roles | Assigning roles via role buttons and syncing Minecraft roles |
| Manage Channels | Creating and deleting temporary voice channels |
| Kick Members | Executing kick actions from moderation commands |
| Ban Members | Executing ban actions and managing leave-bans |
| Manage Messages | Deleting messages during purge operations and sticky message management |
| Read Message History | Purging messages by count and reading context for modmail |
| Send Messages | Responding to commands and sending notifications |
| Embed Links | Sending rich embeds for all formatted output |
| Attach Files | Sending attachments in ticket and modmail threads |
| Use Slash Commands | Registering and responding to slash commands |
| Manage Threads | Creating and archiving ticket and modmail threads |
| Moderate Members | Applying timeouts for mute actions |

## What happens when the bot joins

When Heimdall joins your server for the first time, it registers all slash commands with Discord and creates a server configuration entry in its database. No channels or roles are created automatically - everything is configured through the dashboard.

## Next steps

**1. Log in to the dashboard**

Visit **[bot.bifrost.gg](https://bot.bifrost.gg)** and sign in with your Discord account. Your server will appear in the guild selector. See [Using the Dashboard](https://heimdall.gg/docs/dashboard.md) for a walkthrough.

**2. Configure permissions**

By default, all moderation commands are restricted to members with the Administrator permission. Set up the permission system to give the right roles access to each feature. See [Permissions](https://heimdall.gg/docs/permissions.md).

**3. Enable and configure plugins**

Each feature needs to be configured before it becomes active. Use the dashboard sidebar to navigate to each plugin's configuration page and set it up.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.