Address whitelist

Address whitelisting feature setup and usage.

Introduction

The plugin also comes with an address whitelisting feature (configuration available under address-whitelist inside the configuration file of the plugin on the proxy server), which can be used to restrict the addresses players use to connect to your server.

It is worth mentioning is that the whitelist only accepts IPv4 addresses / DNS names.

Address whitelist is not a security feature in any way. It is just a ,,decoration".

Specifying an address

Specifying a whitelist entry is trvial. Simply, put there the exact IP/DNS name you want players to connect with to your server, for example:

address-whitelist:
  ...
  addresses:
  - "yourserver.com:25565"

Please note that a port is required. If you don't specify any port when you join, use the port at which the proxy server is hosted, usually 25565.

Using GeyserMC?

If you are using the address-whitelist, make sure to whitelist the GeyserMC server address and enable forward-hostname as defined here.

If you can't do so, you might need to whitelist the address GeyserMC server uses to connect to the proxy server (usually a local IP).

Servers with dynamic IPs

Use {ip} placeholder, which acts as a replacement for the actual IP and is refreshed everytime the server restarts.

If you do so, please do not forget to configure the server used to retrieve the IP of the server in ip-website field.

DNS names (domains)

Please note that by default DNS servers do not recognize case-sensitivity in most cases. That is, players will also be able to connect using YoUrSERVER.com, for example. To comply with this behaviour, such variations of the whitelisted DNS names will also be accepted.

To compare an address case-sensitively, put an exclamation mark before the address, for example: !yourserver.com:25565, (which will allow only players connecting with this exact address).

Some DNS records (for example SRV) are a complete redirect.

Sometimes, the address player used to connect with is changed in the process while connecting; you may need to whitelist the redirected IP/DNS.

Check the console when you join. For further assistance, see FAQ, or submit a ticket on our Discord server (nonstop 24/7 🤖 support).

Enable and reload

After everything's done, set enabled to true and reload the plugin using /sn reload in the proxy's console to apply the changes.

If you have multiple proxies, you must set this feature up on all of them.