Personal tools
Namespaces

Variants
Actions

Servertastic SSL For cPanel

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Servertastic SSL For cPanel)
 
(6 intermediate revisions by 3 users not shown)
Line 4: Line 4:
 
=About [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel]=
 
=About [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Servertastic For cPanel''' will allow your clients to automatically install SSL certificates on their websites.<br/>
+
|style="padding: 10px 0px 10px 0px;"|'''Servertastic SSL For cPanel''' will allow your clients to automatically install SSL certificates on their websites.<br/>
 
You will easily trace the progress on SSL configuration and handle other security features.<br/>
 
You will easily trace the progress on SSL configuration and handle other security features.<br/>
−
Your clients, at once, will be given the opportunity to supervise owned certificates straight in your cPanel area.<br/><br/>
+
Your clients, at once, will be given the opportunity to supervise owned certificates directly in your cPanel area.<br/><br/>
−
The module is powered by '''Servertastic Limited''' in development partnership with ModulesGarden.<br/>
+
The module is powered by '''Servertastic Limited''' in development partnership with ModulesGarden.
−
Check out also our [https://www.modulesgarden.com/products/cpanel/inactive-account-manager '''Inactive Account Manager For cPanel'''] module and '''reduce your running cPanel costs!'''
+
 
|}
 
|}
 +
<!--a comment maybe? -->
 
*'''WHM Area Features:'''
 
*'''WHM Area Features:'''
 
{|
 
{|
Line 53: Line 53:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports cPanel & WHM 56 And Later
+
|style="padding: 00px 0px 0px 30px;"|✔ Supports cPanel Themes "Jupiter" And "Paper Lantern"
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Supports cPanel & WHM 98 And Later
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel.]''' <br />
+
|style="padding: 10px 0px 30px 0px;"|'''This tutorial will guide you through the process of installing and configuring [https://www.modulesgarden.com/products/cpanel/servertastic-ssl Servertastic SSL For cPanel].''' <br />
−
We will guide you step by step through the whole installation and configuration process.
+
Follow the steps below to complete the setup successfully.
 
|}
 
|}
 
==Installation==
 
==Installation==
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1.  Log in to our client area and download the module.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1.  Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
Line 70: Line 73:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the '''/root''' cPanel directory.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the '''/root''' cPanel directory.'''<br />
−
Files in your cPanel ''/root/ServerTasticSSL'' directory should look like these on the following screen.
+
Files in your cPanel ''/root/ServerTasticSSL'' directory should resemble the following:
 
|}
 
|}
 
{|
 
{|
Line 76: Line 79:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Once the module is uploaded, run the following command from the console:<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. Once the module is uploaded, open your server’s console and execute the following commands:<br />
 
  cd /root/ServerTasticSSL/
 
  cd /root/ServerTasticSSL/
 
  sudo sh install
 
  sudo sh install
−
Next, follow the instruction displayed on the console. Type the '''yes''' command to confirm. After a brief moment you should see a confirmation that the plugin has been successfully installed.
+
Follow the on-screen instructions. When prompted, type '''yes''' to confirm the installation. <br/>After a short while, a message will confirm that the plugin has been installed successfully.
 
|}
 
|}
 
{|
 
{|
Line 87: Line 90:
 
==Configuration==
 
==Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''4. In order to configure the plugin, go to '' 'WHM' '' → '' 'Plugins' '' → '' 'Servertastic SSL' ''.'''
+
|style="padding: 10px 0px 15px 15px;"|'''4. In order to configure the plugin, navigate to: '' 'WHM' '' → '' 'Plugins' '' → '' 'Servertastic SSL'.'' '''
 
|}
 
|}
 
{|
 
{|
Line 94: Line 97:
  
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. Click the '' 'Configuration' '' and fill in the following records:'''
+
|style="padding: 0px 0px 15px 15px;"|'''5. Click the '' 'Configuration' '' button and fill in the following fields:'''
−
*API Key – provide the key to successfully connect to your API. To obtain that key log in to your '[https://dashboard.servertastic.com Reseller Panel]' and click '' 'View your API Key' '':  
+
*'''API Key''' – Enter your API key to establish a connection with the API. To obtain your key, log in to your '[https://app.servertastic.com/ Reseller Panel]' and click '' 'View your API Key' '':  
 
|}
 
|}
 
{|
 
{|
Line 103: Line 106:
 
|style="padding: 0px 0px 15px 15px;"|
 
|style="padding: 0px 0px 15px 15px;"|
 
<!--*Test Mode - select to connect to the [https://test-dashboard.servertastic.com/ test API].-->
 
<!--*Test Mode - select to connect to the [https://test-dashboard.servertastic.com/ test API].-->
−
*API Logs – if selected, all requests and API responses will be recorded in the Logs section.
+
*'''API Logs''' – Enable this option to log all API requests and responses in the ''Logs'' section.
−
*Cron Retry Limit – define the number of maximum allowed retries of a single request.
+
*'''Cron Retry Limit''' – Specify the maximum number of retry attempts for a failed API request.
−
*Notifications Email – provide an e-mail address where notifications of issued certificates will be delivered.
+
*'''Notifications Email''' – Enter the email address where notifications about issued certificates should be sent.
−
*Verification Method – choose File or DNS verification method to validate domain ownership automatically.
+
*'''Verification Method''' – Select the desired domain validation method: ''File'' or ''DNS''.
 
<!--już nieobsługiwane:
 
<!--już nieobsługiwane:
−
*Auto Renew – if selected, the certificate will be automatically renewed 30 days before its expiration date.
+
*'''Auto Renew''' – if selected, the certificate will be automatically renewed 30 days before its expiration date.
 
When ready, test the connection and save the configuration.-->
 
When ready, test the connection and save the configuration.-->
 
|}
 
|}
Line 120: Line 123:
 
==WHMCS Integration==
 
==WHMCS Integration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''6. Due to the fact that cPanel does not support customer transactions, the [https://www.docs.modulesgarden.com/Servertastic_SSL_For_WHMCS Servertastic SSL For WHMCS] module can be used to sell paid certificates.''' <br/>
+
|style="padding: 10px 0px 15px 15px;"|'''6. Since cPanel does not natively support direct customer transactions, you can integrate [https://www.modulesgarden.com/products/whmcs/servertastic-ssl Servertastic SSL For WHMCS] to sell paid SSL certificates.''' <br/>
−
Hence, customers will be able to purchase certificate tokens in WHMCS, which can be later on used to set up certificates for domains in cPanel.
+
Customers will be able to purchase certificate tokens through WHMCS, which they can then redeem to generate certificates in cPanel.
 
|}
 
|}
 
{|
 
{|
Line 127: Line 130:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|The instructions for installing the provisioning module for generating tokens in WHMCS can be found on the [https://www.docs.modulesgarden.com/Servertastic_SSL_For_WHMCS#cPanel_Integration Servertastic SSL For WHMCS] documentation. <br/>
+
|style="padding: 0px 0px 30px 15px;"|Instructions for installing the WHMCS provisioning module can be found in the [https://www.docs.modulesgarden.com/Servertastic_SSL_For_WHMCS#cPanel_Integration Servertastic SSL For WHMCS] documentation. <br/>
−
Follow the next steps when ready.
+
Please follow the remaining steps as outlined in that guide once you're ready.
 
|}
 
|}
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Servertastic SSL For cPanel allows you to offer SSL certificates to your clients.<br />
+
|style="padding: 10px 0px 30px 15px;"|'''Servertastic SSL For cPanel''' allows you to offer SSL certificates to your clients.<br />
−
Moreover, you have the ability to view the details and take control of each provisioned certificate.
+
Additionally, you can view certificate details and manage each provisioned SSL certificate.
 
|}
 
|}
 
==WHM Area==
 
==WHM Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the WHM area you can track essential details of each certificate and monitor the status of SSL configuration.<br />
+
|style="padding: 10px 0px 30px 15px;"|In the WHM dmin area, you can:
−
In addition, you can explore Cron and API logs.
+
* Track essential details of each certificate.
 +
* Monitor the status of SSL configurations.
 +
* Explore '''Cron''' and '''API Logs''' for troubleshooting and auditing purposes.
 
|}
 
|}
 
===Domains===
 
===Domains===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In this section you will find all domains available in WHM as well as important information concerning installed certificates.<br />  
+
|style="padding: 10px 0px 15px 15px;"|In the Domains section, you will find:
−
You can view the current status and type of each certificate along with its expiration date, as well as use the option to ''Remove'' certificate. Click the 'Error' button to see detailed logs of any API errors.
+
* A list of all domains available in WHM.
 +
* Key information about installed certificates, including:
 +
** Certificate status
 +
** Certificate type
 +
** Expiration date<br/>
 +
 
 +
You can also:
 +
* Remove certificates.
 +
* View API error details by clicking the Error button.
 
|}
 
|}
 
{|
 
{|
Line 152: Line 165:
 
===Cron===
 
===Cron===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In the Cron section, you will find all existing cron tasks. Tasks are added in case any error occurs followed by a verified request for certificate installation.<br />  
+
|style="padding: 0px 0px 15px 15px;"|The Cron section displays all existing cron tasks. Tasks are automatically added when an error occurs during a certificate installation attempt.<br/>  
−
As you can see, the administrator can either manually trigger the action again or wait for the next cron run (the cron runs every 5 minutes by default).
+
Administrators can either:
 +
* Manually trigger the action.
 +
* Wait for the next scheduled cron run (default interval: every 5 minutes).
 
|}
 
|}
 
{|
 
{|
Line 161: Line 176:
 
===Logs===
 
===Logs===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|The Logs section includes the list of all failed cron executions. You can clear the logs if necessary.<br />  
+
|style="padding: 0px 0px 15px 15px;"|The Logs section includes a list of all failed cron executions. You can '''clear the logs''' if necessary.<br />  
−
Please remember that you may always turn the logs off in the configuration tab or by switching the button ''On'' to ''Off''.
+
Logs can be disabled via the Configuration tab by switching the Logs setting from '''On''' to '''Off'''.
 
|}
 
|}
 
{|
 
{|
Line 168: Line 183:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Clicking on the ''Token'' number will move you to the more detailed error log with the API requests and responses.
+
|style="padding: 0px 0px 20px 15px;"|Clicking on a '''Token number''' opens detailed API error logs, showing both request and response data.
 
|}
 
|}
 
{|
 
{|
Line 176: Line 191:
 
==cPanel Area==
 
==cPanel Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Servertastic SSL For cPanel allows your customers to set up and configure SSL certificate for main or addon domains.<br />
+
|style="padding: 10px 0px 15px 15px;"|'''Servertastic SSL For cPanel'''  also allows end-users to set up and configure SSL certificates for their main or addon domains.<br />
−
Log in to your cPanel account. Then proceed to the ''' '' 'Security' '' → '' 'HTTPS Installer' '' '''.<br/>
+
Log in to your '''cPanel account'''. Then proceed to the '''Security → HTTPS Installer'''.<br/>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:STCP_13.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:STCP_13.png]]
 
|}
 
|}
 +
 
===Request===
 
===Request===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|You can see the list of your domains with their current status. Press ''Use Token'' for a given domain to submit the request for a certificate.
+
|style="padding: 10px 0px 15px 15px;"|You can see the list of your domains with their current SSL status. Press ''Use Token'' next to a domain to submit a certificate request.
−
'' '''Note:''' Remember that in order to get a token, it is necessary to make [https://www.docs.modulesgarden.com/Servertastic_SSL_For_cPanel#cPanel_Integration integration with WHMCS.]''
+
'' '''Note:'''To obtain a token, [[#WHMCS_Integration|WHMCS integration]] must be set up.''
 
|}
 
|}
 
{|
 
{|
Line 191: Line 207:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Next, enter the obtained token and click on the '' 'Add Certificate' '' button.
+
|style="padding: 0px 0px 15px 15px;"|Next, enter the obtained token and click the '' 'Add Certificate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:STCP_14_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:STCP_14_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|If the token is correct, you will be taken to the form where you need to fill in the Admin, Tech and Organisation contact details as well as choose approver email and hashing algorithm.<br />
+
|style="padding: 0px 0px 15px 15px;"|If the token is valid, you’ll be redirected to a form where you must:
−
''Keep in mind that availability of certain fields may depend on the type of ordered certificate.''<br/>
+
* Fill in Admin, Tech, and Organization contact details.
−
Press ''Add Certificate'' when ready.
+
* Choose an Approver Email and Hashing Algorithm.<br/>
 +
'''''Note:''' The availability of certain fields may vary depending on the certificate type.''<br/>
 +
Once completed, press ''Add Certificate''.
 
<!--
 
<!--
 
Please note that Technical contact details are automatically filled out with the same details as the Admin contact.<br />
 
Please note that Technical contact details are automatically filled out with the same details as the Admin contact.<br />
Line 211: Line 229:
 
===Management===
 
===Management===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In case any issues occur while verifying the request, a cron task is automatically added to the line.<br />
+
|style="padding: 10px 0px 15px 15px;"|In case any issues occur while verifying the request, a cron task is automatically created to retry the action.<br />
 
The administrator may then trigger the action manually or wait until the system runs cron to process the request again.
 
The administrator may then trigger the action manually or wait until the system runs cron to process the request again.
 
|}
 
|}
Line 218: Line 236:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If the verification is successful and the domain certificate is installed, the relevant information appears on the list.
+
|style="padding: 0px 0px 20px 15px;"|Once verification succeeds and the SSL certificate is installed, the following actions are available:
 +
*View certificate '''Details'''
 +
*'''Remove''' the certificate
 +
*'''Renew''' the certificate
 
|}
 
|}
 
{|
 
{|
Line 224: Line 245:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Finally, there are three actions available to perform on the certificate:
+
|style="padding: 0px 0px 30px 25px;"|[[File:STCP_19.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:STCP_18_2.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|
+
−
*View ''Certificate Details''
+
−
*Remove the certificate
+
−
|}
+
−
{|
+
−
|style="padding: 15px 0px 30px 25px;"|[[File:STCP_19.png]]
+
 
|}
 
|}
  

Latest revision as of 12:16, 30 April 2025

Contents

[edit] About Servertastic SSL For cPanel

Servertastic SSL For cPanel will allow your clients to automatically install SSL certificates on their websites.

You will easily trace the progress on SSL configuration and handle other security features.
Your clients, at once, will be given the opportunity to supervise owned certificates directly in your cPanel area.

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

  • WHM Area Features:
✔ View List Of Domains With Installed Certificates
✔ Remove Installed Certificates
✔ View Task Status Of Cron Executions
✔ View Detailed Logs Of API Errors
✔ Set Email For Notifications On Certificates Approvals
✔ Define Limit Of Cron Retries
✔ Choose File Or DNS Method Of SSL Authentication
  • cPanel Area Features:
✔ Install Certificates For Main And Addon Domains Using Pre-generated Tokens
✔ View Basic Certificates Details
✔ Remove Installed Certificates
  • General Info
✔ Token Based Certificates Installation
✔ Requires Servertastic SSL For WHMCS Module
✔ Multi-Language Support
✔ Supports cPanel Themes "Jupiter" And "Paper Lantern"
✔ Supports cPanel & WHM 98 And Later

[edit] Installation and Configuration

This tutorial will guide you through the process of installing and configuring Servertastic SSL For cPanel.

Follow the steps below to complete the setup successfully.

[edit] Installation

1. Log in to our client area and download the module.
STCP 1.png
2. Upload and extract the module into the /root cPanel directory.

Files in your cPanel /root/ServerTasticSSL directory should resemble the following:

STCP 2.png
3. Once the module is uploaded, open your server’s console and execute the following commands:
 
cd /root/ServerTasticSSL/
sudo sh install

Follow the on-screen instructions. When prompted, type yes to confirm the installation.
After a short while, a message will confirm that the plugin has been installed successfully.

STCP 3.png

[edit] Configuration

4. In order to configure the plugin, navigate to: 'WHM' → 'Plugins' → 'Servertastic SSL'.
STCP 4.png
5. Click the 'Configuration' button and fill in the following fields:
  • API Key – Enter your API key to establish a connection with the API. To obtain your key, log in to your 'Reseller Panel' and click 'View your API Key' :
STCP 10 1.png
  • API Logs – Enable this option to log all API requests and responses in the Logs section.
  • Cron Retry Limit – Specify the maximum number of retry attempts for a failed API request.
  • Notifications Email – Enter the email address where notifications about issued certificates should be sent.
  • Verification Method – Select the desired domain validation method: File or DNS.
STCP 5.png
Your module is almost ready to use.

[edit] WHMCS Integration

6. Since cPanel does not natively support direct customer transactions, you can integrate Servertastic SSL For WHMCS to sell paid SSL certificates.

Customers will be able to purchase certificate tokens through WHMCS, which they can then redeem to generate certificates in cPanel.

ST 27.png
Instructions for installing the WHMCS provisioning module can be found in the Servertastic SSL For WHMCS documentation.

Please follow the remaining steps as outlined in that guide once you're ready.

[edit] Management

Servertastic SSL For cPanel allows you to offer SSL certificates to your clients.

Additionally, you can view certificate details and manage each provisioned SSL certificate.

[edit] WHM Area

In the WHM dmin area, you can:
  • Track essential details of each certificate.
  • Monitor the status of SSL configurations.
  • Explore Cron and API Logs for troubleshooting and auditing purposes.

[edit] Domains

In the Domains section, you will find:
  • A list of all domains available in WHM.
  • Key information about installed certificates, including:
    • Certificate status
    • Certificate type
    • Expiration date

You can also:

  • Remove certificates.
  • View API error details by clicking the Error button.
STCP 6.png

[edit] Cron

The Cron section displays all existing cron tasks. Tasks are automatically added when an error occurs during a certificate installation attempt.

Administrators can either:

  • Manually trigger the action.
  • Wait for the next scheduled cron run (default interval: every 5 minutes).
STCP 7.png

[edit] Logs

The Logs section includes a list of all failed cron executions. You can clear the logs if necessary.

Logs can be disabled via the Configuration tab by switching the Logs setting from On to Off.

STCP 8.png
Clicking on a Token number opens detailed API error logs, showing both request and response data.
STCP 9.png

[edit] cPanel Area

Servertastic SSL For cPanel also allows end-users to set up and configure SSL certificates for their main or addon domains.

Log in to your cPanel account. Then proceed to the Security → HTTPS Installer.

STCP 13.png

[edit] Request

You can see the list of your domains with their current SSL status. Press Use Token next to a domain to submit a certificate request.

Note:To obtain a token, WHMCS integration must be set up.

STCP 14.png
Next, enter the obtained token and click the 'Add Certificate' button.
STCP 14 1.png
If the token is valid, you’ll be redirected to a form where you must:
  • Fill in Admin, Tech, and Organization contact details.
  • Choose an Approver Email and Hashing Algorithm.

Note: The availability of certain fields may vary depending on the certificate type.
Once completed, press Add Certificate.

STCP 16.png

[edit] Management

In case any issues occur while verifying the request, a cron task is automatically created to retry the action.

The administrator may then trigger the action manually or wait until the system runs cron to process the request again.

STCP 17.png
Once verification succeeds and the SSL certificate is installed, the following actions are available:
  • View certificate Details
  • Remove the certificate
  • Renew the certificate
STCP 18.png
STCP 19.png

[edit] Tips

1. When you want to update or uninstall plugin simply run the 'install' file again: 
cd /root/ServerTasticSSL/
sudo sh install

Then follow the instructions on the screen by choosing the first or second option:

STCP 20.png

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Due to the reason that Servertastic has dropped support for the free certificates, the module no longer supports them since version 1.1.0.
Use the token system for sell paid certificates in WHMCS module instead.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Servertastic_SSL_For_cPanel&oldid=75980"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community
Servertastic SSL For cPanel