CCPanel
Reseller & API
REST API WHMCS Module
Home Documentation

CCPanel Documentation v2.0

Welcome to the official CCPanel documentation. This guide covers installation, license activation, and API usage.

System Requirements

Before installing CCPanel, make sure your server meets the following requirements.

Supported Operating Systems

Ubuntu Ubuntu
18.04 LTS20.04 LTS22.04 LTS24.04 LTS26.04 LTS
Debian Debian
8910111213
AlmaLinux AlmaLinux
8910
Rocky Linux Rocky Linux
8910
CentOS CentOS
78
RHEL RHEL
78
CloudLinux CloudLinux
89
Scientific Linux Scientific Linux
78

Minimum Hardware

CPU
1 vCPU minimum
2+ vCPU recommended
RAM
1 GB minimum
2 GB recommended
Disk
20 GB minimum
SSD preferred
Network
1 Mbps+
Static IP required
Root access required
Clean server — no existing Apache/Nginx/MySQL

Installation

Download and run the installer as root on a fresh server:

wget -O ccpanel-install.sh https://install.ccpanel.net/latest
bash ccpanel-install.sh

The installer will detect your OS and configure everything automatically. Installation typically takes 5–10 minutes. Once complete, you'll see your panel URL and login credentials.

CCPanel installed successfully!
Panel URL: https://your-server-ip:2083
Username: admin
Password: generated-password

License Activation VPS / Dedicated

Once the installer finishes, CCPanel runs in an unlicensed trial mode for 24 hours. Activate it with your license key before that window ends. Follow the steps in order — skipping server prep is the most common reason activation fails.

Step 1 — Update your server first

Always update OS packages before activating. An outdated kernel or missing library is the #1 cause of activation failures.

# Ubuntu / Debian
sudo apt update && sudo apt upgrade -y

# AlmaLinux / CentOS / RHEL
sudo dnf update -y

If the update installed a new kernel, reboot once before continuing:

sudo reboot

Step 2 — Check required ports are open

If you're behind a cloud firewall (AWS, DigitalOcean, etc.), open these ports before activating:

# UFW (Ubuntu)
sudo ufw allow 80,443,2083,2087/tcp
sudo ufw reload

# firewalld (AlmaLinux/CentOS)
sudo firewall-cmd --add-port=80/tcp --add-port=443/tcp --add-port=2083/tcp --add-port=2087/tcp --permanent
sudo firewall-cmd --reload

Step 3 — Confirm hostname & server clock

hostname -f
timedatectl

If the clock is off by more than a couple of minutes, sync it — incorrect system time causes license signature failures:

sudo timedatectl set-ntp true

Step 4 — Activate your license

Get your license key from my.dhakaitclub.com → Services → CCPanel, then run:

sudo ccpanel license --activate YOUR_LICENSE_KEY
License activated successfully!
Plan: Professional
Bound IP: 203.0.113.42
Expires: 2027-06-24
Status: ACTIVE

Check status anytime:

sudo ccpanel license --status

Step 5 — Moving to a new server?

Release the license on the old server first:

sudo ccpanel license --release

Then run --activate on the new server.

Common activation errors
"Connection timed out" — outbound port 443 to license.ccpanel.net is blocked. Check Step 2.
"Signature mismatch" — server clock is wrong. Check Step 3.
"License already in use" — release from old server (Step 5) or contact support to force-release.

Quick Start Guide

After installation and activation, follow these steps to get your first website running:

  1. Log in to your panel at https://your-ip:2083
  2. Add your domain under Domains → Add Domain
  3. Point your domain's DNS A record to your server IP
  4. Enable SSL under SSL → Issue Certificate
  5. Install WordPress or your app via Apps → App Installer

REST API

CCPanel provides a full REST API to automate account and server management. All API calls require authentication via an API token generated from Settings → API Keys in your panel.

# Create a new hosting account
POST /api/v1/accounts
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

{
  "username": "client1",
  "password": "secure123",
  "email": "client@example.com",
  "domain": "example.com",
  "plan": "professional"
}

WHMCS Module

The CCPanel WHMCS module enables automatic provisioning, suspension, and termination of hosting accounts when orders are placed in WHMCS.

  1. Download the module from your CCPanel dashboard under Reseller → WHMCS Module
  2. Upload to /modules/servers/ in your WHMCS directory
  3. Go to Setup → Products → Servers and add your CCPanel server
  4. Enter your panel URL and API token, then click Test Connection
Need help?
Can't find what you're looking for? Contact our support team →