Skip to content

Add a domain

Custom domains must be added to an environment’s VIP Dashboard in order to be used for launching a site or sending emails from an environment with that domain. After adding a custom domain, the domain must also be verified before DNS settings can be provided and a Let’s Encrypt certificate can be installed.

Prerequisites

To add a domain to an application’s environment, a user must have at minimum an Org member role or an App write role for that application.

Default behavior of domains

  • The fully qualified domain name (FQDN) for a site on the VIP Platform can be either the www or non-www variant of the domain. Whichever variant of the domain is added to the VIP Dashboard will be considered the FQDN.
  • When a domain is added to the VIP Dashboard, by default the www or non-www variant of the domain is also included and associated with the environment.
  • When a www variant of a subdomain or a sub-subdomain is added to the VIP Dashboard (e.g., www.admin.example.comwww.sub.admin.example.com) its non-www variant is also included.
  • When a non-www variant of a subdomain or a sub-subdomain—with a TLD matching .com.net, or .org—is added to the VIP Dashboard (e.g., admin.example.comsub.admin.example.com) its www variant is not added automatically. The www variant must be added separately.
  • The www version of a domain is actually a subdomain of the non-www (root) version of a domain. The DNS for both versions of the domain must be updated to point to VIP.
  • Redirects between the www or non-www variants of a domain are automatic on single sites but must be configured for multisites.
  • A site will not be publicly accessible at the new domain until the site is launched and DNS for the domain has been pointed to VIP.

Add a domain

Domains have specific application and environment associations.

  1. Navigate to the VIP Dashboard for the application that the domain should be associated with.
  2. Select the environment that the new domain will point to (e.g., production, develop) from the dropdown located at the upper left of the dashboard.
  3. Select “Domains & TLS” from the sidebar navigation at the left of the screen.
  4. Select the “Add Domain” button located in the upper right.
  5. Enter the domain into the available field and select “Add“.
  6. Within 10 minutes the added domain will appear in the list of domains associated with the environment.

After a domain has been added, the domain must be verified before DNS instructions can be accessed and before a Let’s Encrypt certificate can be installed. Only verified domains can be used for launching a site or sending emails.

Screenshot of the Domains and Certificates panel of the VIP Dashboard

Remove a domain

Remove a domain only after confirming that the domain is no longer being used to route public traffic to a site on the environment, and it is not being used to send emails from the environment.

  1. Navigate to the VIP Dashboard.
  2. Select the environment that the domain points to (e.g., production, develop) from the dropdown located at the upper left of the dashboard.
  3. Select “Domains & TLS” from the sidebar navigation at the left of the screen.
  4. Select the “•••” button located to the right of the domain.
  5. Select “Remove” from the overflow menu.
  6. Select the “Confirm” button to complete the removal.

Last updated: February 27, 2024

Relevant to

  • Node.js
  • WordPress