Whitelist

Keep your server to chosen players with five modes: Whitelist IDs, requests, an application form, Discord checks and txAdmin's allowlist.

The whitelist keeps your server to the players you choose. MonoAdmin checks it when someone connects, right after the ban check, and a player who does not pass is turned away with a message that says why and what to do next. You pick one of five modes, from staff only to a list of approved players that you build from requests, an application form or by hand. Your staff always get in, once they have linked their game account.

This page covers how the check works, each mode, how staff are recognised, how to turn the whitelist on, what players see, the approved list, the Discord modes, how to use it next to txAdmin’s own allowlist, and what to do when something goes wrong.

How It Works

When a player connects, your server asks MonoAdmin about them in this order:

  1. Bans. This is the check described in How Bans Are Enforced, unchanged. A banned player is refused with the ban message whatever the whitelist says, staff included.
  2. The whitelist. It runs only for a player who is not banned, and only when the whitelist is on. Staff are let in. For everyone else, the mode decides.

A few things are worth knowing before you start:

  • The mode is the switch. The whitelist is not a module under Settings > Features. It is on whenever the mode is anything but Off, so there is no second switch to forget.
  • It is checked when a player joins, and only then. Players who are already on the server stay when you turn the whitelist on or make it stricter. Use a kick if you need someone out now.
  • The server waits longer. With the whitelist on, a connecting player sees “Checking the whitelist…” and your server waits up to 6 seconds for MonoAdmin’s answer, instead of the 1.5 seconds it waits for the ban check alone.
  • The resource has to be up to date. A resource that is too old to check the whitelist is never sent a whitelist refusal, so it lets in everyone who is not banned. When your server is in that state, the panel warns you on the Whitelist page, on the dashboard and in the turn-on dialog. Update the resource as described in Update or Remove the Resource.

The Five Modes

You choose the mode under Settings > Whitelist. One mode is in force at a time.

Mode Who gets in
Off Anyone who is not banned. This is where every project starts.
Admin Only Staff only. Use it for maintenance.
Discord Server Member Staff, and members of your connected Discord server.
Discord Roles Staff, and members of your Discord server who hold at least one of the roles you choose.
Approved List Staff, and the players on your approved list. Anyone else is refused with a Whitelist ID they can use to ask for a place.

Changing the mode never deletes anything. Requests, applications and the approved list are kept in every mode, but only Approved List looks at them. When it is not the current mode, the Whitelist page says its lists are not checked.

Staff Always Get In

In every mode, staff get in. Staff means the owner and every member of the project, whatever their role, as long as their account is not disabled.

MonoAdmin recognises a staff member the way the in-game menu does: by a game account they verified themselves with /madmin link. When someone connects, MonoAdmin compares the identifiers FiveM reports (Rockstar license, Rockstar license 2 and Cfx.re account) with the verified ones on the members’ accounts. Steam, Discord and the other kinds never recognise anyone. Turn On and Open the Menu lists which identifier kinds count.

A staff member who has not linked a game account is not recognised, and is treated like any other player. Under Admin Only that means they are kept out. To link one:

  1. Join your server on the game account you play on.
  2. In the panel, open Settings > My Membership and press Link Game Account.
  3. Type /madmin link and the code in the game chat.

Linking needs the In-Game Menu switched on, because game accounts cannot be linked while it is off. The steps and the messages you may see are in Turn On and Open the Menu.

Turning It On

You need the Whitelist Settings permission.

  1. Open Settings > Whitelist.
  2. Choose a mode. A dialog opens.
  3. For Discord Server Member and Discord Roles, your Discord server must be connected and the Discord module must be on. If not, those modes are greyed out with the reason and a link to Settings > Discord. For Discord Roles, choose at least one role in the role picker. The roles are saved with the mode.
  4. If txAdmin’s own allowlist might be on, the dialog starts with a step about txAdmin. See Using It With txAdmin.
  5. Read the consequences, then confirm.

The dialog always says two things: “Players already on the server stay. The whitelist is checked when someone joins.” and “While your server can’t reach MonoAdmin, players are kept out.” It also warns you when staff have not linked a game account, and when your resource is too old to enforce the whitelist.

The change reaches a connected server at once. A server that is offline learns it when it reconnects.

To turn the whitelist off, choose Off. The dialog says “Anyone who isn’t banned can join again. Requests, applications and the approved list are kept.”

Players Already Online Stay

The check runs when a player connects. Turning the whitelist on, changing the mode, or removing someone from the approved list does not remove anyone who is already playing.

When MonoAdmin Cannot Be Reached

The player sees “This server can’t check its whitelist right now. Please try again in a minute.” That happens when the link to MonoAdmin is down, when MonoAdmin does not answer within the wait, and, in the Discord modes, when Discord cannot be asked. A change you make in the panel reaches a server only once it is connected again, so restoring the link comes first. See Troubleshooting.

What Players See

A player who is kept out reads a message in the window FiveM shows when it turns them away, or a card with your logo and links when you choose one. By default it is plain text, written by the MonoAdmin resource on your server, followed by the Refusal Message you set under Settings > Whitelist (up to 500 characters, with a preview of what the player sees). Staff reasons, the owner’s message and the Discord server’s name are cleaned before they are shown: control characters and angle brackets are removed.

Here is the screen for a player who is not on the approved list, when the application form is on:

You are not on this server's whitelist.
Your Whitelist ID: R7KQM
Apply here: https://app.monoadmin.net/apply/Xk3p9QwR2tLm?id=R7KQM&k=Q2mT8vLpX4nZb7Rw9KcYhE
Situation What the player reads
Approved List, not on the list “You are not on this server’s whitelist.” and “Your Whitelist ID: R7KQM”. Then “Apply here:” and the link when the application form is on, or “Give this ID to the server’s staff.” when it is off.
Approved List, application waiting “Your application is waiting for staff to review it.” and their Whitelist ID.
Approved List, request denied or application rejected, and the wait is not over “Your whitelist request was not accepted.” and their Whitelist ID, then “Reason:” with what staff wrote, if they wrote anything, and “You can apply again after” a date in your project’s time zone. The date is left out when the form is off.
Approved List, no Rockstar license “This server needs your Rockstar license to check its whitelist. Make sure you are signed in to FiveM.”
Admin Only, not staff “This server is open to its staff only right now.”
Discord mode, FiveM reports no Discord account “This server lets in members of its Discord server, but FiveM can’t see your Discord account. Open Discord on this computer, restart FiveM, and connect again.”
Discord mode, not in the Discord server “Join this server’s Discord (server name) to play here.”
Discord Roles, in the server without a role that lets them in “You need a role in this server’s Discord (server name) that lets you join.”
MonoAdmin could not check “This server can’t check its whitelist right now. Please try again in a minute.”
A reason the resource does not know “You can’t join this server right now.”

The Whitelist ID

In Approved List mode, a refused player gets a Whitelist ID: the letter R and four more letters or digits, such as R7KQM. It is the same format txAdmin uses, and it never contains a 0, an I or an O.

  • There is one for each player, tied to their Rockstar license, and it stays the same across attempts.
  • It is made at the player’s first refusal in Approved List mode. It is never made in the other modes, or for staff.
  • The player gives it to your staff. It also shows on their request and application, so staff can match what the player tells them.
  • On its own it opens nothing on the application page. The link in the join message carries a second part, a key, that goes with this ID and this link; a player applies, and reads where they stand, only with that link. See The Application Page.
  • IDs imported from txAdmin keep their value. See Move From txAdmin.

Refusals as a Card

Instead of the text, a refused player can get a card with your logo, your colors and links. Choose it under Settings > Whitelist, in the Refusal Message card: Show Refusals As is Text (the default) or Card. Save with the bar at the bottom of the window. The Live Preview under the settings shows the card as you type, for the refusal you pick in Refusal to preview.

Every whitelist refusal can be a card, including “This server can’t check its whitelist right now”. Bans are always shown as text.

What the Player Sees

The card is HTML in the message FiveM shows when it turns a player away, the way txAdmin styles its refusals. The player is dropped at once, as with the text refusal, and nothing waits on the connecting screen. FiveM shows its own Connection failed window, which holds, from top to bottom:

  1. FiveM’s title, Connection failed.
  2. FiveM’s line “Connection rejected by server:”, then your card. FiveM may put the name of the server’s owner where it says “server”.
  3. FiveM’s own small diagram of you and the server.
  4. FiveM’s Close button.

You cannot change FiveM’s words, diagram or button. The text refusal appears in the same window, so a card only replaces the message.

In that window:

  • A link in the card opens the player’s browser. So does a web address typed in the text when it starts with http:// or https://: FiveM turns it into a link by itself.
  • There is no Check Again and no Reconnect button. The player has already been turned away, so once you approve them, they connect again from the server list and get in.
  • FiveM keeps only a short list of HTML elements and attributes and drops the rest. The builder stays inside it, and your own card is checked against it when you save. The lists are under Your Own Card.

The Builder

With Card Design set to Builder, MonoAdmin makes the card from a few choices. From top to bottom it shows:

  1. your logo, when Show Logo is on: the application page’s logo, or your project icon when there is none;
  2. the Title, up to 100 characters, or your server’s name when it is empty;
  3. why the player was kept out, worded as in the text refusal, without the Whitelist ID and the link;
  4. their Whitelist ID, on a row of its own;
  5. your Refusal Message;
  6. a row of links: the Apply button when its switch is on, then your Link Buttons. You can add up to 3, each with a label of up to 40 characters and a web address of up to 300 characters starting with http:// or https://, such as your rules or your Discord invite.

A part with nothing to show for a refusal is left out. An Admin Only refusal has no Whitelist ID row, for example, and Apply shows only to a player who can apply: one who is not on the approved list, while the application form is on.

The Accent Colour is the card’s border, the background behind the Whitelist ID, the Apply button and the outline of your link buttons. Pick it with the color picker or type it as #rrggbb, such as #dc2626, the red that is used until you choose another. Anything else is refused when you save, and resetting the field puts the default back. The words on Apply are white, or nearly black when your colour is light enough that white would be hard to read.

The title, the link labels and the link addresses may carry the placeholders from the table below, such as {{player_name}}. Any other text in curly braces shows as you typed it.

Link What it does in game
Apply Opens the application page in the player’s browser, with their Whitelist ID and the link’s key filled in.
A link button Opens its web address in the player’s browser.

Your Own Card

With Card Design set to Custom HTML, you write the card yourself, in a box that takes HTML. Start From the Builder’s Card fills the box with the card the builder makes, laid out over several lines, as a starting point. It asks first, because it replaces what is in the box. Click a placeholder in the list to insert it.

FiveM keeps these elements and drops any other one together with everything inside it:

  • div, span, p, code, strong, em, b, a, br
  • h1, h2, h3, h4, h5, h6
  • ul, ol, li
  • img
  • details, marquee

And these attributes:

Attribute Where it can be used
style Any element. Inline CSS, without url or placeholders in it.
title Any element.
alt Any element.
href On a only.
src On img only.

Your card must:

  • be at most 16 KiB as you write it, with elements nested at most 32 levels deep;
  • use only the elements and attributes above. FiveM also keeps class, but the class names it knows are its own and change with its versions, so a card cannot count on them: class is refused like id, target and event handlers such as onclick;
  • give every href and src an absolute web address starting with http:// or https://, or a placeholder such as {{apply_url}}. A relative address and any other kind of link, such as mailto:, are refused;
  • have no url in a style, in any case. FiveM takes out the first one it finds, which breaks the rule it was in, so a background picture cannot be set that way. Use an img instead;
  • have no placeholder in a style, so no value, a player’s name included, can become CSS;
  • use only the placeholders below, and sections that open and close properly.

Comments are dropped. When you save, MonoAdmin keeps what you wrote in the box, and sends the game server a tidied copy written from what it understood: every attribute quoted, and each line break with its indentation turned into one space. FiveM turns every line break it is sent into a <br>, which is why none are sent. To break a line in your card, write <br>, or use a p or a div.

Placeholders

Any text, and the values of title, alt, href and src (not style), can carry these placeholders. Each is replaced for the player who is refused, and one with nothing for that refusal becomes empty.

Placeholder Replaced with
{{server_name}} Your server’s name
{{player_name}} The player’s name
{{whitelist_id}} The player’s Whitelist ID, when they have one
{{apply_url}} The application page with their Whitelist ID and the link’s key filled in; empty when the form is off
{{logo_url}} The address of your logo, or of your project icon
{{refusal}} Why they were kept out, worded as in the text refusal, without your message, the Whitelist ID or the link. It can run over several lines, and each shows as a line break
{{message}} Your Refusal Message
{{staff_reason}} The reason staff gave when they turned the player down
{{retry_at}} When the player can apply again, in your project’s time zone
{{guild_name}} Your Discord server’s name, in the Discord modes
{{reason}} A code for why: not_whitelisted, pending, rejected, admin_only, no_license, discord_missing, discord_not_member, discord_missing_role or unavailable
{{label_apply}}, {{label_whitelist_id}} The words Apply and Whitelist ID, in the game server’s language

The values are plain text: angle brackets and control characters are taken out, and what is left is written so that it shows as typed. A player named Tom & Jerry reads exactly that, and no name can add markup to your card. A name that is not in the table, or {{ that starts no placeholder, is refused when you save.

Sections

A part of the card can depend on a value. {{#name}} and {{/name}} around it keep it only when name has something to show for this refusal. {{^name}} and {{/name}} keep it only when it has nothing. The name is any placeholder from the table. Sections can nest, must close in the order they opened, and stand in text between elements, never inside a tag or an attribute.

<div style="padding:20px;border:1.5px solid #dc2626;border-radius:10px;color:#e8e8ea">
  <h2 style="margin:0 0 10px;color:#ffffff">{{server_name}}</h2>
  <p>{{refusal}}</p>
  {{#whitelist_id}}
    <p>Your Whitelist ID: <code>{{whitelist_id}}</code></p>
  {{/whitelist_id}}
  {{#apply_url}}
    <p><a href="{{apply_url}}" style="color:#ffffff">Apply to join</a></p>
  {{/apply_url}}
  {{^apply_url}}
    <p>Ask our staff on Discord to be let in.</p>
  {{/apply_url}}
</div>

A player who can apply reads the link, and one who cannot, because the form is off, reads the line about Discord instead. Without the sections, the link would be empty for that player and FiveM would show “Apply to join” as plain text.

What a Save Refuses

The panel checks your card as you type, and MonoAdmin checks it again on every preview and every save. A card that fails cannot be saved, so players never get a broken one. The first problem found is the one shown, and the panel says which element, attribute or placeholder it is, and roughly where. While Card Design is Builder, your HTML is kept, and it is checked when you save as well.

The card has Why it is refused
Nothing in the box, with Custom HTML chosen There is no card to show. Write one, or go back to the builder.
More than 16 KiB It is too long. Shorten it.
Elements nested more than 32 levels deep It is too deeply nested. Flatten it.
An element that is not in the list, such as table, button, style, script, form or input FiveM would drop it with everything inside.
An attribute that is not in the list, or href on an element that is not a, or src on one that is not img FiveM removes it, or it would do nothing there.
An href or src that is not an absolute http:// or https:// address FiveM keeps no other kind of link.
url in a style FiveM would take it out and break the rule.
A placeholder in a style A value, such as a player’s name, would become CSS.
A placeholder that is not in the table, or {{ that starts none It could not be filled in.
A section that does not close, closes out of order, closes one never opened, or stands inside a tag It could not be kept or dropped.

The Preview

The Live Preview draws a copy of FiveM’s Connection failed window: its dark window, the title in red, the line “Connection rejected by server:”, your card filled in with sample values, and a Close button. Refusal to preview picks which refusal the sample is for. Your card goes through the same rules as FiveM’s: what FiveM drops is dropped, line breaks become <br>, and class is ignored. Links in the preview open in a new tab.

The preview loads pictures only from MonoAdmin, so it can show your logo and nothing else. A picture from another site shows as a box with its alt text, and a note when you point at it. Players see it in game. The preview’s fonts and sizes are close to FiveM’s but not the same, so look at the real window on your server when the card matters.

If the Card Does Not Look Right

What you see Why What to do
Players read the text refusal, not the card The resource on your server is older than cards. Or, filled in for that player, the card is over 24 KiB. Or it is a ban, which is always text. Update the resource: see Older Resources. Make the card shorter.
A picture shows in game but is a box in the preview The preview loads pictures from MonoAdmin only. Nothing to fix.
A link shows as plain text, or does nothing Its address was empty for that player, such as {{apply_url}} when the application form is off. Put the link inside {{#apply_url}} and {{/apply_url}}.
Your text is hard to read in game FiveM’s window is dark and its text is grey. Give the text a color in its style, as the builder’s card does.
A player you approved still sees the card The card does not check again. They connect again from the server list.

Older Resources

Cards need the MonoAdmin resource from this version on. On a server with an older one, players read the text refusal, and Settings > Whitelist says so under Show Refusals As until you update it. See Update and Uninstall.

Requests

Open Whitelist in the sidebar, under Moderation. You need View Whitelist. The header shows the mode and the counts, and there are three tabs: Requests, Applications and Approved. Without Manage Whitelist the lists are read-only. New requests and applications appear on their own, without a reload.

A request is made the first time a player who is not staff and not on the list, and who has a Rockstar license, is refused in Approved List mode. It keeps their name, their Whitelist ID, the account identifiers of their latest attempt and how many times they tried. It never keeps an IP address or a hardware token.

The Requests tab lists requests that are waiting and have no application, the most recent attempt first. A request with an application waiting is on the Applications tab instead. Each row has the name, the Whitelist ID with a copy button, the identifiers, the attempts and the time of the last one.

Approve or Deny

  • Approve puts the player’s Rockstar license on the approved list, with the source request, and marks the request approved. The player gets in the next time they connect. A toast confirms it.
  • Deny opens a dialog where a reason is optional. The request becomes denied. If the player had an application waiting, it is rejected with the same reason. The reapply wait starts.

The Reapply Wait

After a denial or a rejection, the player has to wait before they can apply again. The wait counts from the latest decision. You set it with Wait Before Applying Again under Settings > Whitelist: 0 to 720 hours, 24 by default, and 0 lets them apply again at once.

While the wait lasts, the player sees the refusal with your reason and the date they can apply again, on the connecting screen and on the application page.

Old Requests Are Cleaned Up

A waiting or denied request that has not had a new attempt for 90 days, and has no application waiting, is deleted.

The Application Form

By default a refused player can only give their Whitelist ID to your staff. The Application Form lets them ask for themselves instead: they open a page on the panel’s address, answer the questions you wrote and wait for a decision. You need Whitelist Settings to set it up, under Settings > Whitelist in the Application Form card.

Set It Up

The card has:

  • a switch to turn the form on or off;
  • a Form Title (up to 100 characters) and an Introduction (up to 4,000 characters) shown above the questions;
  • the Logo at the top of the application page, described below;
  • Wait Before Applying Again, described above;
  • the application link, with a copy button;
  • the questions;
  • Preview Form, which shows the page as a player sees it.

The form takes applications only while the mode is Approved List. Save with the bar at the bottom of the window. If someone else saved first, the panel tells you, and you reload before editing again.

The Questions

You can add up to 20 questions, move them, change their type and remove them.

Type What the player does Limits
Short answer Types a line Up to 200 characters
Paragraph Types a longer text Up to 4,000 characters
Choice Picks one option 1 to 25 options
Checkbox Ticks one box, such as “I have read the rules” A required checkbox must be ticked

Each question has a label (up to 200 characters), an optional description (up to 500), a Required switch and, for text questions, an optional placeholder and a lower maximum length. Answers are saved together with a copy of the questions as they read when the player applied, so changing the form later never changes an application you have already received.

The Application Page

Players apply on a page on the panel’s address, /apply/ followed by your project’s link code. The link on a refusal screen, in the join message, is the player’s own: it already has their Whitelist ID and a key filled in, like /apply/Xk3p9QwR2tLm?id=R7KQM&k=….

The link from the join message is needed. A Whitelist ID is short, and players read it out and show it on screens, so the ID alone opens nothing. The page tells a player where they stand (their name, whether an application is waiting, your reason for a refusal and when they can apply again) and takes their application only with the key in their own link. The key is made by MonoAdmin for that ID on your current link, so a player cannot work it out from the ID, and a key from a link you replaced with New Link stops working. A player who opens the page with only an ID, or without the right key, sees the form’s title and introduction and a line that the link from their join message is needed. They can paste the whole link into the page’s field, and the page reads the ID and the key out of it. Typing the ID alone does not work.

The link you copy from Settings > Whitelist is the page itself, without an ID or a key. Share it for people to find your page, but a player needs their own link, from trying to join, to apply.

The page shows your server’s brand at the top, who the player is applying as, and the questions. Before the application is sent, the page asks the visitor to pass a short check that they are a person. A small “Powered by MonoAdmin” line sits under the page.

The top of the application page shows, in this order of preference:

  1. the logo you uploaded, on its own;
  2. with no logo, your project icon beside the server’s name;
  3. with neither, the server’s name.

To set the logo, open Settings > Whitelist and, in the Application Form card, click Upload Logo. The logo is saved as soon as you choose the file; it does not wait for the save bar. Replace Logo puts in a new one, and Remove goes back to your project icon and name.

  • PNG, JPEG, WebP or GIF, up to 2 MB, at least 32 pixels on each side.
  • At most 8 times as wide as it is tall, and at most twice as tall as it is wide. Wide logos work best.
  • MonoAdmin keeps it at up to 800 by 320 pixels, and the page shows it at up to 400 by 160. A larger image is scaled down. A smaller one keeps its size.
  • Transparency is kept. Visitors may use a light or a dark theme, so pick a logo that reads on both.
  • The logo shows whatever the whitelist mode is, so you can check the page before you turn the whitelist on. You need Whitelist Settings to change it.
What the page shows When
“This application link isn’t valid.” The link is wrong, or you replaced it with New Link.
A field for the link from the join message, and a line that it is needed There is no ID in the link, the key is missing or wrong, or MonoAdmin does not know the ID. Nothing about the ID is shown.
That applications are closed The mode is not Approved List, or the project is suspended.
The ID and “Give it to the server’s staff” The mode is Approved List but the form is off.
The form The player can apply.
That the application is waiting for staff They applied already. A player can have one application waiting at a time.
The reason staff gave and “You can apply again” with a time The wait is not over.
The last reason, then the form The wait is over.
That they are on the whitelist They are on the approved list.

A player on the list cannot apply, and nobody can apply while an application of theirs is waiting or while the wait runs.

Accept or Reject

Applications are on the Applications tab: a list, and the answers of the one you open (side by side on a wide screen). The filter starts on Pending and also offers Accepted, Rejected and All.

  • Accept puts the player’s license on the approved list, with the source application, marks the request approved and the application accepted.
  • Reject needs a reason, up to 500 characters. The dialog says when the player can apply again. The request stays waiting, and the reapply wait starts. The player reads your reason on the connecting screen and on the application page.

The application page’s link is the same for every player, and each player’s own link adds their Whitelist ID and key to it. New Link replaces it, after you confirm: “The old link stops working.” Every key made for the old link stops working too, so players who saved the old link need the new one: they try to join again to be given it. Refusal screens use the current link automatically.

The Approved List

The Approved tab is the list of identifiers that get in under Approved List mode. A connecting player gets in when any identifier they connect with matches an entry.

Each row shows the identifier, the player’s name when known, a badge for the source, the note, who added it and when. You can search, and filter by source:

Source How it got there
By hand A member added it with Add Player.
Request Staff approved a request.
Application Staff accepted an application.
From txAdmin It was imported from txAdmin.

Add a Player

With Manage Whitelist, press Add Player. Either:

  • pick a known player (this needs View Players). MonoAdmin adds their Rockstar license, or their main identifier when they have no license and its kind is allowed; or
  • type an identifier such as license:… or discord:…. The kinds are license, license2, fivem, discord, steam, live and xbl.

You can add a note of up to 500 characters. Adding a license also approves that license’s request and accepts the application that is waiting. An identifier that is already on the list is refused.

Prefer the Rockstar license where you can. FiveM verifies it when a player connects, and requests and applications use it.

Remove a Player

Choose Remove on a row. The dialog says “They can’t join while the whitelist is on. You can add them again at any time.” A player who is online stays until they leave. The next time they are refused, their request is waiting again, with the same Whitelist ID.

Discord Modes

Discord Server Member and Discord Roles ask your Discord server about each player who connects.

They need:

  • your Discord server connected under Settings > Discord, with the shared MonoAdmin bot or your own bot (see Discord Tickets);
  • the Discord module on under Settings > Features.

Players are matched by the discord: identifier FiveM reports for them. A player whose game has none cannot pass: they are told to open Discord on that computer, restart FiveM and connect again. In Discord Server Member mode the player has to be a member of the server. In Discord Roles mode they also need one of the roles you chose. The role picker lists the server’s roles as the bot last saw them, and you can choose up to 25.

MonoAdmin remembers Discord’s answer for a short time, up to a minute, so a player who has just joined your Discord server or lost a role may need a moment before it counts.

When Discord Cannot Be Asked

If the Discord module is off, no server is connected, your own bot is paused or refused by Discord, or Discord does not answer in time, MonoAdmin cannot check anyone. Players who are not staff are kept out, and the Whitelist page shows the problem. Your own bot is paused when MonoAdmin staff switch it off for the project, and the page then says “MonoAdmin staff switched off your own bot for this project, so it is paused and only your team can join. Go back to the MonoAdmin bot in Settings > Discord.” Settings > Features asks you to confirm before you turn the Discord module off while a Discord mode is in use: “Your whitelist checks Discord. With Discord off, only staff can join.”

Using It With txAdmin

txAdmin has an allowlist of its own. If it and MonoAdmin’s whitelist are both on, a player has to pass both. To keep MonoAdmin’s whitelist the only one:

  1. In txAdmin, open Settings > Allowlist.
  2. Set Allowlist Mode to External Allowlist Resource, or to Disabled.

With External Allowlist Resource, txAdmin skips its own check, and the server list still shows your server as allowlisted. Any other option makes txAdmin check players too.

How MonoAdmin Tells

MonoAdmin does not read txAdmin’s configuration. The resource reads four settings that txAdmin sets on a server it runs, and listens for the event txAdmin fires when its Approved License mode refuses someone. It accepts that event only from txAdmin’s own resource, and it looks again whenever txAdmin changes its settings and every minute. See How MonoAdmin Is Secured.

What the resource finds What it means What the panel does
The server is not run by txAdmin Nothing to set. The What We Found step of the guided setup says “txAdmin not found.”
txAdmin’s allowlist is Disabled txAdmin does not check players. No warning.
External Allowlist Resource txAdmin leaves the allowlist to MonoAdmin. No warning.
Unclear txAdmin’s allowlist is either enforcing, or set to External while txAdmin’s own player check is on. The settings look the same either way. Warns, with the steps above.
On txAdmin’s Approved License mode just refused a player. This is certain. Warns, with the steps above.

For Unclear, if you know the mode is External, press It’s Set to External to dismiss the warning (you need Whitelist Settings). The answer is kept until your server reports a different state, and then the panel asks again. It is not offered for On, because there txAdmin’s allowlist is known to be enforcing: change it in txAdmin.

The warning appears:

  • on the Whitelist page and on Settings > Whitelist;
  • as a step in the turn-on dialog;
  • on the What We Found step of the guided setup;
  • among the dashboard alerts and on the Server Link card, while the whitelist is on.

While the whitelist is on and txAdmin’s allowlist might be too, the server console also prints a warning telling you to set Allowlist Mode to External Allowlist Resource.

In Game

Staff can review the whitelist without leaving the game. Open the menu, go to the Panel tab, choose Web Panel and open Whitelist. The three tabs are there, and approving, denying, accepting, rejecting, adding and removing work with the same permissions as in the browser. See The Panel Tab and Player Window.

The mode, the refusal message, the Discord roles, the application form, the application link and the txAdmin confirmation stay in the browser. The Whitelist Settings button does not appear in game.

Permissions

The three permissions are in their own Whitelist group on Settings > Roles:

Permission What it allows
View Whitelist See requests, applications and the approved list.
Manage Whitelist Approve and deny requests, accept and reject applications, and add or remove players.
Whitelist Settings Turn the whitelist on or off, choose who may join, edit the refusal message, the Discord roles and the application form, replace the application link and confirm txAdmin’s External setting.

The project owner holds all three. A new project’s Admin role starts with all three and the Moderator role with View Whitelist and Manage Whitelist. Roles that existed before the whitelist was added were given the first two if they could ban, and Whitelist Settings if they could edit settings. Nobody can give a permission they do not hold. See Roles and Permissions and the Permission Reference.

Give Whitelist Settings with care: choosing a mode decides who can play on your server.

Notifications

The topic Every New Whitelist Request under Account > Notifications sends you a Discord message when a new request or application arrives. It is off by default. It reaches only people who turned it on and whose role includes Manage Whitelist, and new requests are limited to one message every 10 minutes for each project. See Notifications.

What Is Recorded

  • Server Logs. Each refusal is a line under Connections (“was refused at the door”), with the reason and the Whitelist ID. See Server Logs.
  • Audit Logs. Mode changes, settings changes, a new link, the txAdmin confirmation, additions, removals and every decision are recorded with who did them. An applicant’s answers are never copied into the audit log. See Audit Logs.
  • Staff Activity. Adding, removing, approving, denying, accepting and rejecting earn points as admin actions in a member’s score. See Staff Activity.

If Something Goes Wrong

What you see Why What to do
Everyone, staff too, reads “This server can’t check its whitelist right now.” The server cannot reach MonoAdmin, or MonoAdmin did not answer in time. The whitelist keeps players out when it cannot check. Restore the link. Run monoadmin status and see Troubleshooting. Choosing Off reaches the server only once it is connected again.
A staff member reads “This server is open to its staff only right now.” Their game account is not linked, so MonoAdmin does not recognise them as staff. They link it with /madmin link. The Whitelist page names the members who have not.
Discord members are refused Their game does not report a Discord account, they are not in the server or lack the role, or a Discord problem is shown on the Whitelist page. Check the message they read and the page. A change of membership or role can take up to a minute to count.
Players on the approved list are still refused, with a message that is not MonoAdmin’s txAdmin’s own allowlist is on too. Set txAdmin’s Allowlist Mode to External Allowlist Resource or Disabled.
A player you approved still reads that they are not on the whitelist They joined with a different account from the one on the entry. Compare the identifier on the entry with the one on their request.
The whitelist is on but a player who is not on the list gets in Your resource is too old to check the whitelist, or the player is recognised as staff, or one of their other identifiers matches an entry. Look for the resource warning on the Whitelist page, and update the resource. Check the entries for the identifier.
Players read plain text although you chose Card, or the card looks different in game The resource is older than cards, the filled-in card is too big, or FiveM draws it a little differently from the preview. See If the Card Does Not Look Right.
“This application link isn’t valid.” The link was replaced with New Link, or mistyped. Use the link on the player’s refusal screen, or copy the current one from Settings > Whitelist.
The application page asks for “the link from your join message” The player opened the page without their own link, typed only the Whitelist ID, or has a link from before you used New Link. Ask them to try joining again and open the link in the message, or paste that whole link into the page. The ID alone is not enough.
The application page does not know a Whitelist ID Their request was cleaned up after 90 days, or the player has not been refused in Approved List mode yet. Ask them to try joining again, and to use the link from the new message.
You cannot choose a Discord mode The Discord server is not connected, or the Discord module is off. Connect it under Settings > Discord and check Settings > Features.
Discord Roles will not save It needs at least one role. Choose a role in the role picker.