Free cookie consent management tool by TermsFeed Configuring a Custom Domain for Portals [Appian Portals]
Configuring a Custom Domain for Portals
The capabilities described on this page are included in Appian's standard capability tier. Usage limits may apply.

Overview

Note:  Custom domains for portals are only available to customers on Essential, Advanced, or Enterprise support.

By default, all portals have a set URL that uses the Appian environment name for the subdomain and appianportals.com for the domain. For example, if an environment is called insurecorp, the URLs for portals published from the environment will use insurecorp.appianportals.com.

This works well for many use cases. However, some organizations prefer to have more control over the URLs for their portals. That's where custom domains come in.

Using a custom domain, you can configure your portal URLs to use a domain that you define. So the above example could use web.insurecorp.com instead of insurecorp.appianportals.com.

example of a custom domain

This page outlines how to configure a custom domain that all portals in your environment will use.

Choosing a hostname

The hostname is how you define the URL to use for the portals in your environment. It should consist of a subdomain, a domain, and a top-level domain. For example, in web.insurecorp.com, the subdomain is web, the domain is insurecorp, and the top-level domain is com.

hostname example

When you choose a hostname, make sure it meets the following criteria:

  • The hostname must be different from the hostname for the Appian environment.
    • If you have a custom domain for your Appian environment, the domain can be the same as long as the subdomain is different. For example, you can use mysites.insurecorp.com for your Appian environment and myportals.insurecorp.com for your portals.
  • The hostname must not contain the string appian.
  • The hostname must include exactly one subdomain. Note that www is considered a subdomain.
  • The subdomain cannot be more than 63 characters.

DNS and certificate requirements

Make sure the DNS infrastructure resolving your domain is publicly accessible. Otherwise, certificate signing will fail, and end users will be unable to access the portal.

If you have a Certification Authority Authorization (CAA) record configured for your domain, make sure it lists Amazon certificate authorities as authorized. Otherwise, certificate signing will fail.

Appian does not support wildcard certificates, meaning the certificate must not use wildcard characters in the hostname.

Configure a custom domain for your portals

You can configure one custom domain per environment. Appian Support will work with you to create a certificate and configure your environment to use the domain.

Once configured, all portals published from the environment will use the custom domain.

To configure a custom domain for your portals:

  1. Open a support case with Appian Support. Include the hostname you would like your portals to use and request a certificate for the hostname.
    • Appian Support will provide you with two canonical name (CNAME) records. One will be used to validate the certificate with AWS Certificate Manager and the other will be used to resolve the portal's hostname to Appian's infrastructure.
  2. Create the provided CNAME records in your DNS infrastructure.
  3. Update the support case to indicate that you have created the records.
    • Appian Support will configure your environment to use the custom domain and schedule a maintenance window to restart the environment. After the environment restarts, the published portals in the environment will automatically republish. After they republish, they will use the custom domain.

Certificates and renewal

The certificates are created and hosted in AWS Certificate Manager (ACM). They are signed by an Amazon certificate authority, and the private key cannot be exported from AWS.

Because the certificate is created and hosted in ACM, it will be automatically renewed if the following conditions are met:

  • The DNS records used to validate the certificate remain in place.
  • The certificate is in use when it is nearing expiration and ready to be renewed.
  • If you have a CAA record configured for your domain, it lists Amazon certificate authorities as authorized.

If the certificate expires due to one of the criteria not being met, open a support case with Appian Support to create a new certificate.

Open in Github Built: Fri, Apr 12, 2024 (09:33:24 PM)

Configuring a Custom Domain for Portals

FEEDBACK