Single

This section is for single servers. "Single servers" are servers that are not intended to be hooked into a network, put behind a proxy, or interact with other game servers in any other way.

To set Anti-VPN up for a single server, simply drop the jar into your "plugins" folder. The auto-generated configuration should default to reasonable values for you, but you may modify it if you wish using the configuration guide here.

Network

This section is for servers that are intended to be hooked into a network, set behind a proxy, or interact with other game servers.

To set Anti-VPN up for a network, drop the jar into the plugins folder and restart the server. Once the server has started up, modify the configuration file to use a remote storage option instead of (or as well as) a local one. Messaging is optional but highly recommended if you have multiple servers. You may find more information on modifying the configuration using the configuration guide here.

Syncing data between servers

In order for data to sync, you must be using a remote storage option (outlined in the Storage section below) and/or a stable messaging engine (outlined in the Messaging section below).

You can enable as many different storage and messaging engines as you'd like simultaneously with no issues or incompatibility. It is recommended to use as many as you can in order to ensure that if anything drops off the network, the plugin will continue to function normally.

Storage

There are multiple ways Anti-VPN can store data, and more are coming soon! Storage services may be configured in the configuration file as outlined here.

Currently, the options are:

• Remote
  • MySQL (<= 5.5)
  • MySQL (> 5.5)
  • MariaDB
• Local
  • SQLite

The current default is SQLite.

Messaging

Anti-VPN can instantly share data between servers across a network using several configurable messaging engines. This prevents redundant checks and possible data inconsistencies between servers on a network. Messaging services may be configured in the configuration file as outlined here.

Currently, the options are:

• RabbitMQ
• Redis

The current default is none/disabled.

Requirements

Anti-VPN has just a couple of requirements. The vast majority of servers will meet these requirements already.

tl;dr

• You need Java 8 or greater
• The server will need access to the internet

Java 8

Your server must be running Java 8 or greater. Every reasonable host should have updated by now. If yours has not, ask them nicely :)

Internet access

Anti-VPN downloads some needed libraries at startup and requires an active internet connection to query the various enabled services for bad IPs and users.

Compatibility

Some known compatibility issues are outlined below. Generally, these won't affect your server since they're fairly edge-case, but it's good to know about them anyway.

CraftBukkit & Offline Mode

If your server is using CraftBukkit and running in Offline or Cracked mode, Anti-VPN (and a number of other plugins, for that matter) may not work as efficiently as expected. This is due to a CraftBukkit bug regarding the AsyncPlayerPreLoginEvent.

Your options are:

• Switch to Spigot or Paper (You should be using Paper anyway)
• Enable online mode
• Deal with possible data inconsistencies yourself

Older Minecraft versions

Anti-VPN is not developed to run on Minecraft versions less than 1.8.8 and older versions are not tested thoroughly, although they should still work. If you use it on 1.8.8 it will (harmlessly) complain every time you start the server simply because 1.8 is incredibly outdated, broken, and insecure and there are plugins nowadays that allow you to accept 1.8 players on any server version- so there's no real reason to use it.