🛠️ CyberPanel

Web Hosting Control Panel powered by OpenLiteSpeed, designed to simplify hosting management.

Current Version: 2.4 Build 4 | Last Updated: September 21, 2025

---

🔧 Features & Services

• 🔐 Different User Access Levels (via ACLs).
• 🌌 Auto SSL for secure websites.
• 💻 FTP Server for file transfers.
• 🕒 Light-weight DNS Server (PowerDNS).
• 🔐 phpMyAdmin to manage databases (MariaDB).
• 📧 Email Support (SnappyMail).
• 🕌 File Manager for quick file access.
• 🌐 PHP Management made easy.
• 🔒 Firewall (FirewallD & ConfigServer Firewall Integration).
• 📀 One-click Backups and Restores.
• 🐳 Docker Management with command execution capabilities.
• 🤖 AI-Powered Security Scanner for enhanced protection.
• 🔐 Advanced 2FA Authentication - TOTP and WebAuthn/Passkey support.
• 📊 Monthly Bandwidth Reset - Automatic bandwidth usage reset (Fixed in latest version).
• 🔗 RESTful API - Complete API for automation and integration including listChildDomainsJson endpoint.

---

🔗 RESTful API

CyberPanel provides a comprehensive RESTful API for automation and integration:

Available API Endpoints

• Website Management: Create, delete, suspend, and manage websites
• User Management: Create, delete, and manage user accounts
• Package Management: List and manage hosting packages
• Child Domains: List child domains with listChildDomainsJson endpoint
• Firewall: Add and delete firewall rules
• Backups: Manage AWS backups and remote transfers
• System Info: Get CyberPanel version and system status

API Authentication

All API endpoints require authentication using admin credentials:

curl -X POST http://your-server:8090/api/listChildDomainsJson \
  -H "Content-Type: application/json" \
  -d '{
    "adminUser": "your_admin_username",
    "adminPass": "your_admin_password"
  }'

Response Format

API responses are returned in JSON format with consistent error handling:

[
  {
    "parent_site": "example.com",
    "domain": "subdomain.example.com",
    "path": "/home/example.com/public_html/subdomain",
    "ssl": 1,
    "php_version": "8.1",
    "ip_address": "192.168.1.100"
  }
]

---

📖 Documentation & Guides

CyberPanel comes with comprehensive documentation and step-by-step guides:

• 📚 Complete Guides Index - All available documentation in one place
• 🐳 Docker Command Execution - Execute commands in Docker containers
• 🤖 AI Scanner Setup - Configure AI-powered security scanning
• 🔐 2FA Authentication Guide - Complete Two-Factor Authentication and WebAuthn setup
• 📧 Mautic Installation - Email marketing platform setup
• 🎨 Custom CSS Guide - Create custom themes for CyberPanel 2.5.5-dev

---

🔢 Supported PHP Versions

CyberPanel supports a wide range of PHP versions across different operating systems:

☑️ Currently Supported PHP Versions

• PHP 8.5 - Latest stable version (EOL: Dec 2028) ⭐ NEW!
• PHP 8.4 - Stable version (EOL: Dec 2027)
• PHP 8.3 - Default version - Stable version (EOL: Dec 2027) 🎯
• PHP 8.2 - Stable version (EOL: Dec 2026)
• PHP 8.1 - Stable version (EOL: Dec 2025)
• PHP 8.0 - Legacy support (EOL: Nov 2023)
• PHP 7.4 - Legacy support (EOL: Nov 2022)

Note: PHP versions are automatically managed by CyberPanel's PHP selector. Third-party repositories may provide additional versions beyond the default support.

🔧 Third-Party PHP Add-ons

For additional PHP versions or specific requirements, you can install third-party packages:

Ubuntu/Debian

• Ondrej's PPA: Provides PHP 5.6 to 8.5
• Sury's PPA: Alternative repository with latest PHP versions

RHEL-based Systems (AlmaLinux, RockyLinux, CentOS, RHEL)

• Remi Repository: Comprehensive PHP package collection
• EPEL Repository: Additional packages for enterprise Linux

CloudLinux

• CloudLinux PHP Selector: Built-in tool for managing multiple PHP versions
• Remi Repository: Additional PHP versions and extensions

Note: Third-party repositories may provide additional PHP versions beyond what's available in default repositories. Always verify compatibility with your specific use case.

---

🌐 Supported Operating Systems

CyberPanel runs on x86_64 architecture and supports the following Linux operating systems:

✅ Currently Supported

• Ubuntu 24.04.3 - Supported until April 2029 ⭐ NEW!
• Ubuntu 22.04 - Supported until April 2027
• Ubuntu 20.04 - Supported until April 2025
• Debian 13 - Supported until 2029 ⭐ NEW!
• Debian 12 - Supported until 2027 (Bookworm)
• Debian 11 - Supported until 2026 (Bullseye)
• AlmaLinux 10 - Supported until May 2030 ⭐ NEW!
• AlmaLinux 9 - Supported until May 2032 (Seafoam Ocelot)
• AlmaLinux 8 - Supported until May 2029 (Sapphire Caracal)
• RockyLinux 9 - Supported until May 2032
• RockyLinux 8 - Supported until May 2029
• RHEL 9 - Supported until May 2032
• RHEL 8 - Supported until May 2029
• CloudLinux 9 - Supported until May 2032 ⭐ NEW!
• CloudLinux 8 - Supported until May 2029
• CentOS Stream 9 - Supported until May 2027
• CentOS 9 - Supported until May 2027
• CentOS 7 - Supported until June 2024 ⚠️ EOL
• openEuler - Community-supported with limited testing

🔧 Installation Verification

All listed operating systems have been verified to work with the current CyberPanel installation script. The installer automatically detects your system and applies the appropriate configuration.

Verification Status: ✅ All OS listed above are confirmed to work

• Installation scripts include detection logic for all supported distributions
• Version-specific handling is implemented for each OS
• Automatic repository setup for each distribution type
• Tested and verified compatibility across all platforms

⚠️ Important Notes

• Linux Only: CyberPanel is designed specifically for Linux systems and does not support Windows
• Architecture: Requires x86_64 (64-bit) architecture
• Virtual Machines: Windows users can run CyberPanel in a Linux VM
• Docker: Alternative option for Windows users via Docker containers

Note: For unsupported operating systems, compatibility is not guaranteed. Always test in a non-production environment first.

---

⚙️ Installation Instructions

Quick Installation (Recommended)

Install CyberPanel on supported Linux distributions with a single command:

sh <(curl https://cyberpanel.net/install.sh || wget -O - https://cyberpanel.net/install.sh)

Alternative Installation Methods:

# Using wget only
wget -O - https://cyberpanel.net/install.sh | sh

# Download and run manually
wget https://cyberpanel.net/install.sh
chmod +x install.sh
sudo ./install.sh

Prerequisites

Before installation, ensure your system meets these requirements:

• Operating System: One of the supported Linux distributions listed above
• Architecture: x86_64 (64-bit)
• RAM: Minimum 1GB (2GB+ recommended)
• Storage: Minimum 10GB free space (20GB+ recommended)
• Network: Internet connection required
• Root Access: Installation requires root/sudo privileges

Installation Process

The installation script will automatically:

1. Detect your operating system and version
2. Install required dependencies (Python, Git, etc.)
3. Download and configure OpenLiteSpeed web server
4. Set up MariaDB database server
5. Install CyberPanel and configure all services
6. Create admin user with default credentials
7. Start all services and provide access information

Post-Installation

After successful installation:

1. Access CyberPanel: Open your browser to http://your-server-ip:8090
2. Default Login:
   • Username: admin
   • Password: 123456
3. Change Password: Immediately change the default password
4. Configure SSL: Set up SSL certificates for secure access

---

📊 Upgrading CyberPanel

Quick Upgrade (Recommended)

Upgrade your existing CyberPanel installation:

sh <(curl https://raw.githubusercontent.com/usmannasir/cyberpanel/stable/preUpgrade.sh || wget -O - https://raw.githubusercontent.com/usmannasir/cyberpanel/stable/preUpgrade.sh)

Alternative Upgrade Methods:

# Using wget only
wget -O - https://raw.githubusercontent.com/usmannasir/cyberpanel/stable/preUpgrade.sh | sh

# Download and run manually
wget https://raw.githubusercontent.com/usmannasir/cyberpanel/stable/preUpgrade.sh
chmod +x preUpgrade.sh
sudo ./preUpgrade.sh

Upgrade Process

The upgrade script will automatically:

1. Backup current installation to prevent data loss
2. Download latest version from the stable branch
3. Update all dependencies and requirements
4. Run database migrations to update schema
5. Restart services with new configuration
6. Verify installation and report any issues

Manual Upgrade (Advanced Users)

For manual upgrades or troubleshooting:

# Navigate to CyberPanel directory
cd /usr/local/CyberCP

# Update source code
git pull origin stable

# Update dependencies
pip3 install -r requirments.txt

# Run database migrations
python3 manage.py migrate

# Collect static files
python3 manage.py collectstatic --noinput

# Restart services
systemctl restart lscpd

⚠️ Important Upgrade Notes

• Backup First: Always backup your data before upgrading
• Test Environment: Test upgrades in a non-production environment first
• Service Restart: Some services may restart during upgrade
• Configuration: Custom configurations may need manual updates
• Security Updates: Latest version includes comprehensive security enhancements

🔧 Troubleshooting

Common Installation Issues

"Command not found" Errors

# Install missing packages
# Ubuntu/Debian
sudo apt update && sudo apt install curl wget git python3

# RHEL/CentOS/AlmaLinux/RockyLinux
sudo yum install curl wget git python3

Permission Denied Errors

# Ensure you're running as root
sudo sh <(curl https://cyberpanel.net/install.sh || wget -O - https://cyberpanel.net/install.sh)

Network Connectivity Issues

# Check internet connection
ping -c 4 google.com

# Check DNS resolution
nslookup cyberpanel.net

# Try alternative download method
wget https://cyberpanel.net/install.sh
chmod +x install.sh
sudo ./install.sh

Port Already in Use

# Check what's using port 8090
sudo netstat -tlnp | grep :8090

# Kill process if necessary
sudo kill -9 <PID>

Common Upgrade Issues

Backup Creation Failed

# Check disk space
df -h

# Free up space if necessary
sudo apt autoremove && sudo apt autoclean

Service Restart Failed

# Check service status
systemctl status lscpd

# Restart services manually
sudo systemctl restart lscpd
sudo systemctl restart lsws

Verification Commands

Check Installation Status

# Check CyberPanel service
systemctl status lscpd

# Check web interface
curl -I http://localhost:8090

# Check database
systemctl status mariadb

View Logs

# CyberPanel logs
tail -f /usr/local/lscp/logs/error.log

# System logs
journalctl -u lscpd -f

---

📚 Resources

• 🌐 Official Site
• ✏️ Docs (New)
• 🎓 Docs (Old)
• 📖 Additional Guides - Detailed guides for Docker, AI Scanner, Mautic, and more
• 📚 Local Documentation - All guides available in this repository
• 🤝 Contributing Guide - How to contribute to CyberPanel development
• ✅ Changelog
• 💬 Forums
• 📢 Discord
• 📵 Facebook Group
• 🎥 YouTube Channel

📖 Quick Start Guides

• 🐳 Docker Command Execution - Execute commands in Docker containers
• 🤖 AI Scanner Setup - Configure AI-powered security scanning
• 📧 Mautic Installation - Email marketing platform setup
• 🎨 Custom CSS Guide - Create custom themes for CyberPanel 2.5.5+
• 📚 All Guides Index - Complete documentation hub

🔗 Direct Guide Links

Category	Guide	Description
📚 All	Complete Guides Index	Browse all available guides
🔧 General	Troubleshooting Guide	Comprehensive troubleshooting
🐳 Docker	Command Execution	Execute commands in containers
🤖 Security	AI Scanner	AI-powered security scanning
📧 Email	Mautic Setup	Email marketing platform
🎨 Design	Custom CSS Guide	Create custom themes
🔥 Security	Firewall Blocking Feature	Advanced security features

---

🔧 Support & Documentation

For detailed troubleshooting, installation guides, and advanced configuration:

📚 General Guides

• 📚 Complete Guides Index - All available documentation and troubleshooting guides
• 🔧 Troubleshooting Guide - Comprehensive troubleshooting and diagnostic commands

🛠️ Feature-Specific Guides

• 🐳 Docker Command Execution Guide - Docker management and troubleshooting
• 🤖 AI Scanner Documentation - Security scanner setup and configuration
• 🔐 2FA Authentication Guide - Two-Factor Authentication and WebAuthn setup
• 📧 Mautic Installation Guide - Email marketing platform setup
• 🎨 Custom CSS Guide - Interface customization and theming
• 🔥 Firewall Blocking Feature Guide - Security features and configuration