Setup

This will walk you through installing HuskSync on your network of Spigot or Fabric servers. Please check your server's Compatibility and download the correct version of HuskSync for your server.

Requirements

HuskSync requires a Database server, a Redis server, and any number of compatible Minecraft servers:

• Any number of compatible Fabric or Spigot/Paper-based servers
  • Each server must be running the same exact version of Minecraft
  • It is not possible to sync data between a mixture of Fabric and Spigot servers
  • HuskSync does not need to be installed on your Velocity, BungeeCord, or Waterfall proxy
• A Database server running MySQL v8.0+, MariaDB v5.0+, PostgreSQL or MongoDB
• A Redis server running Redis v5.0+

Setup Instructions

Before you begin, switch off all servers on your network. It is recommended that you also take a backup.

1. Install the jar

• Place the plugin jar file in the /plugins/ or /mods/ directory of each Spigot/Fabric server respectively.
• You do not need to install HuskSync as a proxy plugin.
• Spigot users: You can additionally install ProtocolLib or PacketEvents for better locked user handling.
• Fabric users: Ensure the latest Fabric API mod jar is installed!

2. Restart servers

• Start, then stop every server to let HuskSync generate the config file.
• HuskSync will throw an error in the console and disable itself as it is unable to connect to the database. You haven't set the credentials yet, so this is expected.

3. Enter Database & Redis server credentials

• Navigate to the new config file on each server (~/plugins/HuskSync/config.yml on Spigot, ~/config/husksync/config.yml on Fabric)
• Under credentials in the database section, enter your database credentials. If you're using a Mongo database, follow the instructions here. You shouldn't need to modify the connection_pool properties.
• Under credentials in the redis section, enter the credentials of your Redis server. If your Redis server doesn't have a password, leave the password blank as it is.
• Unless you want to have multiple clusters of servers within your network, each with separate user data, you should not change the value of cluster_id.

MongoDB users — additional instructions

• Navigate to the HuskSync config file on each server (~/plugins/HuskSync/config.yml)
• Set type in the database section to MONGO
• Under credentials in the database section, enter the credentials of your MongoDB Database. You shouldn't touch the connection_pool properties.
• Under parameters in the mongo_settings section, ensure the specified &authSource= matches the database you are using (default is HuskSync).

Additional setup for MongoDB Atlas

• Set using_atlas in the mongo_settings section to true.
• Remove &authSource=HuskSync from parameters in the mongo_settings.

(The port setting in credentials is disregarded when using Atlas.)

4. Set server names in server.yml files

• Navigate to the server name file on each server (~/plugins/HuskSync/server.yml on Spigot, ~/config/husksync/server.yml on Fabric)
• Set the name: of the server in this file to the ID of this server as defined in the config of your proxy (e.g., if this is the "hub" server you access with /server hub, put 'hub' here)

5. Start every server again

• Provided your MySQL and Redis credentials were correct, synchronization should begin as soon as you start your servers again.
• If you need to import data from HuskSync v1.x or MySQLPlayerDataBridge, please see the guides below:
  • Legacy Migration
  • MPDB Migration