Provisioning an SSL for a domain using DNS API Domain verification by Proxy Challenge

8 min read

This article will explain how to add a SSL Certificate from the free Let’s Encrypt Certificate Provider with GridPane using a Proxy Challenge through one of our DNS API integrations. This will allow your site to be served by the encrypted HTTPS protocol, and your visitors will also benefit from the speed increase enabled by HTTP2 which only works via HTTPS. 

Using a DNS API Proxy Challenge means that the domain you are grabbing an SSL for is not managed by the DNS provider, but instead, you are using another domain that IS managed as a proxy and using that other managed domains API credentials.

For this method to work you will need a domain that is managed by one of the DNS services with which we have integrations:

This method is an excellent way to still be able to use DNS API integrations for SSL provisioning when the domain in question is not managed.  

As this is a DNS API integration method, it does not actually require any DNS records to point to the IP of the server hosting the site, which makes it perfect for provisioning SSLs during migrations or for testing before DNS changeover.

GridPane does not enable/disable SSL for the site, but rather it manages SSL on a per-domain basis for each domain attached to a site. This means SSL management is done through the domains tab.

domains_ssl_toggles.png

In this Knowledge Base article, we will use a site’s primary domain to demonstrate, however, the same functionality and process is true for any added Alias and Redirect domains.

IMPORTANT

If you change your DNS API key you must replace the old key inside your GridPane with your new one to ensure that your Acme provisioned SSL certificates will be able renew successfully. If your API key is incorrect, Let's Encrypt will not be able to renew your SSL certificate, and if your SSL expires you will experience HTTPS issues that could make your website inaccessible or throw warnings.

Step 0. Sign up for an account at a DNS Provider

To use a DNS API integration to provision a SSL with GridPane, you will need to have an account with one of the supported DNS providers.

If you haven’t already you can sign up here:

Step 1. Store your DNS Provider API Keys in GridPane

Copy your Cloudflare API credentials

Login into your Cloudflare account and add a site to be managed or select an already managed site, then go to the overview page. 

overview.png

Then find the API section near the bottom of the page on the right section of the page.

Click Get your API token:

get_your_api_token.png

In the API section, copy your account email address from the Communication tab:

api_email.png

Then Click the API Tokens tab, and click View for the Global API Key:

api_token_view.png

Copy your API Key:

api_key_cf.png

Copy your DNSMadeeasy API credentials

Log in to your DNSMadeeasy account and then go to the account information page.

Copy the API Key and API Secret from the bottom of the account information page:

dnsme_api.png

Enter your DNS Service API credentials into your GridPane settings

Navigate to your GridPane Settings page and DNS Providers section:

gridpane_dns_settings.png

Enter your API credentials in their respective input fields and click Create:

api_inputs_gridpane.png

Your credentials will now be saved in your GridPane settings.

If you want to edit your credentials, to change, update or delete them you can use the buttons in each panel. 

Then pencil icon is for updating:

api_credentials_added.png

If you are using Custom/Vanity nameservers at your DNS provider

If you are using custom/vanity nameservers at your DNS provider, you will need to add these to your GridPane DNS API settings for that provider.

Click on the Nameserver Domain accordion dropdown for your DNS provider:

dnsme_nameserver_click.png

You will only need to enter the root domain of your namesevers. So if your nameservers are ns1.gridpane.com and ns2.gridpane.com then you will add gridpane.com and click create:

dnsme_nameserver.png

Step 2. Set the Challenge Domain in GridPane DNS API settings

You will be selecting one domain from each of your DNS managed domains and setting that in the DNS Providers API settings in GridPane settings.

This domain can be used by you for any domains that belong to any of your clients where you don’t have control of their domains, or they don’t wish to use a DNS management service.  In the next step, we will discuss the CNAME settings you need to make sure they set at their unmanaged domain’s DNS records, but first you need to set this domain in your GridPane settings.

In your DNS Providers settings page, for each DNS provider, you will see the Challenge Domain accordion dropdown, click on it to display the input field:

challenge_domain.png

Add the managed domain that you wish to use into the custom domain input field and click Create:

custom_domain.png

Your challenge domain will now be saved, and you will see that DNSME/Cloudflare Challenge API integration method is now available from the domains manager for your domains. You can edit and update the domain by clicking the pencil icon or delete it by clicking the cross:

custom_domain_saved.png

Step 3. Set DNS Challenge records at your site Domain DNS provider

This method is going to be using the DNS API of a managed domain, by proxy, to grab the SSL for a different unmanaged domain attached to your site.

That means we need to add the following CNAME record patterns to the unmanaged domains records. Like so:

_acme-challenge -> _acme-challenge.{managed-domain.url}
_acme-challenge.www -> _acme-challenge.{managed-domain.url}
_acme-challenge.staging -> _acme-challenge.{managed-domain.url}

Or as such

host: _acme-challenge
value: _acme-challenge.{managed-domain.url}
host: _acme-challenge.www
value: _acme-challenge.{managed-domain.url}
host: _acme-challenge.staging
value: _acme-challenge.{managed-domain.url}

In this article, we are provisioning a SSL for the domain an-example.site – this domain is not managed by DNSME or Cloudflare.

But we do have a domain gridpane.com that is managed by either DNSME or Cloudflare. 

Therefore the records we add would be as follows:

_acme-challenge -> _acme-challenge.gridpane.com
_acme-challenge.www -> _acme-challenge.gridpane.com
_acme-challenge.staging -> _acme-challenge.gridpane.com

Or as such:

host: _acme-challenge
value: _acme-challenge.gridpane.com
host: _acme-challenge.www
value: _acme-challenge.gridpane.com
host: _acme-challenge.staging
value: _acme-challenge.gridpane.com

Step 4. Go to the Sites Section of the GridPane Control Panel

Click on the sites link in the GridPane main menu to go to the Sites management page.

sites.png

Step 5. Open the Site Customization Panel for your Active site

In the Active Sites panel, click on the domain in the URL column to open the Site Customization pop up box for the site you wish to update.

click_site.png

Step 6. Ensure Domain Api Integration is set to Challenge Only

Open the domains manager tab of the site customizer

domains_manager.png

If the API Integration of the domain you wish to enable an SSL for is set to None then click on the grey None box

dns_none.png

This will open a modal window where you can choose either Cloudflare Challenge Only or DNSME Challenge Only to use DNS API domain verification by Proxy Challenge for your SSL provision:

dns_challenge_only.png

Once you have selected the DNS API Challenge only integration it should show in a green box on the domain row.

Cloudflare Challenge Only:

cloudflare_challenge.png

DNSME Challenge Only:

dnsme_challenge.png

Step 7. Enable SSL

Locate the SSL toggle for the domain that you wish to provision an SSL for:

challenge_ssl_off.png

Toggle it on:

challenge_toggle_it_on.png

GridPane will begin provisioning SSL for your site’s domain. You will see Notifications pop up in the top right corner of your browser as the SSL attempts progress.

dns_challenge_ssl_notify.png

Enabling an SSL can take some time, especially when using any DNS API method. Expect the SSL attempt to take several minutes.

You can keep track of the notifications as they inform you about the progress of the SSL attempt. Alternatively, you can check the SSL provision log, available from the logs tab of the site customizer. The SSL provision attempt outputs every step of the process to the log.

ssl_log.png

ssl_log_output.png

SSL Support


SSL Certificates Failures
For assistance with SSL certificate related issues, please ensure you attach the info from your SSL provisioning logs when contacting support so that we can quickly assess what's going on and assist you as fast and efficiently as possible.
How to Create a Support Ticket

DNS Checks / Console Output / Screenshots
Please provide as much relevant information as possible - check if your DNS is live, check console output on your site (right click > inspect element > console), and attach any relevant screenshots of errors.

Too Many Redirects Error
If you're using Cloudflare with GridPane, please ensure you have the correct SSL settings to prevent redirect errors:
How to use Cloudflare SSL with GridPane

SSL Locks and Rate Limiting
If multiple SSL attempts fail, GridPane will place an SSL lock to prevent you from getting rate limited by Let's Encrypt. It's important to assess why your SSL's are failing and correct the issue. Learn more about rate-limiting and how to remove locks here:
GridPane SSL Locks and Let’s Encrypt Rate Limiting

SSL Troubleshooting Guide
This article will help new users prevent common SSL issues, and learn how to diagnose the more complex ones.
Diagnosing and Fixing SSL Certificate Issues

Mixed Content / No Padlock
If you've provisioned an SSL but don't see a padlock, please check for images and/or other content being served over HTTP instead of HTTPS. It's likely you need to update your database to serve links over HTTPS:
Why Am I Not Seeing a Padlock on my Site?