Setup a Whitelist for your Vintage Story Server

Setting up a whitelist is a simple and effective way to limit your Vintage Story server to players who you trust. It’ll prevent unauthorized users from connecting to your server and potentially damaging or griefing your world.

Enable the Whitelist

By default, Vintage Story servers will have the whitelist enabled by default. If a server has the whitelist disabled, these instructions will show how to enable it.

1. Login to Command Center.
2. From the Servers list, click Manage on the server you want to modify.
3. You should already be on the Console tab, but if not, select it.
4. Type /serverconfig whitelistmode on into the console and press Enter.
5. On your computer, start Vintage Story and try to connect to the server. You should get an error when joining the server. If you're still able to join the server, you may need to manually turn on the whitelist:
   1. Click on the Files tab above the console.
   2. Click on the data folder, then click serverconfig.json
   3. Find the setting "WhitelistMode" and set it to 0 or 2 (0 will enable the whitelist on dedicated servers, 2 will force whitelist on).
   4. Save the file and restart the server.

📘

About "OnlyWhitelisted"

Some serverconfig.json files will contain this setting. This is a config from older versions and is unused in newer versions of Vintage Story. Editing this value may not modify the whitelist.

Disable the Whitelist

If you would like to disable the whitelist to allow anyone to connect to the server, the whitelist command can also be used to turn it off.

1. Login to Command Center.
2. From the Servers list, click Manage on the server you want to modify.
3. You should already be on the Console tab, but if not, select it.
4. Type /serverconfig whitelistmode off into the console and press Enter.

Add a player to the Whitelist

To allow players to join a whitelisted server, they will need to be added to the whitelist.

1. Login to Command Center.
2. From the Servers list, click Manage on the server you want to modify.
3. You should already be on the Console tab, but if not, select it.
4. Type /player [playername] whitelist on, changing [playername] to who you want to add to the whitelist, then press Enter.

Remove a player from the Whitelist

If you do need to remove a player from your whitelist, a command can be run to revoke this permission.

1. Login to Command Center.
2. From the Servers list, click Manage on the server you want to modify.
3. You should already be on the Console tab, but if not, select it.
4. Type /player [playername] whitelist off, changing [playername] to who you want to remove from the whitelist, then press Enter.