Customize error and maintenance pages

Last update: 2023-05-25
  • Created for:
  • Admin
    Developer

When a request to the Fastly origin fails, Fastly returns default response pages with basic formatting and generic messaging that can be confusing for users. For example, Fastly returns the following default error page when a request to the Fastly origin fails because of a 503 error.

Fastly default error page

You can update your Adobe Commerce store configuration to replace some default response pages with pages that have friendlier messaging and improved HTML styling as shown in the following example.

Fastly custom error page

Currently, you can customize the following Fastly response pages for your Adobe Commerce on cloud infrastructure project.

HTML coding requirements:

The HTML code for the custom page must meet the following requirements:

  • Content can contain up to 65,535 characters.
  • Specify all CSS inline in the HTML source.
  • Bundle images in the HTML page using base64 so that they display even if Fastly is offline. See Data URIs on the css-tricks site.

Customize the 503 error page

Customers see the default 503-error page in the following cases:

  • When a request to the Fastly origin returns a response status greater than 500
  • When the Fastly origin is down, such as a timeout, maintenance activity, or health issues

You can customize the default page by adapting the following HTML code to include styling to match your Adobe Commerce store theme and modifying the title and messaging as needed.

<!DOCTYPE html>
<html>
   <head>
      <meta charset="UTF-8">
         <title>503</title>
   </head>
   <body>
      <p>Service unavailable</p>
   </body></html>

Verify that the modified source displays correctly in the browser. Then, add the customized HTML code to the Fastly configuration.

To add the custom response page to the Fastly configuration:

  1. Log in to the Admin.

  2. Select Stores > Settings > Configuration > Advanced > System.

  3. In the right pane, expand Full Page Cache > Fastly Configuration > Custom Synthetic Pages.

    Edit 503 error page

  4. Select Set HTML.

  5. Copy and paste the source code for your custom response page into the HTML field.

    Update 503 error page

  6. Select Upload at the top of the page to upload the customized HTML source to the Fastly server.

  7. Select Save Config at the top of the page to save the updated configuration file.

  8. Refresh the cache.

    • In the notification at the top of the page, select the Cache Management link.

    • On the Cache Management page, select Flush Magento Cache.

Customize the WAF error page

Customers see the following default WAF error page when a request to the Fastly origin fails with a 403 Forbidden error caused by a WAF blocking event.

WAF error page

The following code sample shows the HTML source for the default page:

<html>
  <head>
    <title>Magento 403 Forbidden</title>
  </head>
  <body>
    <p>The requested URL was rejected.</p>
    <p>For additional information, please contact support and provide this reference ID:</p>
    <p>"} req.http.x-request-id {"</p>
    <p><button onclick='history.back();'>Go Back</button></p>
  </body>
</html>

You can use the Custom Synthetic Pages > Edit WAF page option in the Fastly configuration menu to customize the default code for your Adobe Commerce on cloud infrastructure project. When you edit the code, retain the following line that provides the reference ID for the WAF blocking event:

<p>"} req.http.x-request-id {"</p>
NOTE

The Edit WAF option is available only if the Managed Cloud WAF service is enabled for your Adobe Commerce on cloud infrastructure project.

To edit the WAF error page:

  1. Log in to the Admin.

  2. Select Stores > Settings > Configuration > Advanced > System.

  3. In the right pane, expand Full Page Cache > Fastly Configuration > Custom Synthetic Pages.

    Edit WAF error page option

  4. Select Edit WAF page.

  5. Complete the fields to update the HTML.

    Update WAF error page

    • Status — Select the 403 Forbidden status.
    • MIME type — Type text/html.
    • Content — Edit the default HTML response to add custom CSS and update the title and messaging as needed.

  6. Select Upload at the top of the page to upload the customized HTML source to the Fastly server.

  7. Select Save Config at the top of the page to save the updated configuration file.

  8. Refresh the cache.

    • In the notification at the top of the page, select the Cache Management link.

    • On the Cache Management page, select Flush Magento Cache.

Display error report number

By default, Fastly hides all Adobe Commerce errors behind the 503 Service Unavailable error. To display the error log report number so that you can find and review the error details in the logs, open the website omitting Fastly using these steps:

  1. Retrieve the IP address of your store:

    • For Pro Staging and Production environments:

      nslookup {your_project_id}.ent.magento.cloud

    • For Pro Integration environments and Starter environments:

      nslookup gw.{your_region}.magentosite.cloud

  2. Add your application domain and IP address to the hosts file on your local workstation:

    {server_IP} {store_domain}

  3. Clear the browser cache and cookies (or switch to incognito mode).

  4. Open your store website again to view the error code.

  5. Use the error code to find the details in the error report file:

Previous page
Next page

On this page