Installation

The installation process is pretty basic and straight forward.

Downloading

Firstly, you need to download ShadowsDash at the GitHub releases page: https://github.com/shadowsdash/shadowsdash/releases, and download the latest version available.

Installing

To install, all you have to do is to unzip the zip file that you just downloaded from the release page and upload it to your virtual host public directory. Once all files are moved, navigate to the "require" directory and rename config.sample.php to config.php. Then, edit config.php to match your needs, and your branding.

MySQL database

First, create a database. The name can be whatever you want, you'll just have to change the config.php file to match your database. Once your database is created, you need to import the "datastructure.sql" file in the "require" folder. Once it's imported, you can delete that file. You can use either PHPMyAdmin or the cli. Once this is done, check again if the information provided in config.php is right.

Setting up cron jobs

Setting up cron jobs will be really important; this is not an optional step: the cron jobs will allow the dashboard to process data internally, and manage the queue system. First, check if crontab is installed by typing "cron" in your terminal. Or, if you are using a hosting service, check if your host supports crontab. If you are on a terminal, run:

cron -e
# A new text editor instance should start. Add the following text to the bottom of it.
*/2 * * * * php /<path to shadowsdash>/scripts/queueHandler.php >/dev/null 2>&1
# The path should not be relative.