Skip to main content

Search GiselleBot's commands and docs.

Try /ban, or start with / for commands only.

Press Ctrl K anywhere in the dashboard to open this.

Configuring the Administration Module

Note

Originally written by NaviKing, updated to reflect the current slash commands and dashboard pages.

The Administration module is the first one to set up when managing a Discord server. It covers these areas:

  • Activity Logging
  • Greeter
  • Automatic role assignment/removal
  • Self-assignable roles

This guide introduces when and why to use these commands. It does not replace the documentation for each command; for details, see the full Administration documentation page.

Warning

This guide assumes you have the permissions each command needs. The simplest way to make every command work is Administrator on one of your roles and Administrator for the bot on one of its roles, though that grants more access than most servers need. For the permissions each command requires, see the full Administration documentation.

You can start setting up the rest of the modules right away. Unless stated otherwise, this guide assumes you have a dedicated, private channel such as #bot-console for bot commands. Such a channel is optional, but it keeps bot commands out of normal conversation and away from other members.

Server Activity Logging

Server activity logging supplements Discord's server Audit Log and captures activity it does not, such as deleted messages and attachments. Discord's Audit Log also clears out old activity, while messages in a channel remain.

The logging module also lets patrons of the bot developer ignore specific users and channels, so you still control what gets logged. That matters when the people who can read your logs cannot see every channel.

Logging Example

Here is one way to set up the logging for your server.

  1. Create the following channels
    • #log-members
    • #log-users (If you are a patron of the bot developer)
    • #log-messages
    • #log-mod
    • #log-warn
    • #log-roles
    • #log-channels
    • #log-voice (If you are a patron of the bot developer)
    • #log-server (If you are a patron of the bot developer)
  2. Run the following commands in each channel (/log toggle also accepts a channel: option if you'd rather run it from somewhere else)
    • /log toggle type:Members
    • /log toggle type:Users (if you are a patron)
    • /log toggle type:Messages
    • /log toggle type:Moderation
    • /log toggle type:Warning
    • /log toggle type:Roles
    • /log toggle type:Channels
    • /log toggle type:Voice (if you are a patron)
    • /log toggle type:Server (if you are a patron)
  3. If your Discord name is @NaviKing, you are a patron, and you have an #admin-channel that isn't visible to Moderators, you can have the bot ignore you and all the messages in that channel from your server's Logger page on the dashboard.

Note

While the moderation module will log some external moderation actions, it is primarily intended to be used with the warning log in conjunction with the bot's moderation module. This module will be discussed in another guide.

Greeter

When new members join your server, a welcome message can tell them what to do next. The bot has two greeters: one sends a direct message on join, the other posts in a specific channel. Some administrators use slightly different messages in each; others use only one. The channel greeter can also delete its own message after a set time.

Greeter Example

Note

All greet/goodbye configuration is done from your server's Welcome and Goodbye page on the dashboard.

You could set up a greeter as follows

  1. Create a #greeter channel
  2. On the Welcome and Goodbye dashboard page, enable the channel greeter and set its channel to #greeter
  3. Set the greeter message to "Welcome to the server, %user%!"
  4. Set the auto-delete delay to 60 seconds
  5. If @NaviKing joins your server, the bot will send the message "Welcome to the server, @NaviKing!" in the #greeter channel, and then delete it after 60 seconds.

The same dashboard page also lets you enable a DM greeter with its own message, alongside or instead of the channel one. A DM greeter is never auto-deleted. Some users disable direct messages, so the DM may not arrive.

If you enable a greeter but leave its message empty, nothing is sent when users join the server.

Automated Role Assignment/Removal

Granting a role on join is useful for several things: barring new users from certain channels, giving everyone a color other than the Discord default, or marking people as new. Many bots do this. This one can also remove one or more roles after a set time.

The bot also allows you to specify a role that users receive when they join a voice channel. This is often used to allow users access to a corresponding text channel.

Note

All roles used in commands should exist prior to running the command. The bot will not create roles that don't already exist.

Role Assignment/Removal Example

Note

Automatic role assignment/removal and voice-channel roles are configured from the dashboard rather than typed as commands.

  1. If you want to give a Newcomer role to members that join the server, enable automatic role assignment on your server's Settings page and set it to Newcomer
  2. You can then have the bot remove this role after 3 days by setting an automatic role removal entry for Newcomer with a 3-day delay, on the same Settings page
  3. On the Self-Assignable Roles / Voice Roles page, set the General voice channel's associated role to "General Voice"
    • This will give the General Voice role to users that join the General voice channel.

You can undo any of these at any time from the same dashboard pages - disable the toggle, or clear the role/channel field.

Note

The time code format (mo/w/d/h/m for months/weeks/days/hours/minutes) is still used by several slash commands' duration options (for example /mute and /ban). For example, 1d3h2m means 1 day, 3 hours, and 2 minutes. More info is available in the Time Format Code section of the Docs 101 page.

Self-Assignable Roles

See also

Different use cases of the same topic are described in the Reaction Roles and Self Assignable Roles guide.

Self-assignable roles are one of the most involved modules in the bot: users assign roles to themselves through it. Read the full documentation on self-assignable roles before you build a setup; this section covers only the basics.

Self-assignable roles serve several purposes.

  • Some users want to opt in or out of specific channels. Granting or excluding roles through channel permissions gives them control over what they see.
  • Others want a different Discord name color. A set of colored roles lets them pick one.
  • A taggable @Helper role that is self-assignable lets people volunteer to be pinged for help.
  • For announcements, a taggable @Server Updates role replaces @everyone: members opt in and only they get pinged when there is news about the server.

Setting up Self-Assignable Roles - Basics

Note

Adding and removing roles from a self-assignable Role Group is done from your server's Self-Assignable Roles / Voice Roles page on the dashboard.

In this bot, you add any number of roles to a group of self-assignable roles from that dashboard page - for example, adding Role1, Role 2, Role 3 and Role4 to group 1.

You can still list all the self-assignable roles on the server with /selfroles list. It will display them by group.

Advanced per-group options (mode, required roles, auto-removal, and more) are configured on the same Self-Assignable Roles dashboard page.

Using Self-Assignable Roles

Users can then assign themselves these roles using a role menu (explained later) or via /role get, and remove these roles via /role drop. For example

/role get role:Role1

will add Role1 to the user that runs the command and

/role drop role:Role1

will remove the role

Role Menus

Some users find /role get and /role drop awkward because the role name has to be typed exactly. Role menus are easier: members assign and remove roles from a single group by clicking a button on a message. Continuing the previous example, you can use the following command to create a role menu for group 1

/rolemenu create group:1

The bot will create a message to use as the role menu with one button for each role, using the name of the role as text of the button.

You may also want to add roles to a role group later. In that case, run the following command to have the bot refresh the buttons for the roles in the most recent role group in the channel, or specify a valid message ID to update the role menu on that channel

/rolemenu update

To remove a role menu, use the following command on the most recent role menu in the channel, or specify a valid message ID to remove the role menu from that message. The buttons stay on the message but stop working as a role menu

/rolemenu remove

Refer to the Reaction Roles and Self Assignable Roles guide for more information about this specific use case.

Summary

The Administration module covers logging, greet messages, automatic role assignment and removal, and self-assignable roles. Each one is configured from the dashboard pages linked above, and each has its own reference page for the full set of options.