WHMCS Setup
From The FluidVM Wiki
Contents |
WHMCS Setup
It is possible to create user accounts and virtual machines via WHMCS automatically with FluidVM. Also, other commands from WHMCS like stop, start, reboot and suspension of user account work well. If you have previously developed extensions to portal that talk directly to HyperVM, you can use the same API to talk to FluidVM. Also, in WHMCS, there is nothing special to do. You need to do the same setup that you do for HyperVM.
FluidVM uses XML-RPC listening on port 8080 (only on localhost by default) for its API. There were many requests from customers who were previously using HyperVM and had extended it in their portals for a compatible API. So, we wrote a FluidVM Proxy that emulates the HyperVM API to an extent as to allow you to crete users, virtual machines and to allow for their basic management.
Important
If you are running WHMCS on a server other than the FluidVM Management server, you will need to configure the FluidVM Proxy to allow connections from outside. Also do not use '=' and '&' in your password or other fields that are passed from WHMCS to the FluidVM Proxy. This will confuse it! This is a technical quirk.
Setting up FluidVM in WHMCS
Setting up Management Server :
After logging into WHMCS as admin
1. Goto setup -> Server ( Here we setup the management server.
Now click "Add new Server"
Now the server is setup successfully
2. After step 1 , Fill up the details and save the changes.The Ip address should be your management server's IP.In server details make sure you choose HyperVM as the type. The admin username and password here will be the fluidVM management server admin's username and password.
3. Now save the changes. Now Setting up management server is done.
Setting up a Product :
1.Goto Setup -> Products/services ( Here we setup the products )
Here we have an option to create a group and add products to that group or even duplicate a product.
Now to create a new product.....
1. Click "Create new Product"
2. Now you will be able to fill up the product details, There you have to choose product type as "Other"
3. Now navigate to the next tab "Module settings" in the same page and fill up the details as required. You should choose module name as "HyperVM". Default install server will be the management sever which you had setup already.The type should be either openvz or xen depending upon your requirement. The Plan name should be be the existing plan in fluidVM for the hypervisor type which you choose.Even the OS template should be be the existing one in fluidVM for the hypervisor type which you choose. Now the server IP address should be the IP address of the physical machine ( Compute node in FluidVM terminology - Some Terminology) in which you want to create VM's.
4. You have one more option where you can create a custom field and make it a entry in the order form. There include a custom field "Username".The username which you give here will be the user name of the FluidVM management server and the VM name will be <username>.vm
Note:
When the welcome mail from WHMCS is enabled , a welcome mail with user details is sent to the user. In that mail the user name would be mentioned as <username>.vm , But the actual username would be just username.
Example :
User name given in order form - John
Username displayed in WHMCS - John.vm
Username in FluidVM - John
VM name in FluidVM - John.vm
5. Now the product is created , Admin can create users and allow them buy the products created by the admin. After purchasing the product admin will be allowed to Create, suspend, unsespend, terminate or restart the VM's if necessary.
