There are upcoming maintenance events which may impact our services. Learn more

How to Add a Whitelist to your Rust Umod/Oxide Server Print

  • rust
  • 0

This article will show you how to install and set up a whitelist Umod/Oxide plugin if you want to have a private Rust server.

Install Umod/Oxide, if you have not already

You will of course, need to install the Umod/Oxide plugin framework on your Rust server.

Here at AleForge, we have added that as a choice in our One-Click installer for you. After you have installed your Rust server, click the "One-Click" tab on the AleForge control panel again, choose Umod/Oxide, and it will install in "overwrite" mode
(it is very important that the default install method not be changed from "overwrite" for Umod/Oxide").

After Umod/Oxide is installed, start the Rust server, let it finish loading, and then shut it down.
This will cause the server to create an "Oxide" folder, with many sub-folders inside, including the "plugins" folder where you will want to place all the plugins (and you will need that for the next step).

Get the Whitelist Plugin and Install it

While there are several whitelisting plugins for Umod/Oxide, this guide will focus on one of the most commonly used ones, which is Wulf's Whitelist. The plugin can be downloaded at https://umod.org/plugins/whitelist

It will download as a file called "whitelist.cs".

Upload that file to the "plugins" folder inside the "oxide" folder on your Rust Server.

NOTE: as soon as the whitelist plugin is on your server and you have restarted the server, it will refuse any players who aren't already on the whitelist. And that list hasn't been made yet. So until the rest of the setup is finished, no one will be able to join the server.

Any players who attempt to connect will see the normal "connection established" screen appear in the Rust client, and disappear almost instantly. If you have an active RCON connection at the time, you will see a message in RCON that they were refused connection because they aren't on the whitelist. Since Rust doesn't have a console, you won't see any other messages except in the RCON tool.

You will need to use an "RCON" tool to send commands to the server

Rust has no console, so there's no normal way to issue commands to the server from inside the game, or from the AleForge control panel.

To issue commands, you will need to use what is called an RCON tool, which stands for "remote console".

The RCON will create a two-way connection with the server, allowing you to send it commands, and then see output and confirmations from those commands running.

Add players to the Whitelist

To add a player to the Wulf's whitelist, use the following command in the RCON command line box:

oxide.grant user (Steam64ID/username) whitelist.allow

it will look something like this, as an example:

oxide.grant user 76561198047699606 whitelist.allow

When players have the "whitelist.allow" tag in their permissions, it will allow them to join the server.

Adding users one at a time like this is best for smaller servers. If you have a very very large number of players, it might be more efficient to create "groups" in the permissions system built into Oxide, and then simply assign players to those groups. You can change the permissions of many players at once, by just changing the one group they all belong to you.

Check the Umod/Oxide documentation for more information on how to use the complete set of features of Umod/Oxide's permissions system.

Removing a player from the Whitelist

You can remove someone from the whitelist by using the command:

oxide.revoke user (Steam64ID/username) whitelist.allow

That removes the "whitelist.allow" tag, and they will now be blocked from re-entering the server.

 


Was this answer helpful?

« Back
Login Sign Up