Follow

Creating Custom Error Pages (Private Deployments)

The Distil platform may at times serve pages back to the browser which indicate that the Distil appliance did not receive a response from the origin, was not able to establish a connection, or received an invalid response or disconnect.

The Distil platform offers the ability to customize these error pages with your own branding in order to maintain a consistent user experience.  Error pages are "account wide"--they are not customizable on a per domain basis.  

The following error pages can be customized for all private deployment accounts:

  • Catch-all – An error page presented when a request is not able to be proxied for various reasons. Returns a HTTP status code 403 (no configuration for the requested domain) or HTTP status code 400 (unable to proxy the request).
  • Non-Proxied Error – An error page presented for non-proxied error pages in situations like upstream timeouts, premature termination of the HTTP connection from the upstream, or invalid or oversized response from origin.

You can easily integrate your custom pages with Google Analytics to gain visibility into the number of visitors each custom page is receiving.

NOTE:  Errors returned by origin will be returned to the browser as received.

NOTE: Only Account level administrators can manage settings for custom Catch-all and Error pages.

Creating a Custom 'Catch-all' Page

The default Catch-­all page is the page you receive when accessing the box by IP directly or when your Distil appliance receives a request that it cannot proxy ahead.  This can be due to a request for a domain not configured on the Distil appliance, or one that cannot be proxied for sending too large headers as an example.

This page is fetched only when configured. Any images, css, or other assets that these pages require should either be served via a CDN or embedded in the HTML itself as these pages are only served when the Distil appliance does not know the which domain is requested.

Create a custom HTML page with your domain’s branding. At the bottom of the page, include the following HTML comment strings in the <body> of the your page:

<!-- DISTIL REQUEST ID -->
<!-- DISTIL SERVER ID -->

Using these comments instructs the Distil node to replace this text with details on the error displayed.

To set up a Custom 'Catch-all' page:

  1. Log in to the Distil Portal.
  2. Search for and select the parent Domain or Account you are configuring.
  3. Select Sign Into Account to access the Domains Dashboard.
  4. Select the specific domain you are configuring.

  5. Click Settings in the top banner menu.

  6. Click Custom Pages, within the Protect your content section.

  7. Enter the page's relative link in the URL for custom deployment page field.
  8. Click Save.
  9. Test your custom catch-all page before moving your page to production.
  10. When you are ready to push your page to production, select Enabled? and click Save.

Creating a Custom Error Page

Available to private deployment customers, Custom Error pages are shown in the event of an error accessing your origin server. These pages are served when your Distil appliance returns a non­proxied status code of 400, 494, 500, 502, 503, and 504.

This page is fetched only when configured. Any images, css, or other assets that these pages require should either be served via a CDN or embedded in the HTML itself as these pages are generally only served when the origin is unavailable.

Create a custom HTML page with your domain’s branding. At the bottom of the page, include the following HTML comment strings in the <body> of the page:

<!-- DISTIL REQUEST ID -->

<!-- DISTIL SERVER ID -->

<!-- DISTIL STATUS -->

Using these comments instructs the Distil node to replace this text with details on the error displayed.

To set up a Custom Error page:

  1. Log in to the Distil Portal.
  2. Search for and select the parent Domain or Account you are configuring.
  3. Select Sign Into Account to access the Domains Dashboard.
  4. Select the specific domain you are configuring.

  5. Click Settings in the top banner menu.

  6. Click Custom Pages, within the Protect your content section.

  7. Enter the page's relative link in the URL for custom error page field.
  8. Click Save.
  9. Test your custom error page before moving your page to production.
  10. When you are ready to push your page to production, select Enabled? and click Save.

 

Testing Custom Error Pages

Before going live with your custom pages, it's important that you test them to make sure they have a look and feel in line with your website. Whether you've enabled your custom pages live or not, you can test them at the following example URLs:

Catch-all page

http://your_appliance_ip/distil/dev/deployment.html

Error page

http://[your-domain]/distil/dev/error.html

These pages are fetched when the configured.  To change the page, update the URL configured in the Distil portal to force a new fetch of the page.

Note:  Error pages are testable on a per-domain basis, but only one error page is supported per account.

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments