How to set up custom domains for Retool apps?

Setting Up Custom Domains for Retool Apps

Integrating a custom domain with your Retool apps involves several technical steps, requiring DNS configuration, and validation through Retool’s platform. Below is a detailed guide on setting up custom domains for your Retool applications.

Prerequisites

• Access to a DNS management interface for your domain provider (e.g., GoDaddy, Namecheap, etc.).
• An existing Retool account with administrative privileges.
• A live Retool app that you wish to assign a custom domain to.

Accessing the Custom Domain Settings in Retool

• Log into your Retool account and navigate to the app you want to configure.
• Access the settings or admin panel for your Retool organization.
• Locate the ‘Custom Domain’ section. This is typically found under either the 'App Settings' or 'Account Settings' menu, depending on your Retool version.

Configuring DNS Records

• Log into your domain provider’s DNS management portal.
• Create a new CNAME record where:
  • The host name is typically 'www' (or the subdomain you wish to use).
  • The value or points to field is the CNAME provided by Retool (e.g., custom.retool.com). This links your domain with Retool's servers.
• If you are using an apex domain (e.g., example.com without www), additional steps are needed. Typically this requires setting up an A record pointing to a specific IP address advised by Retool.

Validating Your Domain

• After updating the DNS records, go back to Retool’s Custom Domain settings page.
• Enter the custom domain you configured in your DNS settings.
• Retool will verify your setup by checking the DNS records. This can take up to 48 hours depending on DNS propagation time.

Enabling HTTPS for Secure Connections

• Once your domain is verified, Retool automatically provisions an SSL certificate via Let's Encrypt.
• You may need to check that HTTPS is enforced on your domain, ensuring all traffic is encrypted.
• Depending on your Retool settings, there may be an option to redirect all HTTP requests to HTTPS to maintain security.

Troubleshooting Common Issues

• If the domain verification process fails, double-check your DNS configurations:
  • Ensure CNAME or A records point correctly to Retool’s servers.
  • Remember DNS changes may take some time to propagate globally, sometimes up to 48 hours.
• Ensure that there are no conflicting DNS settings like previous entries that might override the new configurations.

Testing the Custom Domain Setup

• Once successfully configured and SSL certificates are active, test the accessibility of your Retool app using the custom domain.
• Check for any mixed content warnings in the browser which might indicate HTTP content being loaded alongside HTTPS.
• Perform end-to-end testing to ensure all functionalities in your app work seamlessly under the custom domain.

Maintaining Custom Domain Integrations

• Monitor SSL certificate renewals which Retool typically automates via Let’s Encrypt. Failure in renewal might result in certificate errors.
• If you decide to change domain providers, replicate DNS settings to avoid downtime.

By following these steps, you'll successfully set up a custom domain for your Retool applications, thus enhancing brand alignment and user engagement through a consistent domain presentation. Always remember to frequently verify DNS settings for optimal performance.