Personal tools
Namespaces

Variants
Actions

Servertastic SSL For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Configuration of Product)
(→‎About Servertastic SSL For WHMCS)
 
(61 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
<meta name="keywords" content="servertastic ssl for whmcs, servertastic ssl configuration, whmcs servertastic ssl management, whmcs servertastic ssl installation, whmcs servertastic ssl common problems, about whmcs servertasticssl, whmcs servertastic ssl documentation, whmcs servertastic ssl faq, whmcs servertastic ssl help, whmcs servertastic ssl guide, whmcs servertastic ssl wiki, whmcs servertastic ssl tutorial, whmcs servertastic ssl tips, whmcs servertastic ssl wiki"></meta>
 
<meta name="keywords" content="servertastic ssl for whmcs, servertastic ssl configuration, whmcs servertastic ssl management, whmcs servertastic ssl installation, whmcs servertastic ssl common problems, about whmcs servertasticssl, whmcs servertastic ssl documentation, whmcs servertastic ssl faq, whmcs servertastic ssl help, whmcs servertastic ssl guide, whmcs servertastic ssl wiki, whmcs servertastic ssl tutorial, whmcs servertastic ssl tips, whmcs servertastic ssl wiki"></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Servertastic SSL For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Servertastic SSL For WHMCS Module."></meta>
−
 
  
 
=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 offer SSL certificates to your clients. They will be able to define and order a certificate directly in the client area.<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. <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.
+
In addition you will be able to sell tokens from your Servertastic reseller account that can be later on used to obtain certificates.<br/>
 +
After receiving the tokens, your clients will be able to configure their certificates in either the Servertastic panel or [https://www.docs.modulesgarden.com/Servertastic_SSL_For_cPanel Servertastic SSL For cPanel] module.<br/><br/>
 +
The module is powered by '''Servertastic Limited''' in development partnership with ModulesGarden.
 
|}
 
|}
 +
 
<!--a comment maybe? -->
 
<!--a comment maybe? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
Line 26: Line 28:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View And Edit Order ID
+
|style="padding: 0px 0px 0px 30px;"|✔ View Servertastic Token
 
|}
 
|}
 
{|
 
{|
Line 62: Line 64:
 
{|
 
{|
 
|style="padding: 0px 0px 10px 30px;"|✔ Certificate Type
 
|style="padding: 0px 0px 10px 30px;"|✔ Certificate Type
 +
|}
 +
*'''Tokens Integration:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Create And Sell Certificate Tokens From Reseller Account
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Choose Certificate Type
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define SAN Values
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Server Count
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Management Page Link For Token Order Location
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Management Page Link Visibility In Client Area
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Send Generated Token Via Email
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Send Email Reminders Automatically Before Expiration Date
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Renewal Support - Automatically Creates New Certificate For Recurring Products After Expiration Date
+
|style="padding: 10px 0px 0px 30px;"|✔ Use Tokens With Servertastic Panel
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Use Tokens With [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel] Module
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Renewal Support - Automatically Creates New Certificates For Recurring Products After Expiration Date
 
|}
 
|}
 
{|
 
{|
Line 71: Line 104:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 And V7
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure Servertastic SSL For WHMCS.''' <br />
+
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/servertastic-ssl Servertastic SSL For WHMCS.]''' <br />
 
We will guide you step by step through the whole installation and configuration process.
 
We will guide you step by step through the whole installation and configuration process.
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Servertastic SSL For WHMCS.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download Servertastic SSL For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
Line 90: Line 126:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br/>
−
'' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
Files in your WHMCS directory should look like this.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ST_2.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.'''<br />
+
−
The content of PHP version files should look like this.  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ST_2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:e4rt5e45.png]]
 
|}
 
|}
  
 
==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 113: Line 142:
 
|}
 
|}
 
{|
 
{|
−
|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 119: Line 148:
 
|}
 
|}
 
{|
 
{|
−
|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 126: Line 155:
 
|}
 
|}
 
{|
 
{|
−
|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 132: Line 161:
 
|}
 
|}
 
{|
 
{|
−
|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 '' 'Servertastic SSL' '' from a dropdown menu.'''<br />
−
Next, click on '' 'Save Changes' ''.'''
+
Do not forget to generate '' 'Custom Fields' ''. Next, click on '' 'Save Changes' ''.'''
 
|}
 
|}
 
{|
 
{|
Line 139: Line 168:
 
|}
 
|}
 
{|
 
{|
−
|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 '[https://app.servertastic.com Reseller Panel]' and click '' 'View your API Key' '':  
 
|}
 
|}
 
{|
 
{|
Line 147: Line 176:
 
{|
 
{|
 
{|
 
{|
−
|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;"|Additionally, mark '' 'Update Next Due Date' '' if you wish to renew the certificate after reaching its expiration date (recurring products only).<br />
 
Confirm through pressing '' 'Save Changes' ''.<br />
 
Confirm through pressing '' 'Save Changes' ''.<br />
−
''Note: You can mark '' 'Test Mode' '' to connect with the test API.''
+
'' '''Note:''' You can mark 'Test Mode' to connect with the test API.''
 
|}
 
|}
 
{|
 
{|
Line 166: Line 195:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|In the admin area you can view the details of a product and find SSL configuration status.<br />
 
|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.
+
Additionally, you can create/terminate products, resend configuration emails and even change approver emails.
 
|}
 
|}
 
{|
 
{|
Line 172: Line 201:
 
|}
 
|}
 
{|
 
{|
−
|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 20px 15px;"|In order to change approver emails (if possible), fill in a new email and press '' 'Save Changes' '' as shown on the screen below.
 
|}
 
|}
 
{|
 
{|
Line 181: Line 210:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Servertastic SSL For WHMCS allows your customers to order and configure SSL certificates.<br />
 
|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.
+
It also enables to choose from configurable options while ordering.
 
|}
 
|}
 
{|
 
{|
Line 196: Line 225:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In the end of the process, you will receive a configuration email.<br />
+
|style="padding: 0px 0px 15px 15px;"|After configuring the certificate order, the client will also have to verify the ownership of the domain for which the certificate will be issued. <br/>If the email method is chosen, the client will still be able to update provided approver address.
−
As soon as you receive the email and go to the approval site, your certificate will be generated.
+
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ST_14_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Once the verification process is complete, the certificate will be generated and ready to be downloaded.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:ST_15.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:ST_15.png]]
 
|}
 
|}
 +
 
===Management===
 
===Management===
 
{|
 
{|
Line 220: Line 255:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|The module enables you to set up configurable options allowing clients to define the products they order.<br />
 
|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 />
+
Below you can find the list of configurable options with descriptions of how they affect the order: <br />
−
'''Certificate Type''' - allows client to choose from types provided in configuration, a chosen type will overwrite configuration in '' 'Module Settings' ''.<br />
+
* '''Certificate Type''' - allows clients 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 />
+
* '''Years''' - clients can choose the number of years when certificate remains 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 the '' 'Module Settings' '' tab.<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 />
−
'''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) clients can define the maximum number of domains supported by a certificate.
−
'''SAN Count''' - (SAN certificates only) client can define the maximum number of domains supported by a certificate.
+
 
|}
 
|}
 
{|
 
{|
Line 255: Line 289:
 
|}
 
|}
 
{|
 
{|
−
|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 15px;"|4b. (Certificate Type, Years, Servers Count, SAN Count) Fill in the option name and select '' 'Dropdown' '' from the option type.
 
|}
 
|}
 
{|
 
{|
Line 263: Line 297:
 
|style="padding: 0px 0px 15px 15px;"|5. Now, you have to add each option separately.<br />
 
|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 />
 
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 />
+
''Note: As you may notice on the following screen, the 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.'''
+
''The first part concerns a system name of an option (or value) while the second part is a name under which option will be visible for a client.'''
 
|}
 
|}
 
{|
 
{|
Line 271: Line 305:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|6. Now, let's order a product using previously created configurable options.<br />
 
|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.
+
As you can notice, configurable options allow you to use fewer products while offering a full customization of the product at the same time.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:ST_24.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:ST_24.png]]
 +
|}
 +
 +
=Tokens Configuration=
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|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 through Servertastic panel or through cPanel integration.<br/>
 +
 +
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/>-->
 +
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 [https://github.com/servertastic/servertastic-api/blob/master/api2.md#further-field-definitions here.]''
 +
 +
Finally, save the changes and do not forget to generate '' 'Custom Field' '' and '' 'Email Template' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ST_26.png]]
 +
|}
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|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 finish the order at the '' 'Servertastic' '' panel (if that option has been enabled).
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:ST_27.png]]
 +
|}
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Optionally your client can copy the token and complete the certificate configuration directly in the cPanel. <br/>
 +
These steps are described on the [https://www.docs.modulesgarden.com/Servertastic_SSL_For_cPanel#Request Servertastic SSL For cPanel] wiki.
 
|}
 
|}
  
 
=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. When you press the '' 'Renew' '' button in the admin area '' ('Client Profile → Products/Services') '', a new order for the selected domain will be created.<br/>
−
:The admin can place it as '' 'Renewal' '' order type but only 90 days before the expiration date.  
+
The admin can place it as the '' 'Renewal' '' order type but only 90 days before the expiration date.
 +
|}
 +
{|
 +
|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.
 
|}
 
|}
  

Latest revision as of 14:06, 26 April 2024

Contents

[edit] About Servertastic SSL For WHMCS

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.
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.

In addition you will be able to sell tokens from your Servertastic reseller account that can be later on used to obtain certificates.
After receiving the tokens, your clients will be able to configure their certificates in either the Servertastic panel or Servertastic SSL For cPanel module.

The module is powered by Servertastic Limited in development partnership with ModulesGarden.

  • Admin Area Features:
✔ Create Certificate
✔ Terminate Certificate
✔ Resend Configuration Email
✔ Renew Certificate
✔ Change Approver Email
✔ View Servertastic Token
✔ View Certificate Status
✔ Choose Certificate Type
✔ Toggle Synchronization Of Expiration Date
  • Client Area Features:
✔ Configure Certificate
✔ View Basic Certificate Details
✔ Modify Approver Email
✔ Download Generated Certificate
  • Configurable Options:
✔ Additional SAN Domain
✔ Server Count
✔ Certificate Validity
✔ Certificate Type
  • Tokens Integration:
✔ Create And Sell Certificate Tokens From Reseller Account
✔ Choose Certificate Type
✔ Define SAN Values
✔ Define Server Count
✔ Define Management Page Link For Token Order Location
✔ Toggle Management Page Link Visibility In Client Area
✔ Send Generated Token Via Email
✔ Send Email Reminders Automatically Before Expiration Date
  • General Info:
✔ Use Tokens With Servertastic Panel
✔ Use Tokens With Servertastic SSL For cPanel Module
✔ Renewal Support - Automatically Creates New Certificates For Recurring Products After Expiration Date
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6

[edit] 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.

[edit] 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

[edit] 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 'Servertastic SSL' from a dropdown menu.

Do not forget to generate 'Custom Fields' . Next, click on 'Save Changes' .

ST 9.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
Additionally, mark 'Update Next Due Date' if you wish to renew the certificate after reaching its expiration date (recurring products only).

Confirm through pressing 'Save Changes' .
Note: You can mark 'Test Mode' to connect with the test API.

ST 10.png
Congratulations! Your module is ready for use.

[edit] Management

Servertastic SSL For WHMCS allows you to offer fully configurable Servertastic certificates to your clients.

Additionally, you have the ability to view certificate details and manage each provisioned certificate.

[edit] Admin Area

In the admin area you can view the details of a product and find SSL configuration status.

Additionally, you can create/terminate products, resend configuration emails and even change approver emails.

ST 11.png
In order to change approver emails (if possible), fill in a new email and press 'Save Changes' as shown on the screen below.
ST 12.png

[edit] Client Area

Servertastic SSL For WHMCS allows your customers to order and configure SSL certificates.

It also enables to choose from configurable options while ordering.

ST 13.png

[edit] Configuration

A new SSL certificate needs to be configured before it can be used.

Press 'Configure Now' to proceed, you will be forwarded to an external page.
Proceed with configuration of your SSL certificate there.

ST 14.png
After configuring the certificate order, the client will also have to verify the ownership of the domain for which the certificate will be issued.
If the email method is chosen, the client will still be able to update provided approver address.
ST 14 2.png
Once the verification process is complete, the certificate will be generated and ready to be downloaded.
ST 15.png

[edit] Management

On the following screen you can see a successfully configured product.

Here you can find provision and expiration dates, and its status.

ST 16.png
Additionally, you can download the certificate.
ST 17.png

[edit] Configurable Options

The module enables you to set up configurable options allowing clients to define the products they order.

Below you can find the list of configurable options with descriptions of how they affect the order:

  • Certificate Type - allows clients to choose from types provided in configuration, a chosen type will overwrite configuration in 'Module Settings' .
  • Years - clients can choose the number of years when certificate remains valid. Make sure you will not exceed the maximum number of years for a particular certificate.
    Maximum number of years for a particular certificate type can be found after a brand name followed by | on the 'Certificate Type' in the 'Module Settings' tab.
  • Servers Count - (required for Thawte and most of VeriSign certificates) if applicable, its range stretches from 1 to 500.
  • SAN Count - (SAN certificates only) clients can define the maximum number of domains supported by a certificate.
1. Let's create configurable options group containing each one of presented configurable options.

Start by proceeding to 'Setup' → 'Products/Services' → 'Configurable Options' and pressing 'Create a new Group' .

ST 18.png
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.

Afterwards, press 'Save Changes' .

ST 19.png
3. Press 'Add New Configurable Options' .
ST 20.png
4a. (Years, Servers Count, SAN Count) Now, fill in option name, select 'Quantity' option type and fill in minimum and maximum allowed quantity.

Afterwards, set up price per one unit and press 'Save Changes' .

ST 21.png
4b. (Certificate Type, Years, Servers Count, SAN Count) Fill in the option name and select 'Dropdown' from the option type.
ST 22.png
5. Now, you have to add each option separately.

Do it by filling in its name, setting up its price and pressing 'Save Changes' for each of the options.
Note: As you may notice on the following screen, the name is divided by 'I' sign.
The first part concerns a system name of an option (or value) while the second part is a name under which option will be visible for a client.'

ST 23.png
6. Now, let's order a product using previously created configurable options.

As you can notice, configurable options allow you to use fewer products while offering a full customization of the product at the same time.

ST 24.png

[edit] Tokens Configuration

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 through Servertastic panel or through cPanel integration.

After saving the settings in the 'Certificate Type' dropdown, available certificates will appear.
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 finish the order at the 'Servertastic' panel (if that option has been enabled).
ST 27.png
Optionally your client can copy the token and complete the certificate configuration directly in the cPanel.

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

[edit] Tips

1. When you press the 'Renew' button in the admin area ('Client Profile → Products/Services') , a new order for the selected domain will be created.

The admin can place it as the 'Renewal' order type but only 90 days before the expiration date.

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.

[edit] 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=66743"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Servertastic SSL For WHMCS