Personal tools
Namespaces

Variants
Actions

Servertastic SSL For cPanel

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Configuration)
(→‎Management)
Line 117: Line 117:
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Servertastic SSL For cPanel allows you to offer Basic SSLs Servertastic certificates to your clients.<br />
+
|style="padding: 10px 0px 30px 15px;"|Servertastic SSL For cPanel allows you to offer free SSLs Servertastic 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 certificate details and manage each provisioned certificate.
 
|}
 
|}
 
==WHM Area==
 
==WHM 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 />
+
|style="padding: 10px 0px 15px 15px;"|In the WHM area you can view the details of the certificate and find SSL configuration status.<br />
−
Additionally, you can create/terminate product, resend configuration email and even change approver email.
+
Additionally, you can view 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 available in WHM domains and all the information about their certificate.<br />  
−
If it was installed, expiry dates, type, status and options to Renew or Remove if installed.
+
If it was installed, expiry dates, type, status and options to ''Renew'' or ''Remove''.
 
|}
 
|}
 
{|
 
{|
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.<br />  
+
|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 />  
−
Please remember that you may always turn logging off in the configuration tab or by switching button On to Off.<br />
+
Please remember that you may always turn logging off in the configuration tab or by switching button On to Off.
−
Clear logs if necessary.
+
 
|}
 
|}
 
{|
 
{|
Line 154: Line 153:
 
{|
 
{|
 
|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 domain.<br />
−
Client logs into their cPanel account. Then proceeds to '' 'Security' '' → '' 'HTTPS Installer' ''.<br />
+
Client logs into their cPanel account. Then proceed to the ''' '' 'Security' '' → '' 'HTTPS Installer' '' '''.<br />
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:STCP_13.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:STCP_13.png]]
 
|}
 
|}
−
===Order===
+
===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. Currently only free certificate is allowed.
+
|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.
 
|}
 
|}
 
{|
 
{|
Line 169: Line 168:
 
|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;"|Next you have to fill out the admin and tech contact details before you can continue.<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 Admin contact.<br />
−
If you want to use different details, simply change them.<br />
+
If you want to use different details, simply change them.Press ''Add Certificate'' when ready.
−
Press ''Add Certificate'' when ready.
+
 
|}
 
|}
 
{|
 
{|
Line 191: Line 189:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|There are three actions available on the certificate:
+
|style="padding: 0px 0px 20px 15px;"|Finally there are three actions available on the certificate:
−
*See certificate details
+
 
*Renew the certificate manually
 
*Renew the certificate manually
 
*Remove the certificate
 
*Remove the certificate
 +
*See certificate details:
 
|}
 
|}
 
{|
 
{|

Revision as of 12:20, 5 April 2017


Contents

About Servertastic SSL For cPanel

Servertastic For cPanel provides a simple and convenient way for the end-customers to automatically install an SSL Certificate on their website. The module currently supports only basic, free SSLs provisioning.
  • WHM Area:
✔ View Domains List With Installed Certificates
✔ Renew Or Remove Installed Certificates
✔ View Status Of Cron Executions Logs
✔ View Detailed API Errors Logs
✔ Set Certificates Submits Notifications Email
✔ Adjust Cron Retries Limit
✔ Toggle Certificates Auto Renew
✔ Choose File Or DNS Authentication Method
  • cPanel Area:
✔ Install Free Certificate For Main Or 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

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

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

1. Log in to your client area and download Rage4 For cPanel.
STCP 1.png
2. Upload and extract the modele into the /root cPanel directory.

Files in your cPanel /root/ServerTasticSSL directory should look like this:

STCP 2.png
3. Next run the following command from the console:
 
sudo sh /root/ServerTasticSSL/install

Next follow the instruction displayed on console typing yes command to confirm. After a few moments you should see confirmation if plugin installed successfully.

STCP 3.png

Configuration

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

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

WHM Area

In the WHM area you can view the details of the certificate and find SSL configuration status.

Additionally, you can view Cron and API logs.

Domains

In this section you will find all available in WHM domains and all the information about their certificate.

If it was installed, expiry dates, type, status and options to Renew or Remove.

STCP 6.png

Cron

Under Cron tab, you will find all existing cron tasks added when any kind of error appeared while verifying a request on certificate installation.

As you can see, administrator may manually trigger the action again or wait for the next cron run.

STCP 7.png

Logs

Logs section includes a list of all failed actions that had place in the module. Clear logs if necessary.

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

STCP 8.png

cPanel Area

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

Client logs into their cPanel account. Then proceed to the 'Security' → 'HTTPS Installer' .

STCP 13.png

Request

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.
STCP 14.png
Next you have to fill out the admin and tech contact details before you can continue.

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

STCP 16.png

Management

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

There administrator may trigger the action again or wait until system runs cron again and processes the request.

STCP 17.png
If the verification is successful and domain certificate is installed, it appears on the list with adequate status on the client's account.
STCP 18.png
Finally there are three actions available on the certificate:
  • Renew the certificate manually
  • Remove the certificate
  • See certificate details:
STCP 19.png

Tips

1. When you press 'Renew' button in the admin area ('Client Profile → Products/Services') , a new order for selected domain will be created.
The admin can place it as 'Renewal' order type but only 90 days before the expiration date.
2. When you want to 'Update' or 'Uninstall' module simply run the 'install' file again and follow the instructions on the screen

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