Setup

Before Installing the Plugin

Make sure you downloaded the plugin from here. Also we recommend you to check the Settings Guide so you can understand the Settings file you're going to customize.

Single Server Setup

This setup is not recommended but you can use SuperAuth in a single server.

1. Make sure your server is stopped
2. Copy the downladed file inside the plugins folder. (If you are using a server hosting panel you should see an option to connect through FTP or similar. You need to upload the plugin to the plugins folder.)
3. Start the server, this will generate the intial settings file that you need to configure. (If you plan to use MySQL fill in the credentials in the Settings.yml file. If you're going to use SQLite, you can just skip this step.)
4. Now restart your server so the plugin can generate the remaining files.
5. Now that the AuthSettings.yml file was generated you can customize it.

If you plan to let your users access to the My Account GUI you can follow this guide to install the plugin, just make sure that you have the option AuthEnabled in false, otherwise your users will be requested to login.

Network Setup

If you own a network we recommend you to have 1 server dedicated to the authentication of your users.

1. Stop your bungeecord instance
2. Copy the downladed file inside the plugins folder. (If you are using a server hosting panel you should see an option to connect through FTP or similar. You need to upload the plugin to the plugins folder.)
3. Start the server, this will generate the intial settings file.
4. Fill in the MySQL credentials in your Settings.yml file. (Since this is a network setup you are required to use MySQL) You will need to customize your Settings.yml file.
5. Now to install the plugin in your auth server and other servers folllow the steps in Single Server Setup.

Argon2 Setup

*NOT AVAILABLE YET*

macOS/Linux Setup (With Homebrew)

1. Install brew.sh
2. Install the argon2 formula. (You can also use this command: brew update && brew install argon2)

Unix and Windows Setup (Git and CMAKE)

We assume that you have installed CMAKE.

• For Unix: We recommend you to install it through Homebrew with the formula cmake
• For Windows: We recommend you to install MINGW and Git Bash

Execute the following commands to compile with cmake:

git clone https://www.github.com/P-H-C/phc-winner-argon2.git argon2-src;
cd argon2-src && sudo make && sudo make install;

In windows, the commands should be executed in a git bash window with administrator privileges.

Arch Linux Setup (Pacman)

Execute the following command to install argon2:

pacman -S argon2

Debian Based Setup (apt)

Execute the following commands to install argon2:

apt install libargon2-0-dev
ln -s /usr/lib/x86_64-linux-gnu/libargon2.so /usr/lib/libargon2.so

NixOS Setup (nix-env)

Execute the following command to install argon2:

nix-env -iA nixos.libargon2

OpenSUSE Setup (zypper)

Execute the following command to install argon2:

zypper install argon2-devel

If your system is not listed here, please open a new issue or join our discord for a faster response