PanelAlpha Documentation
Back Home
Live Demo Get Started

PanelAlpha Engine

Documentation
    Introduction
Getting Started
    Installation Guide Update Guide SSL Configuration Translations
System Configuration
    General Configuration Plans Hosting Servers DNS Servers Email Servers Remote Backups Notifications Automatic SSL Plugins & Themes Background Billing Diagnostic Mode Automatic Tester
Admin Area
    Dashboard Instances Services Users Logs Migrations
Onboarding Methods
    Quick Onboarding Super Quick Onboarding Standard Onboarding
Hosting Servers
    Hosting Scenarios PanelAlpha Engine cPanel Plesk DirectAdmin WP Cloud
DNS Servers
    Cloudflare cPanel DNS Only PowerDNS
Email Servers
    Mailcow cPanel
Billing Systems Integrations
    PanelAlpha WordPress Hosting For WHMCS
Integrations
    Atarim AWStats Matomo Google Analytics Let's Encrypt Google PageSpeed Insights DB-IP Extendify WithoutDNS
Client Area - Instances
    List of Instances Creating New Instance Importing Existing Instance Instance Details Changing Domain Sharing Instances Monitoring Backups Plugins Advanced Settings
Client Area - Hosting
    Summary Domains FTP Accounts MySQL Databases Cron Jobs File Manager DNS Zone Editor Email Addresses Email Forwarders

# PanelAlpha Engine

  • Architecture
  • System Requirements
  • Download and Install
  • Update Process
    • Before You Update
    • Update Steps
  • Server Configuration in PanelAlpha
  • Redis Cache Configuration
  • Next Steps
  • Troubleshooting

This engine has been designed to handle “webhosting service” as a separate docker container on a server. This way each customer’s data is separated and can scale up depending on the needs. The solution also works well for individual customers who are having too large instances to have them on a shared hosting server.

Please note: this setup is now in BETA phase so need to be cautiously implemented on live environments and is recommended only for companies that are familiar with Docker.

# Architecture

Presented below is an illustrative diagram showcasing the architecture of PanelAlpha engine. Explore how the engine is structured and the relationships established between containers.

# System Requirements

To successfully install PanelAlpha Engine, your server must meet all of the requirements listed below:

  • RAM: 4GB minimum
  • Operating System:
    • Debian 12 "bookworm" or
    • Ubuntu 22.04.4 LTS (Jammy Jellyfish)
  • SSH Connection with root access
  • Open ports:
    • Ports 80, 443 for website access
    • Port 2011 needs to be accessible from PanelAlpha
    • Port 21 and ports 30000-30009 for FTP access

Important!
The PanelAlpha Engine must be installed on a separate server, meeting the above requirements. Installing both PanelAlpha and PanelAlpha Engine on the same server will cause the installations to be non-functional. ## Before You Begin

  1. IMPORTANT - Ensure that your server meets all the system requirements listed above.
  2. IMPORTANT - Make sure you have root access to your server via SSH.
  3. Have your PanelAlpha license key ready. It can be found in your client area under Licenses (opens new window), in the product details.
  4. Ensure your server has internet connectivity to download the installation files.

# Download and Install

The installation process is described in detail in the Wizard itself, but you can also refer to this tutorial for additional details.

  1. Log in to your server via SSH as root:

    ssh root@your-server-ip

  2. Download the installer:

    wget -N -P /opt/panelalpha https://license.panelalpha.com/engine-installer.sh

  3. Run the installation script with your license key:

    bash /opt/panelalpha/engine-installer.sh --key 'YOUR_LICENSE_KEY'

    Important: Replace YOUR_LICENSE_KEY with your actual license key from the client area.

  4. Wait for the installation to complete and copy the API Key from the PanelAlpha Engine Installer output.

  5. Save the API Key - You will need to paste this API Key in the third step while using the Wizard to install your PanelAlpha platform.

# Update Process

With every new release of the PanelAlpha application, please verify if any changes are introduced to the engine itself. If yes, a manual update will be required. You can find adequate information in the latest PanelAlpha release changelog.

# Before You Update

  1. IMPORTANT - Create a complete backup of your server and data before starting the update process.
  2. IMPORTANT - Check the changelog to verify compatibility and review any breaking changes.
  3. Ensure you have your PanelAlpha license key ready.

# Update Steps

Follow these steps to update the engine:

  1. Access your server via SSH with root privileges:

    ssh root@your-server-ip

  2. Download the updater:

    wget -N -P /opt/panelalpha https://license.panelalpha.com/engine-updater.sh

  3. Execute the update script:

    bash /opt/panelalpha/engine-updater.sh --key 'YOUR_LICENSE_KEY'

    Important: Replace YOUR_LICENSE_KEY with your actual license key from the client area.

You will also need this data if you decide to add PanelAlpha server type later on, directly in the PanelAlpha Engine platform during further configuration. Proceed to the next step, 'Server Configuration in PanelAlpha,' where you will use the data you've just generated.

# Server Configuration in PanelAlpha

Navigate to Configuration → Servers → Hosting Services. You will see a list of already installed servers, if there are any. You may add a new server from this point by following the steps below.

Press the 'Add Server' button, and a new form will appear. Fill out all the required data to successfully add the new server:

  • Name - Enter the server name
  • Type - Select "PanelAlpha" engine
  • Group - Choose an existing group to assign the server or create a new one
  • IP/Hostname - Enter the same IP/Hostname as you used during the installation process
  • API Token - Previously generated API Key from the installation step
  • SSL Verification - Select if you want to connect via SSL
  • Onboarding Domain (Optional) - If a domain is entered here, it will be used for instance creation instead of the domain specified in the plan configuration with the Quick or Superquick onboarding method selected. This is useful when multiple servers are assigned to a single group in Hosting Servers.
  • Test Connection - Check if connection is successful

Your PanelAlpha Engine is now ready to use. You may set it up as a Hosting Server type for your prepared Plans.

# Redis Cache Configuration

  • Redis server is automatically installed with each PanelAlpha Engine service as part of the default configuration
  • Navigate to the Plan Configuration section at: Admin Area → Configuration → Plans → Plan details → Hosting → Enable Redis Cache to enable Redis caching.
  • Upon enabling this option, the Redis Object Caching (opens new window) plugin will be automatically installed and configured for WordPress instances.

# Next Steps

After completing the installation and configuration:

  1. Test the setup - Create a test instance to verify everything is working correctly
  2. Configure plans - Set up your hosting plans to use the PanelAlpha Engine server
  3. Monitor performance - Keep an eye on server resources and container performance
  4. Review security - Ensure proper firewall and security configurations are in place

# Troubleshooting

If you encounter any issues with PanelAlpha Engine installation, configuration, or operation, please refer to our comprehensive PanelAlpha Engine Troubleshooting Guide for detailed solutions and common problem resolutions.