# Adding Bouncer Bot in your guild

{% hint style="info" %}
**Good to know:** Bouncer is a Premium Only bot. We believe the work we do is worth our price. If you want Bouncer in your server go to <https://bouncerbot.net>.

We offer a 31 day free trial for you to try our bot.
{% endhint %}

## Getting Premium

Our Bot requires a Premium subscription to work. You can see the details in here:  <https://bouncerbot.net>, we offer a free trial to let you test our bot before committing. In this part of the guide we will show you how to get Premium, and how to add the bot to your server.

### Checkout Experience

In that page you will be shown this:<br>

<figure><img src="/files/Yah1t6z279NcxOCJZnLJ" alt=""><figcaption></figcaption></figure>

#### How to get Premium

1. Click "Login With Discord To Buy" in order to login with Discord. This will only log you in. It won't charge you in any way.
2. Once you do, you will be redirected back into our website: <https://bouncerbot.net>, you will see now our Price table:<br>

   <figure><img src="/files/gBfnAcJ3ioITJYRJvn6o" alt=""><figcaption></figcaption></figure>
3. Click "Start Free Trial", you will be redirected to Stripe's Portal where you can subscribe for a free trial, Stripe will offer you either a price in Euros or Dollars depending on where you live. Both are about the same (it can vary a bit depending on exchange rate), we simply provide it in your currency as a convenience to you.<br>

   <figure><img src="/files/QZ35yibkeFnr3WfUiWhs" alt=""><figcaption></figcaption></figure>
4. In this page enter your payment information, and your billing information and click "Start Trial". You will not be charged until the end of the trial.
5. Once you start your trial a message like this will appear:

   <figure><img src="/files/WUSbU01BtQKzlEEOOe2B" alt=""><figcaption></figcaption></figure>

### Adding the bot to your Server

1. Click on the link back to our website and you should now see this:<br>

   <figure><img src="/files/R7ldDXKMVi5lhkWV8xdx" alt=""><figcaption></figcaption></figure>
2. You can invite Bouncer now to your Guild by clicking the button on top, or you can manage your subscription by clicking "Manage Your Subscription". For more information on managing your subscription please see our guide [Managing your Bouncer Bot Subscription](/bouncer-bot/guides/managing-your-bouncer-bot-subscription.md)
3. Click the button to invite Bouncer to your Guild:<br>

   <figure><img src="/files/2NTCKkw6xR8WBFZg7BfW" alt=""><figcaption></figcaption></figure>
4. Select your server, and click Continue. <mark style="color:red;">**Do not change the permissions selected for you**</mark>. These are the minimum permissions required for the bot to function properly.\
   ![](/files/eNHBQ86ICfmYqKMrNd7m)
5. Click "Authorize". Now let's do the Server Setup!

## Setting up the Bot

{% hint style="danger" %}
Do not skip this section. The bot will not run if not configured. It will not filter or kick anyone until you set it up.

Some of the commands here must be ran by the owner of the Discord Server.
{% endhint %}

I'll walk you through setting up the bot on your server. If you haven't read [#getting-premium](#getting-premium "mention") I'd suggest you to read it since it is required for the bot to work on your server, and to be able to do some of the commands we will use in this next section.

### Admin Roles

The bot needs to know who are the admins allowed to interact with it. You will need to have an admin role in your server (a role that designates who is an admin and who is not).\
To set this up you'll need to use the following slash command:

{% hint style="warning" %}
Only the owner of the guild can run this command
{% endhint %}

```actionscript
/add_admin_role role: @Admins
```

Once used the bot will reply with:<br>

<figure><img src="/files/yHS6UKTn966jhh11slA6" alt=""><figcaption></figcaption></figure>

This command is ESSENTIAL. It not only sets your admin roles, but it also registers your server with our bot. Without this command we do not save your server guild in our Database.

Once you've setup the admin roles you can set up the other roles used by the bot.

### Verification Role

This role is given to users who are in verification. You should set your Server in such a way that anyone with this role cannot see or do anything in the server except to see the Verification Channel.

To set it up use:\
![](/files/4wxaQQf7l4DFjeHkNIB4)

{% hint style="warning" %}
Only Admins can use this command
{% endhint %}

<pre><code><strong>/add_role role: @Verification role-type: Verification
</strong></code></pre>

Of course you can name the verification role anything you'd like, just make sure to pass that in role argument of the command.

### Verified Role

We use this role to mark who has successfully verified. It is automatically given to any user who rejoins and has verified.

{% hint style="warning" %}
Only Admins can use this command
{% endhint %}

<pre><code><strong>/add_role role: @Verified role-type: IsVerified
</strong></code></pre>

### Moderator Role

You can set up this role in order to use moderation commands built-in with Bouncer.

{% hint style="warning" %}
Only Admins can use this command
{% endhint %}

<pre><code><strong>/add_role role: @Moderator role-type: Moderator
</strong></code></pre>

### Verification Channel

This command must be run to support users who have their DMs closed! It's very important.

Before running this command you should make sure that only people with the Verified role can see this channel.

{% hint style="warning" %}
Only Admins can use this command
{% endhint %}

```
/set_verification_channel verification-channel:#verification
```

### Logging Channel

This channel is used by Bouncer to log what happens with Bouncer. It's a way to audit what happens, who gets verified successfully and who doesn't. Friendly tip: use Yagpdb as well in your server to keep logs of the mods actions. We are not a moderation bot so we can freely recommend a great moderation bot.

```
/set_logs_channel logs-channel:#logs
```

### Help Channel

This channel is used by Bouncer to post help requests from any user who uses our web portal.\
When people verify we offer a very nice contact form for people to use if they need help:<br>

<figure><img src="/files/fS5MT6BCSdSz29to96Iy" alt=""><figcaption></figcaption></figure>

This feature shows the user a chat window. Our service will automatically route the message from the website to your Help Channel in real time. Your mods/admins can then reply to the user by simply sending messages in the thread created.

If you want to avoid sending something, use the prefix `b!` before any message. Bouncer will then ignore the message, and the user will not receive it.<br>

See [Verification Help Commands](/bouncer-bot/extras/commands/verification-help-commands.md) for more information.

In order to set up the channel use:

```
/set_help_channel help-channel:#help
```

### Set Up Premium

#### Premium Slots

When you get Premium, you get a predetermined amount of Premium slots you can use with the bot. It's usually two for now since we have an initial launch sale but this number can change if you buy outside of the sale.

You can see how many premium slots you have available by doing the command:

```
/premium_slots_available 
```

Only you can see the result of this command.

![](/files/wFh954ZY1bjeRIJY5asO)

You must use one of the slots on the server you want to enable Bouncer:

```
/use_premium_slot 
```

Use the command above in the server of your choice to enable Premium in that server.

<figure><img src="/files/G3TBIELQxwLQNYh9ExGN" alt=""><figcaption></figcaption></figure>

## Enable the bot

{% hint style="danger" %}
Bouncer will not work unless you enable the features you want to use!
{% endhint %}

At this point you have done all the required setup. And Bouncer is ready to get to work. It just needs you to enable the features you'd like to use. For more information see [Feature Commands](/bouncer-bot/extras/commands/feature-commands.md)

Use the command to turn on a feature.

```
/toggle_feature feature:{FeautureName} on:True
```

Or this command to turn it off.

```
/toggle_feature feature:{FeautureName} on:False
```

| Valid Feature Names | Use                                                                                                                                                                                                                       |
| :-----------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|      Validation     | Controls the user validation features, that is the captcha validation, and website redirects. If you turn off this feature Bouncer will not kick or filter any user. You've disabled the core of Bouncer's functionality. |
|  ValidationHelpChat | Controls the help chat shown to users in the verification website. If you disable this, users will not be able to send you help requests through the website                                                              |
|  GuildConfiguration | Cannot be disabled. This controls the configuration commands which can never be disabled.                                                                                                                                 |
|  ModerationCommands | Controls the basic moderation commands shipped with Bouncer (see [Moderation Commands](/bouncer-bot/extras/commands/moderation-commands.md))                                                                              |
|     Suggestions     | Controls a future feature we will be adding to Bouncer allowing users to create suggestions in your Discord that users can vote on.                                                                                       |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://stockdrops.gitbook.io/bouncer-bot/guides/adding-bouncer-bot-in-your-guild.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
