-
Notifications
You must be signed in to change notification settings - Fork 3
Setup Guide
ServerSync uses Spigot's Bungeecord system in order to sync data between different servers on your network. You do not need to be running Spigot on your servers, but you must have a Bungeecord Hub which players connect directly to. The BungeeCord Hub is the connection between all of your servers and ServerSync cannot function without it.
You will need to install ServerSync (Bukkit/Spigot version) on each and every Bukkit/Spigot server that you want to sync data across.
Additionally, you will need to install the ServerSync Bungeecord plugin on your Bungeecord Hub in order for ServerSync to work. Please visit the ServerSync Bungeecord Spigot page for more information.
ServerSync uses Bungeecord's messaging system in order to relay data across all of your connected servers. As much as you'd like to think, your Bungeecord Hub does not actually connect to any of your Bukkit/Spigot servers. Instead, when a player connects to the Bungeecord Hub, they are forwarded to one of your Bukkit/Spigot servers. The player acts as the only connection between the hub and a Bukkit/Spigot server. With that being said, a player must be connected to a server in order for it to connect to the Bungeecord Hub and sync data.
If a player is not connected, the servers will place their sync data into queue's to ensure data is sync properly once a player comes online. If a server goes down, ServerSync Bungeecord will queue all updates for that server and will deliver them once it reconnects.
While the plugin network will function fine in whichever order you install them, the following setup order is recommended:
- Install ServerSync Bungeecord (a different plugin) on your Bungeecord Hub
- Install ServerSync Bukkit/Spigot on the desired Bukkit/Spigot servers
Download the ServerSync jar from Spigot and install it on all of your servers you wish to sync data across, in the folder /Plugins.
Once you've placed the JAR into the folder, completely restart your server.
If you want to exclude a server from having data synced to/from it, do not install the plugin on that server. The other servers with the plugin installed with continue to sync data just fine.
Whether you've setup the Bungeecord Hub plugin before installing ServerSync on all of your node servers OR set it up after - The Bukkit/Spigot servers with ServerSync installed will automatically detect and connect to the Bungeecord Hub and associate themselves. There's no configuration necessary.
If you haven't read the 'Things to Know' section above, please do so. A player must be connected to the server you just installed ServerSync on in order for it to associate itself with the Bungeecord Hub!
There is no required configured for ServerSync out of the box - it just works. If you'd like to read about setting up transmission encryption, which is highly recommended, please see the section below.
Like explained above, players act as the connection between the servers using ServerSync, meaning the data transmitted to be sync passes through them. It is possible for players to modify this data, which is why ServerSync offers the ability to encrypt the data being transmitted with an encryption key of your choice.
If you setup transmission encryption, you must do so on ALL of your ServerSync servers. The ServerSync Bungeecord Plugin does not read transmitted data, thus there is no configuration for transmission encryption required on your Bungeecord Hub.
You can disable encryption just as easy as you can enable it, at any time.
You must choose a 16 character encryption key which will act as the encryption/decryption key for all of your ServerSync servers. Encryption keys must be exactly 16 characters long and must be the same across all ServerSync servers.
With your encryption key chosen, repeat the following steps on ALL of your ServerSync servers:
-
Set the encryption key by executing
/serversync settings encryption key [myKey]where you replace[myKey](including the []'s) with the 16 digit encryption key of your choice. -
Enable encryption by executing
/serversync settings encryption enable
Assuming all goes well, you'll receive a message from ServerSync with confirmation of encryption setup. Remember to repeat those steps on ALL of your ServerSync servers.