Personal tools
Namespaces

Variants
Actions

Servertastic SSL For cPanel

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Configuration)
(→‎Management)
Line 115: Line 115:
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Servertastic SSL For cPanel allows you to offer free SSLs Servertastic certificates to your clients.<br />
+
|style="padding: 10px 0px 30px 15px;"|Servertastic SSL For cPanel allows you to offer free SSL certificates to your clients.<br />
−
Additionally, you have the ability to view certificate details and manage each provisioned certificate.
+
Additionally, you have the ability to view details and manage each provisioned certificate.
 
|}
 
|}
 
==WHM Area==
 
==WHM Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the WHM area you can view the details of the certificate and find SSL configuration status.<br />
+
|style="padding: 10px 0px 15px 15px;"|In the WHM area you can view key details of each certificate and monitor the status of SSL configuration.<br />
−
Additionally, you can view Cron and API logs.
+
In addition, you can explore Cron and API logs.
 
|}
 
|}
 
===Domains===
 
===Domains===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|In this section you will find all available in WHM domains and all the information about their certificate.<br />  
+
|style="padding: 0px 0px 20px 15px;"|In this section you will find all domains available in WHM as well as essential information about installed certificates.<br />  
−
If it was installed, expiry dates, type, status and options to ''Renew'' or ''Remove'' or 'Error' notification if occured.
+
You can view the current status and type of each certificate along with its expiration date, as well as use the options to ''Renew'' or ''Remove'' certificate. Click 'Error' button to see detailed logs of any API errors.
 
|}
 
|}
 
{|
 
{|
Line 134: Line 134:
 
===Cron===
 
===Cron===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Under Cron tab, you will find all existing cron tasks added when any kind of error appeared while verifying a request on certificate installation.<br />  
+
|style="padding: 0px 0px 20px 15px;"|In the Cron section, you will find all existing cron tasks. Tasks are added in case any error occurs when a request for certificate installation is verified.<br />  
−
As you can see, administrator may manually trigger the action again or wait for the next cron run (runs by default every 5 minutes)
+
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).
 
|}
 
|}
 
{|
 
{|
Line 143: Line 143:
 
===Logs===
 
===Logs===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Logs section includes a list of all failed actions that had place in the module. Clear logs if necessary.<br />  
+
|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 />  
−
Please remember that you may always turn logging off in the configuration tab or by switching button ''On'' to ''Off''.
+
Please remember that you may always turn the logs off in the configuration tab or by switching button ''On'' to ''Off''.
 
|}
 
|}
 
{|
 
{|
Line 150: Line 150:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Clicking on the ''token number'' will move you to the more detailed error log with API requests and reposnses.
+
|style="padding: 0px 0px 20px 15px;"|Clicking on the ''token number'' will move you to the more detailed error log with API requests and responses.
 
|}
 
|}
 
{|
 
{|
Line 158: Line 158:
 
==cPanel Area==
 
==cPanel Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Servertastic SSL For cPanel allows your customers to set up and configure free SSL certificate for main or addon domain.<br />
+
|style="padding: 10px 0px 15px 15px;"|Servertastic SSL For cPanel allows your customers to set up and configure free SSL certificate for main or addon domains.<br />
−
Client logs into their cPanel account. Then proceed to the ''' '' 'Security' '' → '' 'HTTPS Installer' '' '''.<br />
+
Log into your cPanel account. Then proceed to the ''' '' 'Security' '' → '' 'HTTPS Installer' '' '''.<br />
 
|}
 
|}
 
{|
 
{|
Line 166: Line 166:
 
===Request===
 
===Request===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|There appears a list of client's domains with their current status. Press ''Install New Certificate'' for the domain to submit request for the free certificate.
+
|style="padding: 10px 0px 15px 15px;"|You can see the list of your domains with their current status. Press ''Install New Certificate'' for a given domain to submit the request for a free certificate.
 
|}
 
|}
 
{|
 
{|
Line 172: Line 172:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Next you have to fill out the Admin and Tech contact details before you can continue.<br />
+
|style="padding: 0px 0px 15px 15px;"|Before you can continue, you need to fill in the Admin and Tech contact details.<br />
−
Please note that Technical contact details are automatically filled out with the same details as Admin contact.<br />
+
Please note that Technical contact details are automatically filled out with the same details as the Admin contact.<br />
 
If you want to use different details, simply change them. Press ''Add Certificate'' when ready.
 
If you want to use different details, simply change them. Press ''Add Certificate'' when ready.
 
|}
 
|}
Line 182: Line 182:
 
===Management===
 
===Management===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In case there are any issues encountered 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 added to the line.<br />
−
There administrator may trigger the action again or wait until system runs cron again and processes the request.
+
The administrator may then trigger the action manually or wait until the system runs cron to process the request again.
 
|}
 
|}
 
{|
 
{|
Line 189: Line 189:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If the verification is successful and domain certificate is installed, it appears on the list with adequate status on the client's account.
+
|style="padding: 0px 0px 20px 15px;"|If the verification is successful and domain certificate is installed, the relevant information appears on the list.
 
|}
 
|}
 
{|
 
{|
Line 195: Line 195:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Finally there are three actions available to perform on the certificate:
+
|style="padding: 0px 0px 20px 15px;"|Finally, there are three actions available to perform on the certificate:
 
|}
 
|}
 
{|
 
{|

Revision as of 15:51, 6 April 2017


Contents

About Servertastic SSL For cPanel

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

You will easily trace the progress on SSL configuration, toggle automatic renewals and handle other essential HTTPS features.
Your clients, at once, will be given the opportunity to supervise owned certificates straight in your cPanel area.

  • WHM Area:
✔ View List Of Domains With Installed Certificates
✔ Renew Or 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
✔ Toggle Auto Renewals Of Certificates
✔ Choose File Or DNS Method Of SSL Authentication
  • cPanel Area:
✔ Install Free Certificate For Main And Addon Domains
✔ View Basic Certificate Details
✔ Renew Or Remove Installed Certificates
  • General Info
✔ Supports Free HTTPS Certificates
✔ Renewal Support - Automatically Creates New Certificate For Recurring Products After Expiration Date
✔ Multi-Language Support
✔ Supports cPanel & WHM 56 And Later

Installation and Configuration

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

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 cPanel.
STCP 1.png
2. Upload and extract the module into the /root cPanel directory.

Files in your cPanel /root/ServerTasticSSL directory should look like on the following screen.

STCP 2.png
3. Once the module is uploaded, run the following command from the console:
 
sudo sh /root/ServerTasticSSL/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 is installed successfully.

STCP 3.png

Configuration

4. In order to configure the plugin, go to 'WHM' → 'Plugins' → 'Servertastic SSL' .
STCP 4.png
5. Click the 'Configuration' and fill in the following records:
  • API Key – provide the key to successfully connect with your API.
  • Test Mode - select to connect with the test API.
  • API Logs – if selected, all requests and API responses will be recorded in the Logs section.
  • Cron Retry Limit – define the number of maximum allowed retries of a single request.
  • Notifications Email – provide e-mail address where notifications of issued certificates will be delivered.
  • Verification Method – choose File or DNS verification method to validate domain ownership automatically.
  • Auto Renew – if selected, certificate will be automatically renewed 30 days before its expiration date.

When ready, test the connection and save the configuration.

STCP 5.png
Congratulations! Your module is ready for use.

Management

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

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

WHM Area

In the WHM area you can view key details of each certificate and monitor the status of SSL configuration.

In addition, you can explore Cron and API logs.

Domains

In this section you will find all domains available in WHM as well as essential information about installed certificates.

You can view the current status and type of each certificate along with its expiration date, as well as use the options to Renew or Remove certificate. Click 'Error' button to see detailed logs of any API errors.

STCP 6.png

Cron

In the Cron section, you will find all existing cron tasks. Tasks are added in case any error occurs when a request for certificate installation is verified.

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

STCP 7.png

Logs

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

Please remember that you may always turn the logs off in the configuration tab or by switching button On to Off.

STCP 8.png
Clicking on the token number will move you to the more detailed error log with API requests and responses.
STCP 9.png

cPanel Area

Servertastic SSL For cPanel allows your customers to set up and configure free SSL certificate for main or addon domains.

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

STCP 13.png

Request

You can see the list of your domains with their current status. Press Install New Certificate for a given domain to submit the request for a free certificate.
STCP 14.png
Before you can continue, you need to fill in the Admin and Tech contact details.

Please note that Technical contact details are automatically filled out with the same details as the Admin contact.
If you want to use different details, simply change them. Press Add Certificate when ready.

STCP 16.png

Management

In case any issues occur while verifying the request, a cron task is automatically added to the line.

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

STCP 17.png
If the verification is successful and domain certificate is installed, the relevant information appears on the list.
STCP 18.png
Finally, there are three actions available to perform on the certificate:
STCP 18 2.png
  • See certificate details
  • Renew the certificate manually
  • Remove the certificate
STCP 19.png

Tips

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

and follow the instructions on the screen choosing the first or second option accordingly:

STCP 20.png

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_cPanel&oldid=30288"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community
Servertastic SSL For cPanel