mirror
/
cyberpanel
mirror of https://github.com/usmannasir/cyberpanel.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md for v2.4.4 

- Redesigned README with a modern, centered landing-page style  
- Reduced and refined emoji usage for a more professional look  
- Highlighted key features, supported platforms, and PHP versions  
- Added quick install and upgrade commands with better readability  
- Updated links to docs, forum, Discord, and tutorials  
- Removed discontinued OS references and improved structure
This commit is contained in:
Aadi Sachan 2025-09-23 23:46:24 +05:30 committed by GitHub
parent 4ae179effc
commit ffb826d08f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 102 additions and 357 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

459
README.md
View File

@ -1,78 +1,93 @@
<div align="center">
<img src="https://community.cyberpanel.net/uploads/default/original/1X/416fdec0e96357d11f7b2756166c61b1aeca5939.png" alt="CyberPanel Logo" width="500"/>
<img src="https://community.cyberpanel.net/uploads/default/original/1X/416fdec0e96357d11f7b2756166c61b1aeca5939.png" alt="CyberPanel Logo" width="480"/>
# 🛠️ CyberPanel
# CyberPanel
Web Hosting Control Panel powered by OpenLiteSpeed, designed to simplify hosting management.
**Web Hosting Control Panel powered by OpenLiteSpeed**
Fast • Secure • Scalable — Simplify hosting management with style.
> **Current Version**: 2.4 Build 4 | **Last Updated**: September 21, 2025
**Version**: 2.4.5 • **Updated**: September 23, 2025
[![GitHub](https://img.shields.io/badge/GitHub-Repository-blue?style=flat-square&logo=github)](https://github.com/usmannasir/cyberpanel)
[![Discord](https://img.shields.io/badge/Discord-Join%20Chat-7289DA?style=flat-square&logo=discord)](https://discord.gg/g8k8Db3)
[![Facebook](https://img.shields.io/badge/Facebook-Community-1877F2?style=flat-square&logo=facebook)](https://www.facebook.com/groups/cyberpanel)
[![YouTube](https://img.shields.io/badge/YouTube-Channel-FF0000?style=flat-square&logo=youtube)](https://www.youtube.com/@Cyber-Panel)
[![Documentation](https://img.shields.io/badge/Documentation-Read%20Now-green?style=flat-square&logo=gitbook)](https://cyberpanel.net/KnowledgeBase/)
[![GitHub](https://img.shields.io/badge/GitHub-Repo-000?style=flat-square\&logo=github)](https://github.com/usmannasir/cyberpanel)
[![Docs](https://img.shields.io/badge/Docs-Read-green?style=flat-square\&logo=gitbook)](https://cyberpanel.net/KnowledgeBase/)
[![Forum](https://img.shields.io/badge/Forum-Join-FF6F00?style=flat-square\&logo=discourse\&logoColor=white)](https://community.cyberpanel.net)
[![Discord](https://img.shields.io/badge/Discord-Chat-5865F2?style=flat-square\&logo=discord\&logoColor=white)](https://discord.gg/g8k8Db3)
[![YouTube](https://img.shields.io/badge/YouTube-Learn-FF0000?style=flat-square\&logo=youtube)](https://www.youtube.com/@Cyber-Panel)
---
## 🔧 Features & Services
</div>
- 🔐 **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.
## Key highlights
* ⚡ **Performance first** — OpenLiteSpeed + HTTP/3 + LSCache
* 🔒 **Security by default** — Auto SSL, FirewallD integration, 2FA, brute-force protection
* 📧 **Integrated mail** — Postfix, Dovecot, SnappyMail
* 🗂 **Backups & restore** — One-click snapshots and rollbacks
* 👨‍💻 **Developer friendly** — Git manager, REST API, staging, PHP version switcher
---
## 🔗 **RESTful API**
## Features
CyberPanel provides a comprehensive RESTful API for automation and integration:
**Security**
### **Available API Endpoints**
* Auto SSL (Let's Encrypt)
* Firewall integrations (FirewallD, optional CSF export)
* 2FA (TOTP + WebAuthn/Passkey)
* AI-powered security scanner (optional)
- **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
**Hosting & Websites**
### **API Authentication**
* OpenLiteSpeed (HTTP/3, QUIC)
* One-click WordPress (LSCache-ready)
* PHP per-site version selector
* File manager, FTP, SFTP
All API endpoints require authentication using admin credentials:
**Email & DNS**
* Postfix + Dovecot
* SnappyMail webmail
* DNS (PowerDNS) with easy zone management
**Developer & Automation**
* RESTful API (create/list/manage sites, users, packages)
* Git integration & staging
* Docker command execution support
**Backups & Storage**
* Local snapshots, remote backups (S3/AWS compatible)
* One-click restore and scheduled backups
---
## RESTful API (quick)
Simple JSON API for automation and integration. Common endpoints:
* `listChildDomainsJson` — list child domains
* Website/user/package management endpoints
* Firewall and backup control
**Example:**
```bash
curl -X POST http://your-server:8090/api/listChildDomainsJson \
-H "Content-Type: application/json" \
-d '{
"adminUser": "your_admin_username",
"adminPass": "your_admin_password"
}'
-d '{"adminUser":"your_admin","adminPass":"your_pass"}'
```
### **Response Format**
API responses are returned in JSON format with consistent error handling:
**Sample response:**
```json
[
{
"parent_site": "example.com",
"domain": "subdomain.example.com",
"path": "/home/example.com/public_html/subdomain",
"domain": "sub.example.com",
"path": "/home/example.com/public_html/sub",
"ssl": 1,
"php_version": "8.1",
"ip_address": "192.168.1.100"
@ -80,367 +95,97 @@ API responses are returned in JSON format with consistent error handling:
]
```
---
## 📖 **Documentation & Guides**
CyberPanel comes with comprehensive documentation and step-by-step guides:
- 📚 **[Complete Guides Index](guides/INDEX.md)** - All available documentation in one place
- 🐳 **[Docker Command Execution](guides/Docker_Command_Execution_Guide.md)** - Execute commands in Docker containers
- 🤖 **[AI Scanner Setup](guides/AIScannerDocs.md)** - Configure AI-powered security scanning
- 🔐 **[2FA Authentication Guide](guides/2FA_AUTHENTICATION_GUIDE.md)** - Complete Two-Factor Authentication and WebAuthn setup
- 📧 **[Mautic Installation](guides/MAUTIC_INSTALLATION_GUIDE.md)** - Email marketing platform setup
- 🎨 **[Custom CSS Guide](guides/CUSTOM_CSS_GUIDE.md)** - Create custom themes for CyberPanel 2.5.5-dev
> Full API docs and auth details: `guides/API.md` (link in Resources)
---
## 🔢 Supported PHP Versions
## Supported platforms (condensed)
CyberPanel supports a wide range of PHP versions across different operating systems:
| OS family | Recommended / Supported |
| -------------------------- | ----------------------: |
| Ubuntu 24.04, 22.04, 20.04 | ✅ Recommended |
| Debian 13, 12, 11 | ✅ Supported |
| AlmaLinux 10, 9, 8 | ✅ Supported |
| RockyLinux 9, 8 | ✅ Supported |
| RHEL 9, 8 | ✅ Supported |
| CloudLinux 9, 8 | ✅ Supported |
| CentOS 7 | ⚠️ Legacy — EOL |
### ☑️ **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.
> CyberPanel targets x86\_64 only. Test unsupported OS in staging first.
---
## 🌐 Supported Operating Systems
## PHP support (short)
CyberPanel runs on x86_64 architecture and supports the following **Linux** operating systems:
* ✅ **Recommended**: PHP 8.5, 8.4, 8.3, 8.2, 8.1
* ⚠️ **Legacy**: PHP 8.0, PHP 7.4 (security-only)
### **✅ 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.
Third-party repositories (Remi, Ondrej) may provide older or niche versions — verify compatibility before use.
---
## ⚙️ Installation Instructions
### **Quick Installation (Recommended)**
Install CyberPanel on supported Linux distributions with a single command:
## Quick install
```bash
sh <(curl https://cyberpanel.net/install.sh || wget -O - https://cyberpanel.net/install.sh)
sh <(curl -s https://cyberpanel.net/install.sh || wget -O - https://cyberpanel.net/install.sh)
```
**Alternative Installation Methods:**
```bash
# 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
➡️ See `guides/INSTALLATION.md` for platform-specific options and non-interactive installs.
---
## 📊 Upgrading CyberPanel
### **Quick Upgrade (Recommended)**
Upgrade your existing CyberPanel installation:
## Upgrade (recommended)
```bash
sh <(curl https://raw.githubusercontent.com/usmannasir/cyberpanel/stable/preUpgrade.sh || wget -O - https://raw.githubusercontent.com/usmannasir/cyberpanel/stable/preUpgrade.sh)
sh <(curl -s https://raw.githubusercontent.com/usmannasir/cyberpanel/stable/preUpgrade.sh || wget -O - https://raw.githubusercontent.com/usmannasir/cyberpanel/stable/preUpgrade.sh)
```
**Alternative Upgrade Methods:**
```bash
# Using wget only
wget -O - https://raw.githubusercontent.com/usmannasir/cyberpanel/stable/preUpgrade.sh | sh
**Post-upgrade checklist:** verify email, DNS, SSL and run a smoke test on key sites.
# Download and run manually
wget https://raw.githubusercontent.com/usmannasir/cyberpanel/stable/preUpgrade.sh
chmod +x preUpgrade.sh
sudo ./preUpgrade.sh
```
---
### **Upgrade Process**
## Troubleshooting (common)
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:
**Command not found** — install curl/wget/git/python3
```bash
# 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**
```bash
# Install missing packages
# Ubuntu/Debian
sudo apt update && sudo apt install curl wget git python3
sudo apt update && sudo apt install -y curl wget git python3
# RHEL/CentOS/AlmaLinux/RockyLinux
sudo yum install curl wget git python3
# RHEL/CentOS/Alma/Rocky
sudo yum install -y curl wget git python3
```
#### **Permission Denied Errors**
**Port 8090 in use** — find and stop conflicting process:
```bash
# Ensure you're running as root
sudo sh <(curl https://cyberpanel.net/install.sh || wget -O - https://cyberpanel.net/install.sh)
```
#### **Network Connectivity Issues**
```bash
# 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**
```bash
# Check what's using port 8090
sudo netstat -tlnp | grep :8090
# Kill process if necessary
sudo ss -tlnp | grep :8090
sudo kill -9 <PID>
```
### **Common Upgrade Issues**
**Logs & verification**
#### **Backup Creation Failed**
```bash
# Check disk space
df -h
# Free up space if necessary
sudo apt autoremove && sudo apt autoclean
```
#### **Service Restart Failed**
```bash
# Check service status
systemctl status lscpd
# Restart services manually
sudo systemctl restart lscpd
sudo systemctl restart lsws
```
### **Verification Commands**
#### **Check Installation Status**
```bash
# Check CyberPanel service
systemctl status lscpd
# Check web interface
curl -I http://localhost:8090
# Check database
systemctl status mariadb
```
#### **View Logs**
```bash
# CyberPanel logs
tail -f /usr/local/lscp/logs/error.log
# System logs
journalctl -u lscpd -f
```
---
## 📚 Resources
## Resources
- 🌐 [Official Site](https://cyberpanel.net)
- ✏️ [Docs (New)](https://cyberpanel.net/KnowledgeBase/)
- 🎓 [Docs (Old)](https://community.cyberpanel.net/docs)
- 📖 [Additional Guides](guides/INDEX.md) - Detailed guides for Docker, AI Scanner, Mautic, and more
- 📚 [Local Documentation](guides/) - All guides available in this repository
- 🤝 [Contributing Guide](CONTRIBUTING.md) - How to contribute to CyberPanel development
- ✅ [Changelog](https://community.cyberpanel.net/t/change-logs/161)
- 💬 [Forums](https://community.cyberpanel.net)
- 📢 [Discord](https://discord.gg/g8k8Db3)
- 📵 [Facebook Group](https://www.facebook.com/groups/cyberpanel)
- 🎥 [YouTube Channel](https://www.youtube.com/@Cyber-Panel)
### 📖 **Quick Start Guides**
- 🐳 [Docker Command Execution](guides/Docker_Command_Execution_Guide.md) - Execute commands in Docker containers
- 🤖 [AI Scanner Setup](guides/AIScannerDocs.md) - Configure AI-powered security scanning
- 📧 [Mautic Installation](guides/MAUTIC_INSTALLATION_GUIDE.md) - Email marketing platform setup
- 🎨 [Custom CSS Guide](guides/CUSTOM_CSS_GUIDE.md) - Create custom themes for CyberPanel 2.5.5+
- 📚 [All Guides Index](guides/INDEX.md) - Complete documentation hub
### 🔗 **Direct Guide Links**
| Category | Guide | Description |
| ----------- | ------------------------------------------------------------- | ------------------------------ |
| 📚 All | [Complete Guides Index](guides/INDEX.md) | Browse all available guides |
| 🔧 General | [Troubleshooting Guide](guides/TROUBLESHOOTING.md) | Comprehensive troubleshooting |
| 🐳 Docker | [Command Execution](guides/Docker_Command_Execution_Guide.md) | Execute commands in containers |
| 🤖 Security | [AI Scanner](guides/AIScannerDocs.md) | AI-powered security scanning |
| 📧 Email | [Mautic Setup](guides/MAUTIC_INSTALLATION_GUIDE.md) | Email marketing platform |
| 🎨 Design | [Custom CSS Guide](guides/CUSTOM_CSS_GUIDE.md) | Create custom themes |
| 🔥 Security | [Firewall Blocking Feature](guides/FIREWALL_BLOCKING_FEATURE.md) | Advanced security features |
* Official site: [https://cyberpanel.net](https://cyberpanel.net)
* Docs (KnowledgeBase): [https://cyberpanel.net/KnowledgeBase/](https://cyberpanel.net/KnowledgeBase/)
* Community forum: [https://community.cyberpanel.net](https://community.cyberpanel.net)
* GitHub: [https://github.com/usmannasir/cyberpanel](https://github.com/usmannasir/cyberpanel)
* Guides folder: `guides/` (API, INSTALLATION, UPGRADE, TROUBLESHOOTING)
---
## 🔧 Support & Documentation
<div align="center">
For detailed troubleshooting, installation guides, and advanced configuration:
💡 *Hosting should be secure, simple, and fast. CyberPanel is built for that.*
### **📚 General Guides**
- **📚 [Complete Guides Index](guides/INDEX.md)** - All available documentation and troubleshooting guides
- **🔧 [Troubleshooting Guide](guides/TROUBLESHOOTING.md)** - Comprehensive troubleshooting and diagnostic commands
### **🛠️ Feature-Specific Guides**
- **🐳 [Docker Command Execution Guide](guides/Docker_Command_Execution_Guide.md)** - Docker management and troubleshooting
- **🤖 [AI Scanner Documentation](guides/AIScannerDocs.md)** - Security scanner setup and configuration
- **🔐 [2FA Authentication Guide](guides/2FA_AUTHENTICATION_GUIDE.md)** - Two-Factor Authentication and WebAuthn setup
- **📧 [Mautic Installation Guide](guides/MAUTIC_INSTALLATION_GUIDE.md)** - Email marketing platform setup
- **🎨 [Custom CSS Guide](guides/CUSTOM_CSS_GUIDE.md)** - Interface customization and theming
- **🔥 [Firewall Blocking Feature Guide](guides/FIREWALL_BLOCKING_FEATURE.md)** - Security features and configuration
</div>