Getting started

From adding Iridex to a working server takes about five minutes. Everything is set up from the dashboard, so there is no wall of commands to learn first.

1. Add Iridex to your server

Use the invite button on the homepage. You need the Manage Server permission on the server you are adding it to. Leave the permissions Discord suggests ticked: the bot needs them to post messages, manage roles and moderate members. See Permissions for what each one is used for.

2. Open the dashboard

Log in at dash.iridex.me with Discord and pick your server. Only the owner, Administrators and people you grant access to can manage a server. If your server is missing, check that Iridex is actually in it and that you have Manage Server.

3. Turn on the basics

• Welcome and Leave messages: choose a channel, write the message, and preview exactly how it will look.
• Autorole: give new members a role automatically.
• Moderation: enable it and pick a mod log channel so every warning, timeout, kick and ban is recorded.
• Tickets: add a panel and post it to a channel. See the Tickets guide.

Each module has its own tab. Nothing changes until you save, and an unsaved-changes bar keeps you from leaving by accident.

4. Protect the server

Turn on Auto Moderation for spam, mention floods and invite links, Anti-Scam for scam links and lookalike domains, and the Word Filter for slurs and profanity. All of them let you exempt roles and channels. The Moderation guide explains each one.

5. Make it yours

Every message Iridex sends can be edited from the dashboard: text, colours, button labels and button colours, with a live preview that looks like the real Discord message. Start from a ready-made template on any tab and change what you like.

Something not working?

• Check Iridex's role sits above any role it needs to give out, and that it can see and send in the channel.
• Look at status.iridex.me to see if there is a known incident.
• Read the FAQ, or ask in the support server.

A good first hour

If you only have a little time, do these in order. Each one takes a minute or two and makes the biggest difference to how the server feels.

1. Set the server's timezone so scheduled messages and time-based features fire when you expect.
2. Turn on Moderation and pick a log channel that only your staff can see.
3. Write a Welcome message that tells people where to read the rules and where to introduce themselves.
4. Add an Autorole such as Member, so new people can see the right channels straight away.
5. Switch on Auto Moderation and Anti-Scam with the default settings, and exempt your staff roles.
6. Post a ticket panel in a help channel.

Give the right people access

The server owner and anyone with Administrator can use the dashboard. To let a trusted moderator change settings without giving them Administrator, add them on the Staff Access tab, or run /dashboardaccess. They can then edit Iridex's settings but nothing else in Discord. Remove them again from the same place whenever you like.

Roles and the role order

Discord only lets a bot manage roles that sit below its own role. If Autorole, reaction roles, temporary roles or the shop cannot give a role, open Server Settings, Roles and drag the Iridex role above the role in question. Keep it below your admin and owner roles, so the bot never outranks your staff.

Giving a role to everyone

/role all gives a role to every member, and /role tempall gives it for a set time (for example 2h or 1d) and then takes it back. Iridex shows how many members will be changed and waits for you to confirm. Members who already have the role are left alone, and bots are skipped unless you ask for them. Discord limits how fast roles can be changed, so a large server takes a while; you can press Stop at any time. A role with moderation or management permissions can only be given to everyone by a server Administrator.

Choosing channels

Most modules ask for a channel. A few habits keep things tidy: send logs to a private staff channel, welcome messages to the channel new members land in, and giveaways or polls to a channel that everyone can read. Iridex needs to see the channel and be allowed to send messages and embed links there, so check the channel's permissions if a message does not appear.

Common mistakes

• Forgetting to save. Changes on a tab only apply after you press Save. The unsaved-changes bar reminds you.
• A module is off. Its commands are hidden and its features do nothing until you switch it on.
• The bot lacks a permission. Compare your server against the list on the Permissions page.
• The role is too high. See "Roles and the role order" above.
• Testing as the owner. The owner is exempt from many checks. Test with a second account or a friend.

Keeping up with updates

New modules and improvements ship regularly. The Updates page lists every release, and you can follow updates straight into a channel in your server with the Iridex Updates module, so your team sees changes as they happen.