Skip to main content

Installation Guide

MythicalDash is a powerful web-based control panel designed to run on your own server. This guide will walk you through the complete installation process. Please note that root access to your server is required to install and operate this panel.

Before proceeding, we strongly recommend reading through this entire guide to ensure a smooth installation process. Taking the time to understand each step will help prevent common installation issues.

Prerequisites

Installing Composer

Composer is PHP's dependency manager, essential for managing the panel's PHP packages:

curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer

Installing Yarn

Yarn manages Node.js dependencies for the frontend components:

npm i -g yarn

Initial Setup

Downloading and Extracting Files

Create the installation directory and download the latest release:

mkdir -p /var/www/mythicaldash-v3
cd /var/www/mythicaldash-v3
curl -Lo MythicalDash.zip https://github.com/MythicalLTD/MythicalDash/releases/latest/download/MythicalDash.zip
unzip -o MythicalDash.zip -d /var/www/mythicaldash-v3

Set appropriate permissions for the application directories:

chown -R www-data:www-data /var/www/mythicaldash-v3/*

Installing Dependencies

Install all required dependencies:

cd /var/www/mythicaldash-v3
make install

Database Configuration

MariaDB Character Set Configuration

Configure MariaDB with the correct character set settings:

sudo sed -i '/^#collation-server/a collation-server = utf8mb4_general_ci' /etc/mysql/mariadb.conf.d/50-server.cnf
sudo sed -i '/^character-set-server/s/^/#/g' /etc/mysql/mariadb.conf.d/50-server.cnf
sudo sed -i '/^#character-set-server/a character-set-server = utf8mb4' /etc/mysql/mariadb.conf.d/50-server.cnf

sudo sed -i '/^character-set-collations/s/^/#/g' /etc/mysql/mariadb.conf.d/50-server.cnf
sudo sed -i '/^#character-set-collations/a character-set-collations = utf8mb4' /etc/mysql/mariadb.conf.d/50-server.cnf

Creating Database and User

Set up the database and create a user with appropriate permissions:

mariadb -u root -p
CREATE USER 'mythicaldash_remastered'@'127.0.0.1' IDENTIFIED BY 'yourPassword';
CREATE DATABASE mythicaldash_remastered;
GRANT ALL PRIVILEGES ON mythicaldash_remastered.* TO 'mythicaldash_remastered'@'127.0.0.1' WITH GRANT OPTION;
exit

Application Build and Configuration

Building the Application

Build the application to ensure all dependencies are properly installed:

# Set your app into production (Disables DEBUG LOGS)!
make set-prod
# Build frontend and lint!
make release

Cron Job Configuration

Configure the required cron jobs for background processing and queue management:

* * * * * bash /var/www/mythicaldash-v3/backend/storage/cron/runner.bash >> /dev/null 2>&1
* * * * * php /var/www/mythicaldash-v3/backend/storage/cron/runner.php >> /dev/null 2>&1

Database Connection Setup

Configure the database connection settings:

php mythicaldash setup

Running Database Migrations

Apply the database migrations to set up the required tables and structure:

php mythicaldash migrate

Configuring Pterodactyl Connection

Configure the connection to your Pterodactyl panel:

php mythicaldash pterodactyl configure

License Activation

MythicalDash V3-Remastered requires a license to operate. Get a free one-year license at: https://mymythicalid.mythical.systems

After obtaining your license key, run:

php mythicaldash init

Enter your license key and instance URL when prompted. Successful activation includes:

  • MythicalCloud: 1GB cloud backup storage
  • MythicalZeroTrust: Abuse prevention (5 actions/day)
  • MythicalLogs: Enhanced debugging
  • MythicalData: Performance optimization analytics

Premium licenses (€5/month) offer additional features and higher limits.