System Documentation
Complete technical guides for deploying WHBOS, connecting provisioning servers, configuring payment gateways and domain registrars, and performing automated 1-click WHMCS migrations.
1. System Architecture
Laravel MonolithWHBOS (Web Hosting Business Operating System) is built natively on unencoded, modern PHP 8.3+ and the Laravel framework with Livewire and Alpine.js. It manages the entire web hosting lifecycle: automated multi-panel server provisioning, multi-gateway recurring billing, domain registration, automated ticket desk with ClamAV/VirusTotal malware defense, and customer self-service.
2. Server Prerequisites
- PHP Runtime: PHP >= 8.3 with extensions:
bcmath, ctype, curl, dom, fileinfo, gd, json, mbstring, openssl, pdo_mysql, tokenizer, xml, zip. - Database: MySQL 8.0+ / MariaDB 10.6+ (Strict Mode compatible).
- Web Server: Nginx 1.24+ or Apache 2.4+ with mod_rewrite enabled.
- Queue & Cache: Redis 7.x recommended for asynchronous server provisioning jobs.
- Zero Obfuscation: 100% standard PHP — No ionCube loader required.
3. Automated Installation
Deploy WHBOS in under 3 minutes via the web installer or SSH command line:
# 1. Clone repository or extract release zip
git clone https://github.com/whbos/whbos-core.git /var/www/whbos
# 2. Install dependencies & configure environment
composer install --no-dev --optimize-autoloader
cp .env.example .env && php artisan key:generate
# 3. Run database migrations & system seeders
php artisan migrate --seed
4. Automation Cron & Queue Worker
Configure a single system crontab entry to drive daily invoicing, domain expiry checks, ticket piping, and automatic overdue suspensions:
* * * * * cd /var/www/whbos && php artisan schedule:run >> /dev/null 2>&1
5. cPanel & WHM Provisioning Setup
To add a cPanel/WHM server, navigate to Admin → Servers → Add Server. Select cPanel as the module driver, input the server hostname (e.g. srv01.example.com), and enter your WHM API Token with root or reseller ACLs.
✓ Instant Account Creation (createacct) with disk/bandwidth package matching.
✓ Suspension & Un-suspension on invoice due date and settlement.
✓ Automated Single Sign-On (SSO) login token generation for Client Portal users.
6. Virtualizor VPS Hypervisor Cluster
WHBOS includes native first-class support for Virtualizor KVM, LXC, and OpenVZ nodes. In Admin → Servers → Add Server, select the Virtualizor driver, supply the Master API Key & API Password, and configure your IP pools.
✓ Start, Stop, Power Off, and Soft Reboot VM power cycles.
✓ In-browser noVNC HTML5 Web Console access.
✓ Real-time CPU, RAM, and Bandwidth utilization graphs.
✓ OS Re-install (Ubuntu, Debian, AlmaLinux, Rocky Linux, Windows Server).
7. Plesk Obsidian & DirectAdmin Setup
Connect Plesk servers via XML-RPC / REST API tokens or DirectAdmin servers via Session Login keys. WHBOS automatically provisions webspaces, maps domain aliases, and configures PHP versions.
8. 1-Click WHMCS Migration Tool
Zero Downtime
Migrating from WHMCS to WHBOS is fully automated via the built-in ImportIndex migration wizard:
- Navigate to Admin → System → WHMCS Migrator.
- Input your WHMCS MySQL database connection parameters (Host, Port, Database, User, Password).
- Click Test Database Connection & Analyze Data.
- Select data entities to migrate: Clients, Products & Pricing, Active Services & Servers, Domains, Invoices, and Support Tickets.
- Click Run Migration Pipeline. Data is migrated, normalized, and password hashes are preserved so clients can log in seamlessly.
9. REST API v2 & Webhooks
Open Full API Reference →WHBOS exposes complete cryptographic REST endpoints for licensing, automated server provisioning, domain management, and software release verification. For full payload schemas, Ed25519 canonical signing guides, and interactive OpenAPI specifications, visit the dedicated REST API v2 Documentation.
POST /api/v2/license/validate
POST /api/v2/license/activate
GET /api/v2/release/check
GET /api/v2/health