PanelAlpha Documentation
Back Home
Live Demo Get Started

cPanel

Documentation
    Introduction
Getting Started
    Installation Guide Update Guide SSL Configuration Translations
System Configuration
    General Configuration Plans Large WordPress Sites Hosting Servers DNS Servers Email Servers Remote Backups Notifications Automatic SSL Plugins & Themes Reseller Area Background Billing Diagnostic Mode Automatic Tester Snapshot Tool Server Migration
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
Billing Scenarios
    Introduction Free Trial Period
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 SFTP Accounts MySQL Databases Cron Jobs File Manager DNS Zone Editor Email Addresses Email Forwarders

# cPanel

  • Overview
  • Prerequisites
  • Configure in PanelAlpha
  • Verify the connection
  • Install the connector (WP-CLI)
  • Plan configuration
  • Troubleshooting

# Overview

PanelAlpha offers integration with cPanel, which is commonly used for shared hosting environments.

# Prerequisites

  • cPanel/WHM server reachable from PanelAlpha.
  • A cPanel user API token (generated for the username you provide in the server form).
  • Root SSH access to the server (required to install the connector).

# Configure in PanelAlpha

  • Hover over Configuration → Servers → Hosting Services → Add Server

A form will appear, fill out all the required data to successfully add the server:

  • Name - enter the server name
  • Type - select the type - choose cPanel
  • Group - choose an existing group to assign the server or create a new one from this place
  • IP/Hostname - enter the server IP address or hostname
  • Username - enter username for which the token has been generated
  • API Token - previously generated API token (opens new window)
  • 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

Important! Please refer to the cPanel official documentation to learn how to generate the API token for a user. Please read the following article (opens new window).

# Verify the connection

Use Test Connection. If the test succeeds, you can proceed.

# Install the connector (WP-CLI)

After a successful connection test, install the connector on the cPanel server:

  1. Download the connector that will be necessary to complete the installation
  2. Use the below command to unzip the package:
    unzip -u /root/PanelAlpha.zip -d /root
  3. Run the connector installation command:
    sh /root/PanelAlpha/install.sh
  4. Shortly after, you should receive a confirmation that the plugin has been installed successfully.
  5. Ensure there is at least one cPanel user on the server, as it is necessary for WP-CLI initialization.
  6. Finally, check if the integration test is successful. Press "Add Server" to complete the process.

# Plan configuration

When creating a plan, go to the Hosting step. After choosing cPanel as a server type and selecting a server group, additional configuration will appear:

  • WHM Package - the hosting package name that should be used when provisioning accounts on your cPanel/WHM server.

# Troubleshooting

If the administrator wants to allow customers to create a subdomain on another user's domain then he should enable this option: Allow cPanel users to create subdomains across accounts in cPanel → Tweak Settings. By default, when this option is disabled, cPanel does not allow the creation of subdomains between accounts and if a cPanel user tries to create a subdomain on another account, they will receive an error message.

  • Log into your WHM account and proceed to "Tweak Settings".
  • Find Allow cPanel users to create subdomains across accounts and set the value to "On".
  • Finally, press "Save" at the bottom of the page.

Please be aware that cPanel does not approve of enabling this option as it may result in serious security issues.

For more information you may refer to the cPanel documentation (opens new window).