Skip to content

3. Setting up WHMCS product

Ivan edited this page Aug 25, 2016 · 4 revisions

Quick navigation

Adding an OnApp Server to WHMCS

Before you can create a product, you need to add an OnApp server to WHMCS. To do so:

  1. Log in to your WHMCS Admin Area.
  2. Go to Setup > Product/Services > Servers.
  3. On the page that loads, click Add New Server link.
  4. Fill in the form that appears:
    Adding server
    Where: Name – the optional OnApp server name.
    Hostname – the hostname of the server you're adding. If you connect to the server using secure connection, fill in this field using an https:// prefix.
    IP Address – the IP address of the OnApp server. Enable/disable – tick the box to disable the server.

You may leave other fields blank. Also leave this form blank:
Adding server 5. Specify server details:
Adding server
Type – choose Onappuser from the drop-down box.
Username – fill in the username which will be used to log in to your OnApp server to create virtual machines.
Password – the password for the specified username.
Secure – tick to use SSL for connections. 6. Click Save Changes to add the server to WHMCS.

Creating a Server Group

You can also place your servers into a particular server group. This is optional – but it means you will be able to assign products to the whole server group, not just a particular server, and you'll be able to rotate new orders between servers in the group.

To create a server group:

  1. Log in to your WHMCS Admin Area.
  2. Go to Setup > Product/Services > Servers.
  3. On the page that loads, click Create New Group link.
  4. Fill in the form that appears:
  5. Give a name to a server group.
  6. Choose how the new orders will be rotated.
  7. Specify the servers which should be placed into a group.
  8. Click Save Changes to add the new server group to WHMCS.

Creating a Product

When you create a product based on the OnApp users module, you connect WHMCS to the OnApp server, and specify the properties and settings of the user which will be created in OnApp once the product has been ordered and activated. Each product must be assigned to a group which can either be visible or hidden from the order page (products may also be hidden individually). First you need to create a group. To do so:

  1. Go to Setup > Product/Services > Product/Services in your WHMCS Control Panel.
  2. Click the Create a New Group link.
  3. Fill in the form that appears.
  4. Click Create Group button.

Then you will need to create a new product and assign it to the already created product group.
To create a product:

  1. Go to Setup > Product/Services > Product/Services in your WHMCS Control Panel.
  2. Click the Create a New Product link and fill in the form that appears:
    Adding product
  3. Choose the type of product. We recommend to use Other type.
    The Reseller Account product type is not applicable for OnApp module.
  4. Select the group to which your product will belong on the customer order form. For instructions on how to create a group, refer to WHMCS documentation.
  5. Specify the desired product name.
  6. Click Continue.
  7. Complete the forms in the Details and Pricing tabs. For instructions, refer to WHMCS documentation.
  8. Go to the Module Settings tab and select Onappusers from the dropdown menu.
    Once the module has been loaded, complete the form that appears with the details of your product:
  • Choose Onappusers as a Module name.
  • Choose the predefined Server Group of the OnApp server(s), which you added earlier.
  • Specify Billing Plan, User Role, Time Zone, User Group, and Default locale users in OnApp are going to be created with.
  • Specify the provisioning type.
  1. Set other settings and click Save Changes button.

For more details on Products/Services in WHMCS, refer to [WHMCS documentation](http://docs.whmcs.com/P roducts_and_Services).

Other

Set permission "Change own password" to "NO" at OnApp (for user role(s) selected on product settings page).
This allows to reset password via WHMCS client area only and keep DP up–to–date.


Clone this wiki locally