Difference between revisions of "Configurable Package Addon"

From WHMCS Documentation

m (Reverted edits by John (talk) to last revision by Lawrence)
Line 1: Line 1:
−
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 https://marketplace.whmcs.com/product/30
+
== About this Addon Module ==
  
−
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...
+
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 in the [https://marketplace.whmcs.com/product/30 WHMCS Marketplace].
  
−
==Setup==
+
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 address or options to choose how many addon domains are wanted.
  
−
To use the addon, you just need to follow these steps to enable & setup a package:
+
<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
 +
<tr>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
 +
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
 +
</tr>
 +
<tr>
 +
<td style="border:1px #AAA solid;padding:0.2em;">Configurable Package Addon</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
 +
<td style="border:1px #AAA solid;padding:0.2em;color:darkred;">No</td>
 +
</tr>
 +
</table>
  
−
# 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 eligible to use the addon. There are no additional files to download.
+
== Activating Configurable Package Addon ==
−
# Next, you need to setup a new Shared Hosting Package via '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
+
 
−
# 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
+
To activate this addon:
−
# '''cPanel:''' On the Module Settings tab, set the module type to cPanel and set the WHM Package Name field to "Custom"
+
 
−
# '''cPanel:''' [https://docs.whmcs.com/CPanel/WHM#Setting_Up_a_cPanel_Package Create a package on your cPanel server] (WHM > Packages > Add a Package) called "Custom". The package resources should be set to the minimum resources you wish to offer. WHMCS will override any specified package resources and their defaults when creating a service.
+
# Purchase the addon in the [https://marketplace.whmcs.com/product/30 WHMCS Marketplace].
−
# '''DirectAdmin:''' On the Module Settings tab, set the module type to DirectAdmin and set the Package Name field to "Custom"
+
# Go to '''Help > [[License Information]] > Force License Update''' to force a local license key update. This will allow your installation to use the addon. There are no additional files to download.
−
# Configure any of the limits on the Module Settings tab that you don't want to offer as options on the order form
+
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
−
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Configurable Options''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Configurable Options'''.
+
# Set up a shared hosting package. When you do this:
−
# Here, click to '''Create a New Group''' and enter a name so you can identify it later
+
#* Disable any payment terms you don't want to accept on the '''Pricing''' tab by entering <tt>-1</tt>.
−
# 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 as well that you will manually handle.
+
#* For the cPanel module:
 +
#** In the '''Module Settings''' tab, set the module type to ''cPanel'' and set '''WHM Package Name''' to ''Custom''.
 +
#** [https://docs.whmcs.com/CPanel/WHM#Setting_Up_a_cPanel_Package Create a package on your cPanel & WHM server] with the name ''Custom''.  
 +
#*** Set the package resources to the minimum resources you wish to offer.  
 +
#*** WHMCS will override any specified package resources and their defaults when creating a service.
 +
# For the DirectAdmin module:
 +
#** In the '''Module Settings''' tab, set the module type to ''DirectAdmin'' and set '''Package Name''' to ''Custom''.
 +
# In the '''Module Settings''' tab, configure any limits that you don't want to offer as options on the order form.
 +
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Configurable Options]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Configurable Options'''.
 +
# Create a configurable option group.
 +
# Set up the options you want to offer and their pricing. Use the option names below.
 +
# Assign the group of options to the product you set up.
 +
# Save the group.
 +
 
 +
[[Image:Config package addon.png]]
 +
 
 +
=== Configurable Option Names ===
 +
 
 +
<div class="docs-alert-success">
 +
You can show a different display name to the required name here by using the format <tt>required value|display value</tt>. For example, <tt>Disk Space|Your Web Quota</tt>.
 +
</div>
 +
 
 +
==== cPanel ====
 +
 
 +
For cPanel, use the following option names or create custom names to handle manually:
  
 
Disk Space - 100MB, 200MB, 300MB, etc...
 
Disk Space - 100MB, 200MB, 300MB, etc...
Line 31: Line 70:
 
Shell Access - Yes or No
 
Shell Access - Yes or No
  
−
More information on configurable options can be found in the [[Addons_and_Configurable_Options|Configurable Options article]].<br />
+
==== DirectAdmin ====
  
−
'''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".
+
For DirectAdmin, use the following option names or create custom names to handle manually:
−
 
 
−
* 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...
 
−
 
 
−
[[Image:Config package addon.png]]
 
−
 
 
−
===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)
 
*Disk Space (*Required* No Default - Value in MB - Quantity or DropDown with System|Friendly values)
Line 70: Line 97:
 
*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)
 
*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===
+
<div class="docs-alert-success">
 +
You can show a different display name to the required name here by using the format <tt>required value|display value</tt>. For example, <tt>Disk Space|Your Web Quota</tt>.
 +
</div>
  
−
When using the Configurable Package Addon with a cPanel package then the options available to you are:
+
== Using this Addon==
  
−
*Disk Space
+
=== WHM Feature Lists ===
−
*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.
 
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===
+
=== 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.
 
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===
+
=== Root Access Required ===
  
 
As of cPanel version 80, root access is no longer required. It is now possible to use this addon with a reseller account as long as the permissions configured on the WHM API token match those documented at [https://docs.whmcs.com/CPanel/WHM#API_Token_Permissions API Token Permissions]
 
As of cPanel version 80, root access is no longer required. It is now possible to use this addon with a reseller account as long as the permissions configured on the WHM API token match those documented at [https://docs.whmcs.com/CPanel/WHM#API_Token_Permissions API Token Permissions]
 +
 +
== Troubleshooting ==
 +
 +
''N/A''
 +
 +
== Change Log ==
 +
 +
''N/A''

Revision as of 20:48, 15 March 2022

About this Addon Module

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 in the WHMCS Marketplace.

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 address or options to choose how many addon domains are wanted.

Addon Name Latest Release Current Version Compatible With Included in WHMCS
Configurable Package Addon N/A N/A N/A No

Activating Configurable Package Addon

To activate this addon:

  1. Purchase the addon in the WHMCS Marketplace.
  2. Go to Help > License Information > Force License Update to force a local license key update. This will allow your installation to use the addon. There are no additional files to download.
  3. Go to Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.
  4. Set up a shared hosting package. When you do this:
    • Disable any payment terms you don't want to accept on the Pricing tab by entering -1.
    • For the cPanel module:
      • In the Module Settings tab, set the module type to cPanel and set WHM Package Name to Custom.
      • Create a package on your cPanel & WHM server with the name Custom.
        • Set the package resources to the minimum resources you wish to offer.
        • WHMCS will override any specified package resources and their defaults when creating a service.
  5. For the DirectAdmin module:
      • In the Module Settings tab, set the module type to DirectAdmin and set Package Name to Custom.
  6. In the Module Settings tab, configure any limits that you don't want to offer as options on the order form.
  7. Go to Configuration () > System Settings > Configurable Options or, prior to WHMCS 8.0, Setup > Products/Services > Configurable Options.
  8. Create a configurable option group.
  9. Set up the options you want to offer and their pricing. Use the option names below.
  10. Assign the group of options to the product you set up.
  11. Save the group.

Config package addon.png

Configurable Option Names

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.

cPanel

For cPanel, use the following option names or create custom names to handle manually:

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

DirectAdmin

For DirectAdmin, use the following option names or create custom names to handle manually:

  • 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)

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.

Using this Addon

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

As of cPanel version 80, root access is no longer required. It is now possible to use this addon with a reseller account as long as the permissions configured on the WHM API token match those documented at API Token Permissions

Troubleshooting

N/A

Change Log

N/A

Retrieved from "http://3.17.75.209/index.php?title=Configurable_Package_Addon&oldid=31683"