Personal tools
Namespaces

Variants
Actions

Servertastic SSL For cPanel

From ModulesGarden Wiki
Revision as of 15:24, 6 April 2017 by Joanna (Talk | contribs)

Jump to: navigation, search


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 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 or 'Error' notification if occured.

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 (runs by default every 5 minutes)

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
Clicking on the token number will move you to the more detailed error log with API requests and reposnses.
STCP 9.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 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.
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Servertastic SSL For cPanel