Skip to main content
Version: 1.0.0

Getting started

info

It is recommended that you have some sort of Linux and MariaDB experience before installing this. This guide requires you to already have a working pterodactyl installation.

Dependencies​

  • PHP 8.2, 8.3 (recommended) or 8.4 with the following extensions: cli, openssl, gd, mysql, PDO, mbstring, tokenizer, bcmath, xml or dom, curl, zip, redis, intl and fpm if you are planning to use NGINX.
  • MySQL 5.7.22 or higher (MySQL 8 recommended) or MariaDB 10.2 or higher.
  • Redis (redis-server)
  • A web server (Apache, NGINX, etc.)
  • curl
  • git
  • composer

Example Dependency Installation​

If you already have Pterodactyl installed, please check that you also install PHP 8.3!

The commands below are simply an example of how you might install these dependencies. Please consult with your operating system's package manager to determine the correct packages to install.

# Add "add-apt-repository" command
apt -y install software-properties-common curl apt-transport-https ca-certificates gnupg

# Add additional repositories for PHP (Ubuntu 20.04 and Ubuntu 22.04)
LC_ALL=C.UTF-8 add-apt-repository -y ppa:ondrej/php

# Add Redis official APT repository
curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list

# MariaDB repo setup script (Ubuntu 20.04)
curl -LsS https://r.mariadb.com/downloads/mariadb_repo_setup | sudo bash

# Update repositories list
apt update

# Install Dependencies
apt -y install php8.3 php8.3-{common,cli,gd,mysql,mbstring,bcmath,xml,fpm,curl,zip} mariadb-server nginx git redis-server

If you are using redis for your system, you will want to make sure to enable that it will start on boot. You can do that by running the following command:

sudo systemctl enable --now redis-server

Extra Dependency Used on this Dashboard​

You need to install this, use the appropriate PHP version (php -v) Extra dependency used for handling currency's

apt -y install php8.3-{intl,redis}

Installing Composer​

If you already have Pterodactyl installed, you can skip this step!

Composer is a dependency manager for PHP that allows us to ship everything you'll need code wise to operate the Panel. You'll need composer installed before continuing in this process.

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

Download Files​

The first step in this process is to create the folder where the panel will live and then move ourselves into that newly created folder. Below is an example of how to perform this operation.

mkdir -p /var/www/ctrlpanel && cd /var/www/ctrlpanel
git clone -b 1.0.0 https://github.com/Ctrlpanel-gg/panel.git ./

Database Setup​

info

You will need a database setup and a database user with the correct permissions created for that database before continuing any further.

To make a database and database user, you can follow this guide. This is for MariaDB. Please change the USE_YOUR_OWN_PASSWORD part to your password. Also, 127.0.0.1 is for localhost. Please have basic knowledge of Linux before attempting this. Use at your own responsibility.

# Enter to MySQL shell
mysql -u root -p

# Enter the following SQL commands
CREATE USER 'ctrlpaneluser'@'127.0.0.1' IDENTIFIED BY 'USE_YOUR_OWN_PASSWORD';
CREATE DATABASE ctrlpanel;
GRANT ALL PRIVILEGES ON ctrlpanel.* TO 'ctrlpaneluser'@'127.0.0.1';
FLUSH PRIVILEGES;
EXIT;

Installing Сomposer Packages​

First, we will have to install all composer packages. For this, run the following command

COMPOSER_ALLOW_SUPERUSER=1 composer install --no-dev --optimize-autoloader

CtrlPanel requires a symbolic link to be created between the storage/app/public directory and the public/storage directory to properly serve uploaded files.

To create this symlink, run the following command in the root of your CtrlPanel:

php artisan storage:link

Web Server Configuration​

This is a basic NGINX configuration. Please replace any <domain> placeholders with your domain name being used. Since NGINX is being used, we will put our configuration (ctrlpanel.conf) in /etc/nginx/sites-available/, or — if on CentOS, /etc/nginx/conf.d/.

Setting up the Web Server​

Before we touch anything with NGINX, we first have to generate our SSL certificates. Make sure your domain you're using for your Ctrlpanel setup has a A record pointed at your IPv4 for your machine and is not proxied. Run the following commands to start the installation for SSL.

sudo apt update
sudo apt install certbot
sudo apt install python3-certbot-nginx

Once the installation is complete, you now need to generate the SSL certificates. To do so, run the following command below. Replace any YOUR.DOMAIN.HERE placeholders with the domain you're using for your Ctrlpanel setup.

certbot certonly --nginx -d YOUR.DOMAIN.HERE

It will save all certificates to /etc/letsencrypt/live/YOUR.DOMAIN.HERE/.

Now that SSL is ready to be used, let's setup NGINX. To do so, run the following command below to get rid of NGINX's default configuration and to avoid any other errors.

rm /etc/nginx/sites-enabled/default

Note: If you see the error that there is no such file, then most likely you have already deleted it when installing Pterodactyl

Once done, we now have to open the NGINX configuration file. This depends on your OS.

Debian/Ubuntu Based OSes:

nano /etc/nginx/sites-available/ctrlpanel.conf

RHEL, CentOS, Rocky Linux, or AlmaLinux based OSes:

nano /etc/nginx/conf.d/ctrlpanel.conf

There, you want to paste in the configuration which is stated below. Be sure to change any YOUR.DOMAIN.HERE placeholders with your Ctrlpanel setup.

server {
    # Replace YOUR.DOMAIN.HERE with your domain.
    listen 80;
    server_name YOUR.DOMAIN.HERE;
    return 301 https://$server_name$request_uri;
}

server {
    # Replace YOUR.DOMAIN.HERE with your domain.
    listen 443 ssl http2;
    server_name YOUR.DOMAIN.HERE;

    root /var/www/ctrlpanel/public;
    index index.php;

    access_log /var/log/nginx/ctrlpanel.app-access.log;
    error_log  /var/log/nginx/ctrlpanel.app-error.log error;

    # Allow large upload sizes
    client_max_body_size 100m;
    client_body_timeout 120s;

    sendfile off;

    # SSL Configuration - Replace any YOUR.DOMAIN.HERE with the domain you're using for your Ctrlpanel setup.
    ssl_certificate /etc/letsencrypt/live/YOUR.DOMAIN.HERE/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/YOUR.DOMAIN.HERE/privkey.pem;
    ssl_session_cache shared:SSL:10m;
    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384";
    ssl_prefer_server_ciphers on;

    # See https://hstspreload.org/ before uncommenting the line below.
    # add_header Strict-Transport-Security "max-age=15768000; preload;";
    add_header X-Content-Type-Options nosniff;
    add_header X-XSS-Protection "1; mode=block";
    add_header X-Robots-Tag none;
    add_header Content-Security-Policy "frame-ancestors 'self'";
    add_header X-Frame-Options DENY;
    add_header Referrer-Policy same-origin;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ \.php$ {
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        fastcgi_pass unix:/run/php/php8.3-fpm.sock;
        fastcgi_index index.php;
        include fastcgi_params;
        fastcgi_param PHP_VALUE "upload_max_filesize = 100M \n post_max_size=100M";
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        fastcgi_param HTTP_PROXY "";
        fastcgi_intercept_errors off;
        fastcgi_buffer_size 16k;
        fastcgi_buffers 4 16k;
        fastcgi_connect_timeout 300;
        fastcgi_send_timeout 300;
        fastcgi_read_timeout 300;
        include /etc/nginx/fastcgi_params;
    }

    location ~ /\.ht {
        deny all;
    }
}

Enable Configuration

The last step is to enable the NGINX configuration. To do that, we have to restart it.

# You do not need to symlink this file if you are using CentOS.
sudo ln -s /etc/nginx/sites-available/ctrlpanel.conf /etc/nginx/sites-enabled/ctrlpanel.conf

# Check for nginx errors
sudo nginx -t

# You need to restart nginx regardless of OS. only do this you haven't received any errors
systemctl restart nginx

Set Permissions​

The last step in the installation process is to set the correct permissions on the Panel files so that the web server can use them correctly.

# If using NGINX or Apache (not on CentOS):
chown -R www-data:www-data /var/www/ctrlpanel/
chmod -R 755 storage/* bootstrap/cache/

# If using NGINX on CentOS:
chown -R nginx:nginx /var/www/ctrlpanel/
chmod -R 755 storage/* bootstrap/cache/

# If using Apache on CentOS
chown -R apache:apache /var/www/ctrlpanel/
chmod -R 755 storage/* bootstrap/cache/

****

Once this is done, you should be able to access the dashboard via your web browser.

Queue Listeners​

Crontab Configuration​

The first thing we need to do is create a new cron job that runs every minute to process specific Dashboard tasks such as billing users hourly and suspending unpaid servers. To setup crontab, we first have to open it. To do so, run the following command:

crontab -e

If it prompts you for a file editor, choose number 1. Once It's opened, go to a line that doesn't have a # in front of it. Then paste in this:

* * * * * php /var/www/ctrlpanel/artisan schedule:run >> /dev/null 2>&1

Create Queue Worker​

Next, you need to create a new systemd worker to keep our queue process running in the background. This queue is responsible for sending emails and handling many other background tasks for the Dashboard.

Create a file called ctrlpanel.service in /etc/systemd/system with the contents below.

# Ctrlpanel Queue Worker File
# ----------------------------------

[Unit]
Description=Ctrlpanel Queue Worker

[Service]
# On some systems the user and group might be different.
# Some systems use `apache` or `nginx` as the user and group.
User=www-data
Group=www-data
Restart=always
ExecStart=/usr/bin/php /var/www/ctrlpanel/artisan queue:work --sleep=3 --tries=3
StartLimitBurst=0

[Install]
WantedBy=multi-user.target

Finally, enable the service and set it to boot on machine start.

sudo systemctl enable --now ctrlpanel.service

To begin installation, go to https://YOUR_DOMAIN_HERE.com/installer and follow the installer instructions.

If you encounter problems with the email setup, you can skip it and set it up later.

Once the installer has been completed, you will be redirected to the login page. Sign in with your Pterodactyl username/email and the password you set during the installer.