Installation

Windows

Easy installation

1. Install the prerequisites. check Building.
2. Clone the Hercules repository using a git client, into a new folder.
   • If you do not want to use the command line, you can instead clone with GitHub Desktop.
3. Run mariadb.bat to automatically install and configure MariaDB.
4. Build Hercules. check Building.

Manual installation

1. Install the prerequisites. check Building.
2. Install a MySQL-compatible server, such as MariaDB (recommended) or MySQL Community Edition
3. Clone the Hercules repository Hercules repository using a git client, into a new folder.
4. Connect to the MySQL server as root:
   • Create a database (hercules): CREATE DATABASE hercules;
   • Create a user (hercules): CREATE USER 'hercules'@'localhost' IDENTIFIED BY 'password';.
   • Give permissions (GRANT SELECT,INSERT,UPDATE,DELETE) to the user: GRANT SELECT,INSERT,UPDATE,DELETE ON hercules.* TO 'hercules'@'localhost';
5. Connect to the MySQL server as the new user:
   • Import the .sql files in /sql-files/ into the new database.
6. Build Hercules. check Building.

Unix

1. Install the prerequisites through your distribution's package manager. check Building.
2. Clone the Hercules repository git clone https://github.com/HerculesWS/Hercules.git ~/Hercules
3. Configure the MySQL server and start it.
4. Connect to the MySQL server as root:
   • Create a database (hercules): CREATE DATABASE hercules;
   • Create a user (hercules): CREATE USER 'hercules'@'localhost' IDENTIFIED BY 'password';.
   • Give permissions (GRANT SELECT,INSERT,UPDATE,DELETE) to the user: GRANT SELECT,INSERT,UPDATE,DELETE ON hercules.* TO 'hercules'@'localhost';
5. Connect to the MySQL server as the new user:
   • Import the .sql files in /sql-files/ into the new database.
6. Build Hercules. check Building.