Child pages
  • Manage AutoSSL
This documentation is for cPanel & WHM version 84 CURRENT builds.  The "RELEASE" version of our documentation can be found in the Version 82 Documentation space.


Skip to end of metadata
Go to start of metadata

(WHM >> Home >> SSL/TLS >> Manage AutoSSL)

Overview

This interface allows you to manage the AutoSSL feature, which automatically installs domain-validated SSL certificates for the Apache®, Dovecot®, Exim, Web Disk, and cPanel Server services for users' domains. It also allows you to review the feature's log files and select which users receive AutoSSL certificates.

Note:

When AutoSSL runs, the system performs a preflight check. This check adds a Certificate Authority Authentication (CAA) record in the domain's zone file before AutoSSL orders a new certificate for that domain.

Provider information

The following information displays at the top of this interface:

  • Current Provider — Your current AutoSSL provider.
  • Provider Account ID — The account identification for your AutoSSL provider, if applicable. If the selected provider does not have an account ID, the interface does not display this information.
  • Run AutoSSL for All Users — Click to run the AutoSSL feature for all users for whom you enabled the feature.

    Note:

    • The system runs the AutoSSL feature for all users at the following times:
      • When the system performs nightly system updates via the /usr/local/cpanel/scripts/upcp script.
      • From the task queue after you create an account. AutoSSL examines the system's SSL coverage and requests certificates from the configured provider to improve the system's SSL coverage.
    • To run the AutoSSL feature for all users via the command line, run the /usr/local/cpanel/bin/autossl_check --all command.

The cPanel (powered by Sectigo) provider

By default, the system uses the cPanel (powered by Sectigo) provider. This provider is free and comes included with your cPanel license.

Note:

  • This provider requires outbound access to the store.cpanel.net server over port 443. For more information, read our How to Configure Your Firewall for cPanel Services documentation.
  • Certain factors may cause longer wait times. Under some conditions, these certificates may require up to 48 hours to process.
  • This provider does not support wildcard domains.

The system automatically polls this provider to determine each pending certificate's status:

Age of certificate requestPolling frequency
Less than 30 minutes.Once every two minutes.
After 30 minutes.Once every ten minutes.
After one hour.Once every 30 minutes.
After four hours.Once every hour.
After one day.Once every 12 hours.

Important:

This provider does not request additional signed certificates for a virtual host when:

  • The virtual host has a pending signed certificate request.
  • There is an existing signed certificate for the virtual host.
  • The virtual host's certificate has not expired.

The Let's Encrypt plugin

If you do not want to use the default AutoSSL provider, you can use the Let's Encrypt plugin. This plugin allows AutoSSL to use Let's Encrypt as the AutoSSL certificate provider. For more information, read our Let's Encrypt Plugin documentation.

Providers

The Providers tab on this interface allows you to select which provider you want to manage your AutoSSL certificates. Click Show/Hide Details to view a table with information about each provider. The system rates providers with a star () icon. The system also determines a rating based on a provider's AutoSSL management capabilities.

For example, an AutoSSL provider with a seven-star score may look like the following:

The system assigns the cPanel (powered by Sectigo) provider's Usability Score by its ability to:

  • Support the "http" and "dns" Domain Control Validation (DCV) method (two stars for each Ancestor DCV-supported DCV method, for a total of four stars).
  • Provide 1,000 domains per certificate (one star).
  • Offer an average delivery time of two minutes (one star).
  • Provide an unlimited number of certificates per registered domain per week (one star). 

The Show/Hide Details table contains the following:

CategoryDescription
ProviderThe AutoSSL provider. Select Disabled to disable the AutoSSL feature.
Usability Score

The total score of a provider, which its AutoSSL capabilities determine. This score is the sum of each provider's DCV Methods, Ancestor DCV Support, Domains per Certificate, Average Delivery Time, Maximum Number of Redirects, and Rate Limit capabilities. A provider can attain a rating up to eight stars.

DCV MethodsThe DCV methods that the provider offers. A provider can receive a total of two stars per DCV method if they support Ancestor DCV. If they do not support Ancestor DCV, the provider receives one star per DCV method.
Ancestor DCV Support

Whether the successful DCV of a parent domain implies success of a subdomain. For example, if the example.com succeeds, then the DCV for the store.example.com subdomain is unnecessary.

Domains per CertificateThe number of unique domains per certificate. A provider can receive a total of one star.
Delivery MethodThe means through which the provider issues a certificate, via the api, queue, or Unspecified method.
Average Delivery TimeThe amount of time the provider requires to issue a certificate, if specified. A provider can receive a total of one star.
Validity PeriodThe period of time before the certificate expires, or Unspecified.
Maximum Number of RedirectsThe maximum number of redirects a domain can use and still pass an HTTP-based DCV. A provider can receive a total of one star.
Rate Limit

The number of certificates the provider registers per domain per week, or Unspecified. A provider can receive a total of one star.

Terms of Service

If the AutoSSL provider requires a Terms of Service or other similar agreement, review it and select the appropriate checkbox to agree to those terms.

Note:

If a provider updates their Terms of Service, you may need to return to this interface to agree to them.

Options

The Options tab allows you to configure various options for AutoSSL.

Notifications

The notification options allow you to select the frequency at which your users receive AutoSSL-related notifications.

Notes:

  • Some of these options remove the corresponding notification option in cPanel's Contact Information interface (Home >> cPanel >> Preferences >> Contact Information). For example, if you disable the Notify the user for all AutoSSL events and normal successes user notification setting, this option is unavailable to your cPanel users.
  • These options override the user's current settings.

User Notifications

You can select from the following notification options for your cPanel users:

  • Notify the user for all AutoSSL events and normal successes.
  • Notify the user for AutoSSL certificate request failures, warnings, and deferrals.
  • Notify the user for AutoSSL certificate request failures only.
  • Disable AutoSSL user notifications.

This setting defaults to Notify the user for AutoSSL certificate request failures, warnings, and deferrals.

Administrator Notifications

You can select from the following notification options for your reseller and WHM users:

  • Notify the administrator for all AutoSSL events and normal successes.
  • Notify the administrator for AutoSSL certificate request failures, warnings, and deferrals.
  • Notify the administrator for AutoSSL certificate request failures only.
  • Disable AutoSSL administrator notifications.

This setting defaults to Notify the user for AutoSSL certificate request failures, warnings, and deferrals.

Allow AutoSSL to replace invalid or expiring non-AutoSSL certificates.

This option allows AutoSSL to replace certificates that the AutoSSL system did not issue. When you enable this option, AutoSSL will install certificates that replace users’ non-AutoSSL certificates if they are invalid or expire within 3 days.

Important:

  • Unless you fully understand this option, do not enable it, because the system may unexpectedly replace an expiring or invalid Extended Validation (EV) or Organization Validated (OV) certificate with a Domain Validated (DV) certificate.
  • Users' non-AutoSSL certificates are paid, and should be replaced by another paid certificate.

Logs

Use the Logs tab to review the system's AutoSSL log files. To view a specific log, select it from the menu and click View Log to display the its information.

Note:

The system stores the log files in both text and JSON format in the /var/cpanel/logs/autossl directory.

Manage Users

The Manage Users tab allows you to override your server's feature list settings and control whether AutoSSL is enabled for your users. Use the search text box to locate specific users, or use the check box and menu to select all users or clear your current selections. 

Note:

User feature lists may differ, based on the user's assigned package. For more information, read our Feature Manager documentation.

You can select from the following Toggle AutoSSL options for individual users and select users:

  • Enable AutoSSL on selected users — Override the feature list setting and force AutoSSL to be enabled.
  • Disable AutoSSL on select users — Override the feature list setting and force AutoSSL to be disabled.
  • Reset AutoSSL on selected users — Use setting established by the feature list's default setting. For more information, read our Feature Manager documentation.

Run AutoSSL Check

You can use the Check button to perform a domain check for a specific user.

Pending Queue

The Pending Queue section of the interface lists the status and the details of the pending AutoSSL jobs on your server. Use the navigation controls at the top of the table to sort and search through the list.