Revision as of 14:57, 30 January 2016

The configurable package addon is an addon module for cPanel and Direct Admin web hosts to enable them to offer customisable packages to their clients. This is done through combining the power of configurable options with an extended cPanel module for automated provisioning. This is a chargeable addon and can be ordered for your license at http://www.whmcs.com/addons/configurable-package-addon/

After purchasing the addon from your client area account, you can create as many configurable packages as you want offering just some or all of the configurable options. Common offerings are options to request a dedicated IP, options to choose how many addon domains are wanted, how many email accounts, etc...

Setup

To use the addon, you just need to follow these steps to enable & setup a package:

1. After purchasing, begin by going to Help > License Information > Force License Update to force a local license key update - this will let your install know that you are now elligible to use the addon. There's no additional files to download.
2. Next, you need to setup a new Shared Hosting Package via Setup > Products/Services > Products/Services.
3. Disable any payment terms you don't want to accept on the Pricing tab by entering -1 and leave the ones you do at zero
4. cPanel: On the Module Settings tab, set the module type to cPanel and set the WHM Package Name field to "Custom"
5. DirectAdmin: On the Module Settings tab, set the module type to DirectAdmin and set the Package Name field to "Custom"
6. Configure any of the limits on the Module Settings tab that you don't want to offer as options on the order form
7. Now move to Setup > Products/Services > Configurable Options
8. Here, click to Create a New Group and enter a name so you can identify it later
9. Now it's time to setup the options you want to offer and their pricing. The options can take the following names for WHMCS to recognise them and you can of course setup others aswell that you will manually handle.

Disk Space - 100MB, 200MB, 300MB, etc...
Bandwidth - 1000MB, 2000MB, 3000MB, etc...
Email Accounts - 1,2,5,etc... 
MySQL Databases - 1,2,5,etc... 
Subdomains - 1,2,5,etc...
FTP Accounts - 1,2,5,etc...
Parked Domains - 1,2,5,etc...
Addon Domains - 1,2,5,etc...
Frontpage Extensions - Yes or No
Dedicated IP - Yes or No
CGI Access - Yes or No
Shell Access - Yes or No

More information on configurable options can be found in the Configurable Options article.

Note: You can show a different display name to the required name here by using the format "required value|display value" - for example "Disk Space|Your Web Quota"

• Now you just need to assign the group of options to the configurable package product you setup in step 1 and then save the group.

That's it! Below is an example of how your configurable options page may look. Now visit your order form to try it out...

DirectAdmin Options

When using the Configurable Package Addon with a DirectAdmin package then the options available to you are:

For items that mention "Value in MB", this means that the number you enter will be interpreted by DirectAdmin as being in megabytes. So for example: 1024 would be interpreted as 1024MB by DirectAdmin.

• Disk Space (*Required* No Default - Value in MB - Quantity or DropDown with System|Friendly values)
• Bandwidth (*Required* No Default - Value in MB - Quantity or DropDown with System|Friendly values)
• FTP Accounts (Unlimited - Quantity or Dropdown with System|Friendly values)
• Email Accounts (Unlimited - Quantity or Dropdown with System|Friendly values)
• MySQL Databases (Unlimited - Quantity or Dropdown with System|Friendly values)
• Subdomains (Unlimited - Quantity or Dropdown with System|Friendly values)
• Parked Domains (Unlimited - Quantity or Dropdown with System|Friendly values)
• Addon Domains (Unlimited - Quantity or Dropdown with System|Friendly values)
• CGI Access (OFF - Yes/No Field)
• Shell Access (OFF - Yes/No Field)
• Mailing Lists (No Default - Quantity or DropDown with System|Friendly values)
• PHP (OFF - Yes/No Field)
• SSL (OFF - Yes/No Field)
• System Info (OFF - Yes/No Field)
• DNS Control (OFF - Yes/No Field)
• Cron Jobs (OFF - Yes/No Field)
• Catch All (OFF - Yes/No Field)
• Spam Assassin (OFF - Yes/No Field)
• Anon FTP (OFF - Yes/No Field)
• Email Forwards (OFF - Quantity or DropDown with System|Friendly values to provide number for specific number or YES for *Unlimited or Yes/No field to enable unlimited)
• Mailing Lists (OFF - Quantity or DropDown with System|Friendly values to provide number for specific number or YES for *Unlimited or Yes/No field to enable unlimited)
• Auto Responders (OFF - Quantity or DropDown with System|Friendly values to provide number for specific number or YES for *Unlimited or Yes/No field to enable unlimited)

cPanel Options

When using the Configurable Package Addon with a cPanel package then the options available to you are:

• Disk Space
• Bandwidth
• FTP Accounts
• Email Accounts
• MySQL Databases
• Subdomains
• Parked Domains
• Addon Domains
• Dedicated IP
• CGI Access
• Shell Access
• FrontPage Extensions
• Mailing Lists

Notes

WHM Feature Lists

Due to a limitation in WHM, feature lists can only be controlled/assigned through predefined packages setup inside WHM itself and not on the fly with this addon. As a result only the default Feature List can be used with accounts created with configurable packages.

IP Addresses

The addon can be used to assign unique IP addresses to accounts. However it cannot currently be used to revert an account back to the server's shared IP address.

Root Access Required

In order to use this addon, root access is required and should be entered in the server configuration page within WHMCS. Reseller level access is not sufficient.