Getting Started

You will need to login using your Google account to get started. If you don't already have a server group, one will be created when you login. More login options may be added in the future.

Install the Whitelist Sync Forge, Fabric, or NeoForge mod on your Minecraft servers. Download fromCurseForgeorModrinth.
Most modern Minecraft versions are supported (v1.16.5+). If you need support for an older version, please reach out on Discord.
Mod version v2.6.X+ is required to work with this service.

After logging in and installing the mod, open your server group using the server groups link at the top of the page. A server group is a group of servers that will have their whitelisted and opped players synced. All users start with one default server group. If you need more, reach out on Discord. Each plan subscription is tied to one server group.

Manage player access lists by clicking the Whitelist, Ops, Banned Players, and Banned IPs buttons. Users with management permissions will see a Manage button for API keys and user management.

Generate an API key on the server group manage page. It's best to make an API key for each server, naming it accordingly. Copy the code (it won't be shown again) and add it to your whitelistsync2-common.toml config file:

[general]
  databaseMode = "WEB"

...

[web]
  #API Key for the web service. You can generate one by logging into the web service and adding a new API key to your server group.
  webApiKey = "[API KEY HERE]"
  #Host for the web service. This should be the URL of the web service. You should never need to change this.
  webApiHost = "https://whitelistsync.com/"
  #Option to enable banned players sync.
  webSyncBannedPlayers = true
  #Option to enable banned IPs sync.
  webSyncBannedIps = true

...

Make sure databaseMode is set to "WEB" and webApiKey is set to your API key.

Once your server is running and no errors are shown, push your existing whitelisted, opped, banned players, and banned IPs using the /wl push command. All lists are managed using vanilla Minecraft server commands. Whitelist Sync will automatically sync the lists across all servers in real time. See the mod documentation on CurseForge or Modrinth.