Server Module Installation
The Vortexus Server Module is the core component that integrates WHMCS with Pterodactyl Panel. Unlike other modules, Vortexus allows clients to manage servers entirely within WHMCS - console, files, power controls, and more without leaving the client area.
Prerequisites
- WHMCS 8.0 or higher
- Pterodactyl Panel 1.x with API access
- PHP 7.4 or higher
Step 1: Download the Module
Download Vortexus from the marketplace where you purchased the product. The package contains:
vortexusweb/ # Server module folder
├── Vortexus.php # Main module file
├── ajax.php # AJAX handler
├── console.php # Console handler
├── hooks.php # WHMCS hooks
├── vortexushub.php # Hub integration
├── assets/ # CSS, JS, images
├── lib/ # PHP libraries
└── templates/
└── client/ # Client area templates
vortexusweb_marketplace/ # Marketplace addon (separate folder)
Step 2: Upload the Server Module
Upload the entire vortexusweb/ folder to your WHMCS servers directory:
/your-whmcs/modules/servers/vortexusweb/
Using cPanel File Manager
- Log in to cPanel
- Open File Manager
- Navigate to
public_html/whmcs/modules/servers/(adjust path as needed) - Click Upload and upload the
Vortexusfolder - Or extract if you uploaded a ZIP file
Using FTP/SFTP
- Connect via FTP client (FileZilla, WinSCP, Cyberduck)
- Navigate to
modules/servers/in your WHMCS directory - Upload the entire
vortexusweb/folder - No permission changes needed for WHMCS
Using SSH/Terminal
# Navigate to WHMCS servers directory
cd /var/www/whmcs/modules/servers/
# Copy the Vortexus folder
cp -r /path/to/downloaded/Vortexus ./
Step 3: Configure Pterodactyl Server in WHMCS
- Log in to WHMCS Admin Panel
- Navigate to Setup → Servers
- Click Add New Server
- Fill in the details:
| Field | Value |
|---|---|
| Name | Your server name (e.g., "Pterodactyl Panel") |
| Hostname | Panel URL with https (e.g., https://panel.example.com) |
| Type | Select Vortexus Web - Pterodactyl |
| Username | Your admin username |
| Password | Application API Key (see below) |
| Access Hash | Client API Key (see below) |
Creating the Application API Key
This key allows WHMCS to manage servers (create, delete, suspend):
- Log in to Pterodactyl Panel as administrator
- Go to Admin Area → Application API
- Click Create New
- Set permissions:
- Users: Read & Write
- Servers: Read & Write
- Locations: Read
- Nests: Read
- Eggs: Read
- Nodes: Read
- Allocations: Read & Write
- Click Create and copy the key
- Paste in Password field in WHMCS
Creating the Client API Key
This key allows client actions (console, power, files):
- In Pterodactyl, go to your Account Settings
- Click API Credentials
- Create a new API key with a description
- Copy the key
- Paste in Access Hash field in WHMCS
Important
Both API keys are required. The Application API manages servers, the Client API enables client features like console access.
Step 4: Create a Product
- Navigate to Setup → Products/Services
- Click Create a New Product
- Configure:
| Field | Value |
|---|---|
| Product Type | Other |
| Product Group | Your group |
| Product Name | e.g., "Game Server" |
| Module | Vortexus Web - Pterodactyl |
- Click Continue
- Go to Module Settings tab and configure resources
Step 5: Test the Connection
- Go to Setup → Servers
- Click on your Pterodactyl server
- Click Test Connection
- Success message confirms proper setup
Verification
- Create a test order
- Accept the order
- Server should be created in Pterodactyl
- Client can access server management within WHMCS
Troubleshooting
Connection Failed
- Verify Panel URL includes
https:// - Check both API keys are correct
- Ensure WHMCS can reach the Panel
Server Creation Failed
- Verify Nest and Egg IDs are correct
- Ensure available allocations on the node
Next Steps
- Install the Marketplace Addon (required for languages)
- Configure Pterodactyl Wings