Setup Guide

This guide covers setting up FluxCP for a single Hercules server. For details on multiple servers setup please refer to [Multiple Servers Guide].

---

Setting up FluxCP is a five step process:

0. Make sure you meet requirements

1. Setup a Hercules MySQL database & user

FluxCP is a account control panel for Hercules server, so it needs a Hercules database. If your Hercules server is already running, most likely you can just proceed to next step.

Note: For the sake of readability, further in this guide word server will mean (installed) Hercules server.

To setup a Hercules database:
* create a new MySQL database
* import main.sql, logs.sql, item_db_re.sql, item_db2_re.sql, mob_db_re.sql, mob_db2.sql, mob_skill_db_re.sql, mob_skill_db2.sql scripts from sql-files directory of your server into the newly created database (for pre-Renewal server setup replace all *_re.sql scripts with their non-RE counterparts)

Finally, create a MySQL user that you will use in FluxCP to access server database.

2. Download FluxCP

3. Configure FluxCP

At this point you need to setup several configuration setting. Edit following files and fill in the values.

config/application.php

• ServerAddress - hostname:port under which FluxCP runs (e.g. example.com or example.com:80)
• BaseURI - base web root on which FluxCP lies (e.g. /fluxcp means it can be found at ServerAddress/fluxcp)
• InstallerPassword - installer & updater password, will be required in next step and for future updates; change it now

config/servers.php

• ServerName - name of your server
• DbConfig - setup Hostname, Username, Password and Database settings (this is the database and user from step 1)
• repeat for LogsDbConfig
• in CharMapServers:
• another ServerName - usually it will be just the name of your server again; if you have more than one server running (e.g. low-rate and high-rate) read [Multiple Servers Guide] before proceeding to next step
• Renewal - set to true if you use RE item & mob databases, or false if you use pre-RE ones

This concludes the minimal configuration setup that lets you proceed with FluxCP installer. For detailed configuration see [Configuration Guide].

4. Run FluxCP installer

Go to your FluxCP address in web browser. Enter your installer password.

Next page outlines the status of all extra database tables required by FluxCP. Click "Install or Update Everything" near the top of the page. Installer will create all necessary tables and redirect you to main page of FluxCP.

Congratulations, your FluxCP is now installed!

You can now proceed to detailed configuration.