mirror of
https://github.com/simple-taipei/convoy-for-whmcs.git
synced 2026-05-06 13:51:28 +08:00
main
Convoy WHMCS Module
This is a server provisioning module for WHMCS that integrates with Convoy Panel for virtual machine management. The module allows hosts to automate the provisioning, suspension, termination, and management of virtual machines through Convoy's API.
Features
- Automated virtual machine provisioning
- Suspension and unsuspension of accounts
- Account termination
- Single sign-on (SSO) to Convoy Panel
- Resource usage updates
- Package upgrade/downgrade
Requirements
- WHMCS version 8.0+
- PHP 7.4+
- Convoy Panel installation with API access
- cURL support
Installation
- Download the latest release from the repository
- Upload the contents to your WHMCS installation directory
- The module structure should be placed as follows:
convoy.phpin/modules/servers/- Files in the
lib/directory to/modules/servers/convoy/lib/ - Files in the
templates/directory to/modules/servers/convoy/templates/
Configuration
- Go to WHMCS admin panel
- Navigate to Setup > Products/Services > Servers
- Add a new server with the following details:
- Name: Your server's name
- Hostname: URL to your Convoy Panel installation
- IP Address: Server IP (optional)
- Select "Convoy Panel" as the server type
- Enter your API key in the password field
Product Configuration
When setting up a product using the Convoy module, you can configure the following options:
- Node ID - The node ID where VMs will be created
- CPU Cores - Number of CPU cores to allocate
- Template UUID - Default system template for VM creation
- Memory (MB) - Amount of memory to allocate
- Disk Space (MB) - Amount of disk space to allocate
- IPv4 Addresses - Number of IPv4 addresses to allocate
- IPv6 Addresses - Number of IPv6 addresses to allocate
- Backup Slots - Number of backup slots to allocate
- Bandwidth (MB) - Monthly bandwidth limit
- ServerName Prefix - Prefix for automatic server naming
License
This project is licensed under the terms of the LICENSE file included in the repository.
Credits
Copyright (C) 2025 Ricky Lu, Simple Information, Inc.
Languages
PHP
96.6%
Smarty
3.4%