Docs / Platform / Setup check

Setup check

Check that the bot can do everything your services are set up to do, on the Bot page or with /yourbot check.

The setup check answers one question for every built-in service that is turned on: can the bot do everything the service is set up to do? It reads each service's settings, then checks the bot's permissions in the channels and categories the service uses and the roles it gives out, pings or reads. Marketplace plugins are not checked. The check only reads, so running it changes nothing.

On the dashboard

Open the dashboard, pick the server, then Bot. On the Setup Check card, click Run the check. Every enabled service gets a line with its result:

  • All good: nothing to fix.
  • Worth a look: warnings only, such as a role the bot cannot ping.
  • Needs a fix: at least one problem stops part of the service from working.
  • Not checked: the service's settings could not be read right now.

Each problem says what is wrong and what stops working because of it. Most come with a Fix it link to the dashboard page where that setting lives.

The card needs access to the Bot page: the owner, or a manager with Read or Full on Bot. See Access levels and staff.

In Discord

Run /yourbot with the check option set to Check my setup. Only you see the answer.

Members with Manage Server or Administrator can run it, and so can the server's dashboard owner and managers. Anyone else gets "Only server admins can run the setup check. Ask someone with Manage Server to run /yourbot check."

The answer is an embed titled "Setup check". It starts with a summary such as "Found N things to fix." or "Everything looks good. The bot can do what every service here is set up to do." Each service with problems gets a field that lists them, most with a Fix it link that opens the right dashboard page for this server. An All clear field lists the services without problems. When everything does not fit in one message, the answer says how many more services need attention and points to the Bot page, which always shows everything.

In Discord the check also covers the channel you ran it in (for a thread, its parent channel): can the bot see it, post there with embeds and read its history. A problem there is listed under This channel.

The Check my setup button

When services are on, the /yourbot status reply carries a 🩺 Check my setup button if the member who ran /yourbot has Manage Server or Administrator. That reply can be public, so anyone may click the button. The click runs the same private check for whoever clicked, with the same rule about who gets the report. See Bot commands.

What it looks for

  • Missing permissions, server-wide or in one channel or category. Channel overwrites count, so a channel hidden from the bot shows up as missing View Channel.
  • A channel or role that was deleted.
  • A channel of the wrong kind, such as a text channel picked where a category is needed.
  • A role the bot gives out that sits above the bot's highest role, belongs to an integration (a bot, boosting or a subscription), is @everyone or has permissions too powerful to give out automatically.
  • A role the bot pings that is not mentionable while the bot lacks Mention @everyone, @here and All Roles. This one is only a warning: the message still posts, but the ping is silent.
  • Manage Roles, once per service, when the service gives out roles and the bot does not have it.

When the bot has Administrator, channel settings cannot block it and the summary says so. The role order still matters.

Good to know

  • The dashboard and Discord run the same check against the bot that serves your server: the shared bot, or your custom bot when the server has one.
  • The check itself needs no subscription.
  • A Check my setup button from before the server moved to its own custom bot answers "This server uses a custom bot now. Run /yourbot check with that bot instead."
YourBot docs Reference tables are generated from the code that is running. Ask in Discord Suggest a correction