Installation

Gatekeeper is a server-side Fabric mod. Players don't need to install anything.

Requirements

Steps

  1. Put the Gatekeeper JAR in your server's mods folder.
  2. Install Fabric API, and Floodgate if you want Bedrock support.
  3. Turn off the vanilla whitelist in server.properties. Gatekeeper doesn't use it.
  4. Start the server once so Gatekeeper can create its files.
  5. Configure Gatekeeper in config/gatekeeper/.
  6. Approve your first administrator.

A new installation denies everyone.

Unless a whitelist.json already exists, in which case Gatekeeper imports it, no one can join until you approve them.

Approve your first administrator

The console can always run Gatekeeper commands, so approve yourself from there. If you've already tried to join, you have a record and can use the status command:

gatekeeper status YourName whitelisted

If you haven't joined yet, add yourself by UUID and username:

gatekeeper add <uuid> YourName whitelisted

To run commands in game, you also need OP level 3 or higher. See Permissions.

Bedrock players

Install Geyser and Floodgate as usual. Gatekeeper then handles Java and Bedrock players with the same statuses and denial screens, and you can add Bedrock-specific text to a screen. See Denial screens.

After installing

Once a player has a record, you can manage them with /gatekeeper, the HTTP API, or the vanilla /whitelist, /ban, and /pardon commands.