Personal tools
Namespaces

Variants
Actions

Servertastic SSL For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 5: Line 5:
 
=About [https://www.modulesgarden.com/products/whmcs/servertastic-ssl Servertastic SSL For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/servertastic-ssl Servertastic SSL For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Servertastic SSL For WHMCS''' will allow you to offer SSL certificates to your clients. They will be able to define and order a certificate directly in the client area.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Servertastic SSL For WHMCS''' will allow you to sell certificate tokens for [https://www.docs.modulesgarden.com/Servertastic_SSL_For_cPanel Servertastic SSL] For cPanel module.<br/>
−
Moreover, the module will give you the access to SSL configuration details as well as enable you to terminate certificates and renew them after their expiration date.
+
You can bill customers for the ordered certificates and generate tokens, which can be then used by customers to add their certificates in cPanel.  
 
|}
 
|}
 
<!--a comment maybe? -->
 
<!--a comment maybe? -->
−
*'''Admin Area Features:'''
 
−
{|
 
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Certificate
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Terminate Certificate
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Resend Configuration Email
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Renew Certificate
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Approver Email
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ View And Edit Order ID
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ View Certificate Status
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Certificate Type
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 30px;"|✔ Toggle Synchronization Of Expiration Date
 
−
|}
 
−
*'''Client Area Features:'''
 
−
{|
 
−
|style="padding: 10px 0px 0px 30px;"|✔ Configure Certificate
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ View Basic Certificate Details
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Modify Approver Email
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 30px;"|✔ Download Generated Certificate
 
−
|}
 
−
*'''Configurable Options:'''
 
−
{|
 
−
|style="padding: 10px 0px 0px 30px;"|✔ Additional SAN Domain
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Server Count
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 0px 30px;"|✔ Certificate Validity
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 10px 30px;"|✔ Certificate Type
 
−
|}
 
 
*'''cPanel Tokens Integration:'''
 
*'''cPanel Tokens Integration:'''
 
{|
 
{|
Line 83: Line 29:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Send Generated Token Via Email
+
|style="padding: 0px 0px 0px 30px;"|✔ Send Generated Token Via Email
 
|}
 
|}
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Renewal Support - Automatically Creates New Certificate For Recurring Products After Expiration Date
+
|style="padding: 0px 0px 10px 30px;"|✔ Automatically Send Reminder Emails Before Expiration Date
 
|}
 
|}
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 And V7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
 
|}
 
|}
  
Line 121: Line 67:
 
==Configuration of Product==
 
==Configuration of Product==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''4. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''3. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
 
Click on '' 'Create a New Group' ''.
 
Click on '' 'Create a New Group' ''.
 
|}
 
|}
Line 128: Line 74:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''5. Enter product group name and press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''4. Enter product group name and press '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
Line 134: Line 80:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. When you have a product group, you can create your product.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''5. When you have a product group, you can create your product.'''<br />
 
To create a product click on '' 'Create a New Product' ''.  
 
To create a product click on '' 'Create a New Product' ''.  
 
|}
 
|}
Line 141: Line 87:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. Afterwards, choose your product group and type from dropdown menus, fill in your product name and press '' 'Continue' ''.'''
+
|style="padding: 0px 0px 20px 15px;"|'''6. Afterwards, choose your product group and type from dropdown menus, fill in your product name and press '' 'Continue' ''.'''
 
|}
 
|}
 
{|
 
{|
Line 147: Line 93:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. Now, go to '' 'Module Settings' '' section, choose '' 'Servertastic SSL' '' from a dropdown menu.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. Now, go to '' 'Module Settings' '' section, choose '' 'ServerTasticToken' '' from a dropdown menu.'''<br />
 
Next, click on '' 'Save Changes' ''.'''
 
Next, click on '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ST_25_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. Finish by filling in '' 'API Key' '' and selecting desired certificate type.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. Finish by filling in '' 'API Key' '' and selecting desired certificate type.'''<br />
 
To obtain 'API Key' log in to your '[http://reseller.servertastic.com Reseller Panel]' and click '' 'View your API Key' '':  
 
To obtain 'API Key' log in to your '[http://reseller.servertastic.com Reseller Panel]' and click '' 'View your API Key' '':  
 
|}
 
|}
Line 162: Line 108:
 
{|
 
{|
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Additionally, mark '' 'Update Next Due Date' '' if you want to renew the certificate after reaching its expiration date (recurring products only).<br />
+
|style="padding: 0px 0px 15px 15px;"|Confirm through pressing '' 'Save Changes' ''.
−
Confirm through pressing '' 'Save Changes' ''.<br />
+
−
''Note: You can mark '' 'Test Mode' '' to connect with the test API.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:ST_25_2.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 15px;"|'''Congratulations! Your module is ready for use.'''
 
|style="padding: 0px 0px 30px 15px;"|'''Congratulations! Your module is ready for use.'''
−
|}
 
−
 
−
=Management=
 
−
{|
 
−
|style="padding: 10px 0px 30px 15px;"|Servertastic SSL For WHMCS allows you to offer fully configurable Servertastic certificates to your clients.<br />
 
−
Additionally, you have the ability to view certificate details and manage each provisioned certificate.
 
−
|}
 
−
==Admin Area==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|In the admin area you can view the details of a product and find SSL configuration status.<br />
 
−
Additionally, you can create/terminate product, resend configuration email and even change approver email.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_11.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|In order to change approver email, fill in a new email and press '' 'Save Changes' '' as shown on the screen below.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_12.png]]
 
−
|}
 
−
 
−
==Client Area==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|Servertastic SSL For WHMCS allows your customers to order and configure SSL certificates.<br />
 
−
As you can see on the following screen, it also allows to choose from configurable options during an order.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_13.png]]
 
−
|}
 
−
===Configuration===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|A new SSL certificate needs to be configured before it can be used.<br />
 
−
Press '' 'Configure Now' '' to proceed, you will be forwarded to an external page.<br />
 
−
Proceed with configuration of your SSL certificate there.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_14.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|In the end of the process, you will receive a configuration email.<br />
 
−
As soon as you receive the email and go to the approval site, your certificate will be generated.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_15.png]]
 
−
|}
 
−
===Management===
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|On the following screen you can see a successfully configured product.<br />
 
−
Here you can find provision and expiration dates, and its status.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_16.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|Additionally, you can download the certificate.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_17.png]]
 
−
|}
 
−
 
−
==Configurable Options==
 
−
{|
 
−
|style="padding: 10px 0px 15px 15px;"|The module enables you to set up configurable options allowing clients to define the products they order.<br />
 
−
Below you can find the list of configurable options with descriptions of how they will affect an order: <br />
 
−
'''Certificate Type''' - allows client to choose from types provided in configuration, a chosen type will overwrite configuration in '' 'Module Settings' ''.<br />
 
−
'''Years''' - client can choose the amount of years when certificate is valid. Make sure you will not exceed the maximum number of years for a particular certificate.<br />
 
−
Maximum number of years for a particular certificate type can be found after a brand name followed by '' '| ''' on the '' 'Certificate Type' '' in '' 'Module Settings' '' tab.<br />
 
−
'''Servers Count''' - (required for Thawte and most of VeriSign certificates) if applicable, its range stretches from 1 to 500.<br />
 
−
'''SAN Count''' - (SAN certificates only) client can define the maximum number of domains supported by a certificate.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|1. Let's create configurable options group containing each one of presented configurable options.<br />
 
−
Start by proceeding to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Configurable Options' '' and pressing '' 'Create a new Group' ''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_18.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|2. Afterwards, fill out the form with a group name and a description, select products you wish to apply to this group by holding Ctrl and clicking on each of the products.<br />
 
−
Afterwards, press '' 'Save Changes' ''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_19.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|3. Press '' 'Add New Configurable Options' ''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_20.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|4a. (Years, Servers Count, SAN Count) Now, fill in option name, select '' 'Quantity' '' option type and fill in minimum and maximum allowed quantity.<br />
 
−
Afterwards, set up price per one unit and press '' 'Save Changes' ''.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_21.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 15px;"|4b. (Certificate Type, Years, Servers Count, SAN Count) Fill in option name and select '' 'Dropdown' '' from option type.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_22.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|5. Now, you have to add each option separately.<br />
 
−
Do it by filling in its name, setting up its price and pressing '' 'Save Changes' '' for each of the options.<br />
 
−
''Note: As you may notice on the following screen, name is divided by '' 'I' '' sign. ''<br />
 
−
''The first part concerns system name of an option (or value) while the second part is a name under which option will be visible for client.'''
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_23.png]]
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 15px 15px;"|6. Now, let's order a product using previously created configurable options.<br />
 
−
As you can see, using configurable option allows you to use fewer product while still allowing a full customization of the product.
 
−
|}
 
−
{|
 
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_24.png]]
 
 
|}
 
|}
  
 
=cPanel Tokens Configuration=
 
=cPanel Tokens Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|To enable selling of certificates with [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel] module, configure the token generator using the provisioning module for WHMCS. <br/>
+
|style="padding: 10px 0px 15px 15px;"|To enable selling of certificates with [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel] module, configure the token generator using the provisioning module for WHMCS. <br/>Your WHMCS will now bill customers for the ordered certificates and generate tokens, which can be then used by customers to add their certificates in cPanel.<br/>
−
Your WHMCS will now bill customers for the ordered certificates and generate tokens, which can be then used by customers to add their certificates in cPanel.
+
−
<br/><br/>
+
  
−
In order to start selling tokens for cPanel certificates you need to add a new product following the steps described in the '' '[https://www.docs.modulesgarden.com/Servertastic_SSL_For_WHMCS#Configuration_of_Product Configuration of Product]' '' section.<br/>
+
After saving the settings in the  ''' '' 'Certificate Type' '' ''' dropdown, available certificates will appear.<br/>
−
Select '' 'ServerTasticToken' '' from the module settings, enter your '' 'API Key' '' found in the ''step 9'' and save the settings.<br/>
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_25.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|After saving the settings in the  ''' '' 'Certificate Type' '' ''' dropdown, available certificates will appear.<br/>
+
 
'' '''Note:''' If you are using a test API key, first make sure that the 'Test Mode' option is enabled.''<br/><br/>
 
'' '''Note:''' If you are using a test API key, first make sure that the 'Test Mode' option is enabled.''<br/><br/>
 
Then set the remaining options corresponding to the selected certificate:
 
Then set the remaining options corresponding to the selected certificate:
Line 315: Line 131:
  
 
Finally, save the changes and do not forget to generate '' 'Custom Field' and '' 'Email Template' ''.
 
Finally, save the changes and do not forget to generate '' 'Custom Field' and '' 'Email Template' ''.
−
 
 
|}
 
|}
 
{|
 
{|
Line 333: Line 148:
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|1. When you press '' 'Renew' '' button in the admin area '' ('Client Profile → Products/Services') '', a new order for selected domain will be created.
+
|style="padding: 10px 0px 10px 15px;"|1. Apart from the '' 'ServerTasticToken' '', since version 1.3.0 there is no longer directly support for '' 'Servertastic SSL' '' module type.<br/>
−
:The admin can place it as '' 'Renewal' '' order type but only 90 days before the expiration date.  
+
This is due to the removal of the existing API support that allowed this module to work properly.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|2. When the certificate expires, a reminder will be sent to the customer to renew it.<br/>
 +
This will be done with the use of the main WHMCS cron and the '' 'Certificate Expiration Reminder' '' template.
 
|}
 
|}
  

Revision as of 15:37, 6 April 2018


Contents

About Servertastic SSL For WHMCS

Servertastic SSL For WHMCS will allow you to sell certificate tokens for Servertastic SSL For cPanel module.

You can bill customers for the ordered certificates and generate tokens, which can be then used by customers to add their certificates in cPanel.

  • cPanel Tokens Integration:
✔ Create Certificate Tokens For Servertastic SSL For cPanel Module
✔ Choose Certificate Type
✔ Define SAN Values
✔ Define Server Count
✔ Define Management Page Link
✔ Toggle Management Page Link Visibility For Client Area
✔ Send Generated Token Via Email
✔ Automatically Send Reminder Emails Before Expiration Date
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS V7

Installation and Configuration

This tutorial will show you how to successfully install and configure Servertastic SSL For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to our client area and download Servertastic SSL For WHMCS.
ST 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

E4rt5e45.png

Configuration of Product

3. In order to create and configure a product, go to 'Setup' → 'Products/Services' → 'Products/Services' .

Click on 'Create a New Group' .

ST 5.png
4. Enter product group name and press 'Save Changes' .
ST 6.png
5. When you have a product group, you can create your product.

To create a product click on 'Create a New Product' .

ST 7.png
6. Afterwards, choose your product group and type from dropdown menus, fill in your product name and press 'Continue' .
ST 8.png
7. Now, go to 'Module Settings' section, choose 'ServerTasticToken' from a dropdown menu.

Next, click on 'Save Changes' .

ST 25 1.png
8. Finish by filling in 'API Key' and selecting desired certificate type.

To obtain 'API Key' log in to your 'Reseller Panel' and click 'View your API Key' :

ST 10 1.png
Confirm through pressing 'Save Changes' .
ST 25 2.png
Congratulations! Your module is ready for use.

cPanel Tokens Configuration

To enable selling of certificates with Servertastic SSL For cPanel module, configure the token generator using the provisioning module for WHMCS.
Your WHMCS will now bill customers for the ordered certificates and generate tokens, which can be then used by customers to add their certificates in cPanel.

After saving the settings in the 'Certificate Type' dropdown, available certificates will appear.
Note: If you are using a test API key, first make sure that the 'Test Mode' option is enabled.

Then set the remaining options corresponding to the selected certificate:

  • SAN Values - enter how many domain names can be protected with a single certificate.
  • Server Count - enter how many different servers can indicate the domains protected by a given certificate.
  • Management Page Link - Specify the address at which the customer will be able to see the generated certificate directly in the 'Servertastic' panel.
  • Show Order Management Page link - select whether you want your customers to see a direct link to the certificate in the 'Servertastic' panel.

Note: Make sure that SAN and Server vaules are supported by the selected type of certificate. You can find more relevant information on here.

Finally, save the changes and do not forget to generate 'Custom Field' and 'Email Template' .

ST 26.png
After placing an order for a configured product, the customer will have access to the generated 'certificate token' , its 'status' and a direct link to the order at the 'Servertastic' panel (if that option has been enabled).
ST 27.png
The client should now copy the token and complete the certificate configuration directly in the cPanel.

These steps are described on the Servertastic SSL For cPanel wiki.

Tips

1. Apart from the 'ServerTasticToken' , since version 1.3.0 there is no longer directly support for 'Servertastic SSL' module type.

This is due to the removal of the existing API support that allowed this module to work properly.

2. When the certificate expires, a reminder will be sent to the customer to renew it.

This will be done with the use of the main WHMCS cron and the 'Certificate Expiration Reminder' template.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Servertastic_SSL_For_WHMCS&oldid=38301"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community
Servertastic SSL For WHMCS