WHMCS

Click > or a question to see details. 


The WHMCS OnApp module allows you to create, build, reboot, shut down, start up, unlock, rebuild and delete virtual servers in OnApp directly from WHMCS. All the billing processing takes place through WHMCS, not OnApp itself. To avoid miscommunication between WHMCS and OnApp billing, users of the WHMCS OnApp module cannot log in to OnApp directly using a WHMCS account. That’s why all the management tasks are performed through the WHMCS Customer Store and Admin Area. The OnApp WHMCS Users module allows you to create, suspend, unsuspend and terminate OnApp users through WHMCS. After a customer buys a product based on the WHMCS Users module, the module creates a user account in OnApp and sends a notification with credentials to this account. All the billing tasks are handled via OnApp's Control Panel. The WHMCS Users Module creates invoices in WHMCS based on the resources used and prices set in OnApp.

The system requirements are the same as for WHMCS: Windows or Linux OS, PHP Version 5.x or later, MySQL Version 4.1.x or later (Strict Mode Disabled), cURL with SSL support, plus (for Unix OS users) the php-xml package.

Installing either module involves downloading, extracting, and uploading it to the right location - for details, refer to the relevant documentation for each module.

To localize WHMCS OnApp modules, copy and translate the file {WHMCS root}/modules/servers/onapp/lang/English.txt to the desired language. For more info, refer to http://wiki.whmcs.com/Main_Page.

To add a new resource:

  1. Go to Setup > Configurable Options in your WHMCS Administration Area and click the Edit icon next to the group to which you want to add a resource
  2. On the page that follows, click the Add New Configurable Option button
  3. On the pop-up that opens, set an option name and type. You can choose between drop-down, radio, and quantity types
  4. Enter the first sub-option value you want to offer for this option (pricing is set after saving) and click Save

For more info on Additional resources configuration, refer to WHMCS OnApp Module documentation.

This problem can occur when customers buy a product without a required Hostname field assigned, and create a Virtual Server in WHMCS. To avoid this error, set the correct Hostname parameter for the required product in the Client Area > My Virtual Servers menu.

It means that a product consists of more than one OS template and WHMCS can't choose between the OS templates to create a Virtual Server. In such a situation, a VS can only be created from the Client Area.

No. The WHMCS OnApp module provides the same functionality as OnApp. It allows you to create, build, reboot, shut down, start up, unlock, rebuild, and delete virtual servers in OnApp directly from WHMCS. All the VS management operations for WHMCS and OnApp customers are the same, but billing processing differs. So, to prevent miscommunication between OnApp and WHMCS billing procedures, customers are not provided with access to OnApp.

This error can occur when the email address is used to create a VS, through the WHMCS OnApp plug-in, is already present in the OnApp database (e.g. for an active, or even a deleted user). As a workaround, we suggest that you use a different email address so you're able to create the VS. The email address can be changed back after VS creation. Alternatively, you can fully delete the user within OnApp if it is not currently in use. 

There are two email templates related to OnApp events: Virtual Server Created (sent when a user creates a VS) and Virtual Server Deleted (sent when a user deletes a VS). You can automate emails for these two events. You can use the default admin templates or create custom templates to notify staff of certain actions through WHMCS. Use the following email placeholders within these templates to send VS details:

  • Username {$service_username} (root for linux and administrator for windows)
  • Password {$service_password}
  • Assigned IPs {$service_assigned_ips} (all IP addresses assigned to a VS)
  • Server Hostname {$service_server_hostname} (VS hostname)
  • Config. Options {$service_config_options} (An array of additional resources and OS Templates configuration)


If no compute resources are available, then WHMCS is unable to connect to the UI correctly. Generally, it occurs due to an incorrect password on the Servers page for the user listed or due to a permissions error. Make sure that the user listed on the servers page has full admin rights to OnApp and that the password is correct for the user.

This issue occurs when multiple modules are installed but only one of them has been updated. Updating all of the modules should allow the page to load normally.

If you're using the OnApp Users module, please make sure the PHP Wrapper is updated to the latest version as well:

https://github.com/OnApp/OnApp-PHP-Wrapper-External/releases

The wrapper installation directory is: "<WHMCS Root Directory>/includes/wrapper"

The user, who was set up at the Servers page in WHMCS, requires full admin access in OnApp. Inside products, the role can be limited with the default user role permissions.

These fields appear when the product type is set to Dedicated/VPS Server. Switching the product type to Other removes the Name Server fields.