Skip to main content

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

  1. Log in to cPanel
  2. Open File Manager
  3. Navigate to public_html/whmcs/modules/servers/ (adjust path as needed)
  4. Click Upload and upload the Vortexus folder
  5. Or extract if you uploaded a ZIP file

Using FTP/SFTP

  1. Connect via FTP client (FileZilla, WinSCP, Cyberduck)
  2. Navigate to modules/servers/ in your WHMCS directory
  3. Upload the entire vortexusweb/ folder
  4. 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

  1. Log in to WHMCS Admin Panel
  2. Navigate to SetupServers
  3. Click Add New Server
  4. Fill in the details:
FieldValue
NameYour server name (e.g., "Pterodactyl Panel")
HostnamePanel URL with https (e.g., https://panel.example.com)
TypeSelect Vortexus Web - Pterodactyl
UsernameYour admin username
PasswordApplication API Key (see below)
Access HashClient API Key (see below)

Creating the Application API Key

This key allows WHMCS to manage servers (create, delete, suspend):

  1. Log in to Pterodactyl Panel as administrator
  2. Go to Admin AreaApplication API
  3. Click Create New
  4. Set permissions:
    • Users: Read & Write
    • Servers: Read & Write
    • Locations: Read
    • Nests: Read
    • Eggs: Read
    • Nodes: Read
    • Allocations: Read & Write
  5. Click Create and copy the key
  6. Paste in Password field in WHMCS

Creating the Client API Key

This key allows client actions (console, power, files):

  1. In Pterodactyl, go to your Account Settings
  2. Click API Credentials
  3. Create a new API key with a description
  4. Copy the key
  5. 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

  1. Navigate to SetupProducts/Services
  2. Click Create a New Product
  3. Configure:
FieldValue
Product TypeOther
Product GroupYour group
Product Namee.g., "Game Server"
ModuleVortexus Web - Pterodactyl
  1. Click Continue
  2. Go to Module Settings tab and configure resources

Step 5: Test the Connection

  1. Go to SetupServers
  2. Click on your Pterodactyl server
  3. Click Test Connection
  4. Success message confirms proper setup

Verification

  1. Create a test order
  2. Accept the order
  3. Server should be created in Pterodactyl
  4. 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

  1. Install the Marketplace Addon (required for languages)
  2. Configure Pterodactyl Wings