Adding a Whitelist to your Rust Umod/Oxide ServerLast updated: 07/02/19
This article will show you how to install and setup 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 Nodecraft, 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 Nodecraft 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 Nodecraft 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.
Enable RCON Access on your Rust Server
Before you even download or use an RCON tool, you need to change some settings on the Nodecraft control panel for your Rust Server to allow RCON connections.
Click on "Game Settings" on the leftmost side, and then click the "Advanced" tab on the blue bar across the middle of the screen.
On this page, change the following:
Set the RCON port to "28017"
Enter an RCON password
Click the "Enable Web RCON" box
then click "save" at the bottom of that screen to save all those settings.
Your Rust server is now set up to receive RCON connections.
Download and setup an RCON tool/program
If you already have an RCON, and know how to use it, you can skip the rest of this section.
There are many RCON tools/programs, but for this article we will used one of the most commonly used ones, RustAdmin. It's been around for a long time, it's stable, and easy to use.
There are also other RCON tools (Rusty Rcon, MyRustAdmin, etc), and even some browser based RCON tools, such as http://rcon.io/, but for the rest of this article, we will use Rustadmin for all the screenshots.
You can download it at https://www.rustadmin.com/. You do not need to "install" it. Simply unzip the package, open the folder inside and it's ready to be used wherever you unzipped it.
Start RustAdmin, and configure it
To use RustAdmin, double click on the RustAdmin.exe file.
and you should see the following appear.
Enter Connection Information on the Configuration Screen
Change the settings on this page and save it. Once you've entered all this information on the configuration screem, it will allow you to connect to your server by simply clicking on one button later on.
Change RCON type to "WebRcon"
Enter the server port for Rust, 28015
Enter the RCON port you set earlier, 28017
Enter the RCON password you set earlier.
Save those changes.
Connect to the Server with RCON
To make a connection to your Rust server, click on the "server" button on the dark grey bar at the top of the RustAdmin window, then click "connect". It should form an connection based on the information you entered on the configuration screen.
If everything is set up correctly, you will see "connected" in green letters in the lower left edge of the window.
Unless something is currently happening on the Rust server, you probably won't see any thing else happening on other parts of the screen. You will generally only see something appear in the console section of RustAdmin if you have run a command.
Set Yourself as Owner of the Rust Server
if you haven't set yourself as the server owner yet, please do that now. A server owner is automatically made an admin as well.
Enter these commands below, one at a time in the box shown above.
server.writecfg ownerid STEAM64ID "playername" server.writecfg
You must replace STEAM64ID and "playtername" with the correct information. Your Steam64ID (such as 76561198047699606) you can obtain using your Steam account and the tool on this website: https://steamid.co/
After making those changes in your RCON, you will have to restart the server to finish setting yourself as an admin. After restarting the Rust Server, re-connect to the server with RustAdmin RCON.
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.
Congratulations! You've whitelisted your Rust server!