By default, all deployments are assigned a .vercel.app suffixed domain.

This domain can be replaced with a Custom Domain of your choice. This Custom Domain can be purchased with Vercel or a third-party.

In this document, adding a domain to your Vercel projects is explained in detail.

If you want to migrate an existing domain to Vercel, read our Knowledge Base article on Zero-Downtime Migration for DNS.

Adding a Domain

If you don't own a domain yet, you can purchase it with Vercel. Then, once you own a domain, adding it to a project is very straightforward:

Step 1: Selecting Your Project

On the dashboard, pick the project to which you would like to assign your domain:

Selecting the project from the Vercel Dashboard.

Step 2: Navigating to Domain Settings

Once you have selected the project of your choice, click on the Settings tab:

Selecting the Settings tab from the Project Overview page.

Then, select the Domains menu item:

Selecting the Domains menu item from the Project Settings page.

Step 3: Entering Your Chosen Domain

From the Domains page, enter the domain you wish to add to the project:

Entering a domain for the project from the Domains page.

Step 4: Configuring the Domain

Once the domain has been added, you will be presented with different methods for configuring it, depending on whether it is an apex domain (example.com) or subdomain (docs.example.com).

Apex domains can be configured with a A record, while subdomains can be configured with a CNAME record. Both domain types can also be configured using the Nameservers method.

Apex Domains

You can configure apex domains either with a A record or through the Nameservers method.

Instructions on configuring an apex domain from the Project Domains page.

Subdomains

You can configure subdomains either with a CNAME record or through the Nameservers method.

Instructions on configuring a subdomain from the Project Domains page.

Vercel Nameservers

When selecting the Nameservers method of configuration for either apex domains or subdomains, you will be provided with the Vercel nameservers to copy and use with your registrar.

For your convenience, you can also find these listed below:

ns1.vercel-dns.com
ns2.vercel-dns.com

The Vercel nameservers that you can use to configure your domain.

Step 5: Domain Configured

Once the domain has been configured, the card status will change to reflect this.

A configured domain on the Project Domains page.

If a user visits your domain with or without the "www" subdomain prefix, we will attempt to redirect them to your domain. For more robust protection, you should explicitly add this domain and redirect it.

DNS Records

Once a domain has been added, all of its DNS Records can be found in the Advanced Settings page. From there, you can view and manage the records.

Step 1: Selecting your Domain

On the dashboard, click on the Domains tab:

Selecting the Domains tab from the Vercel Dashboard page.

Once on the Domains tab, click on a domain of your choice to view its Advanced Settings page.

Selecting the domain to view its Advanced Settings page.

Step 2: Add DNS Record

Once on the Advanced Settings page of your domain, fill out the DNS Record form and click on the Add button.

DNS Records form to add a new DNS Record.

Using the form mentioned above, you can then add the DNS Record of your choice. The following types are supported:

  • A
  • AAAA
  • ALIAS
  • CAA
  • CNAME
  • MX
  • SRV
  • TXT

DNS Email Presets

To be able to receive emails through a Domain that you've added to Vercel, you need to add the respective DNS Records of type MX.

For most common third-party email providers, Vercel makes this process really easy, because you can add those missing DNS Records using so-called DNS Email Presets on your dashboard.

In order to make use of them, navigate to the Domains page of your Personal Account or Team, click the Domain of your choice and click the Add Email Preset button on the right:

Adding a DNS Email Preset by clicking the Add Email Preset button.

You will be presented with a list of commonly used third-party email providers. If yours is in the list, select it and the necessary MX DNS Records will automatically be configured on your Domain.

If your email provider is not in the list, please refer to their documentation and dashboard to find out which MX DNS Records you need to add.

Wildcard Domains

You can use your Custom Domain as a Wildcard Domain by prefixing it with *..

Warning: If using your Custom Domain as a Wildcard Domain, you must use the nameservers method for verification.

To add a Wildcard Domain, follow the steps to add a domain. At step 3, use the prefix * (e.g. *.acme.com).

A Wildcard Domain being deployed.

After the verification process is complete, the status of the domain will be updated within the UI to confirm that it is ready for use.

Deploying with Your Domain

Once the domain has been added to your project and configured, it is automatically applied to your latest deployment.

Note: The first deployment of a new project will be marked as production and subsequently assigned with your custom domain automatically.

When a Custom Domain is assigned to a project that's using Git, each push (including merges) to the Production Branch (commonly main) will trigger a deployment to the defined domain.

Reverts take effect immediately, assigning the Custom Domain to the deployment made prior to the point the revert is effective from.

Redirecting Domains

You can add domain redirects from the Domains tab when more than one domain is present in the project. This provides a way to, for example, redirect a www subdomain to an apex domain, but can be used in a variety of ways.

If a user visits your domain with or without the "www" subdomain prefix, we will attempt to redirect automatically. You might still want to add this redirect explicitly.

To add a redirect, click the Edit button on the domain you want to redirect from and use the Redirect to dropdown to select the domain you want to redirect to:

A domain redirect that redirects requests made to www.acme.com to acme.com.

Redirect Status Codes

A domain redirect can be temporary or permanent by specifying a status code.

  • 307 Temporary Redirect - not cached by client, method and body never changed.
  • 302 Found - not cached by client, method may or may not be changed to GET.
  • 308 Permanent Redirect - cached by client, method and body never changed.
  • 301 Moved Permanently - cached by client, method may or may not be changed to GET.

We recommend using status code 307 or 308 to avoid the ambiguity of non-GET methods, which is necessary when your application needs to redirect a public API.

Internet Explorer on Windows 8 and older does not support 308 natively, but Vercel supports older browsers by adding a Refresh header.

Redirecting www Domains

Adding an apex domain to a Project on Vercel will automatically suggest adding its www counterpart. Using both of these domains ensures that visitors can always access your site, regardless of whether or not they use www when entering the URL.

After clicking "Add" for a domain, you will be able to choose how to redirect the www counterpart:

Selecting the Domains tab from the Vercel Dashboard.

We recommend using the www subdomain as your primary domain, with a redirect from the non-www domain to it. This allows the Vercel Edge Network more control over incoming traffic for improved reliability, speed, and security. The redirect is also cached on visitor's browsers for faster subsequent visits.

Some browsers like Google Chrome automatically hide the www subdomain from the address bar, so this redirect may not affect your URL appearance.

Choosing to redirect the www domain to the non-www also works but provides Vercel less control over incoming traffic. Alternatively, you can choose to add only the domain you typed.

Additional technical information about Domain redirects

Using CNAME instead of A records ensures that domains on Vercel are fast, reliable, and fault-tolerant.

Unlike A records, CNAME records avoid hard-coding a specific IP address in favor of an additional lookup at the DNS level. This means that Vercel can quickly steer traffic in the case of DDoS attacks or for performance optimizations.

Unfortunately, the DNS spec forbids using CNAME records on apex domains like example.com. They are, however, allowed for subdomains like www.example.com. This is why Vercel recommends primarily using a www domain with a CNAME record, and adding a redirect from the non-www domain to it.

While we recommend using www as described above, Vercel maximizes the reliability and performance of your apex domain if you choose to use it as your primary domain by leveraging the Anycast methodology. This means Vercel still supports geographically routed traffic at infinite scale if you use an A record.

Renewing Domains

Custom Domains purchased through or registered with Vercel are automatically renewed by default. You can choose to prevent the automatic renewal of a Domain from the Domains tab on the Vercel Dashboard:

Selecting the Domains tab from the Vercel Dashboard.

Once on the Domains tab, click on a Domain of your choice to view its Advanced Settings:

Selecting the Domain to view its Advanced Settings.

The auto renewal status of your Domain is displayed here as either "on" or "off":

The auto renewal status for this Domain is currently off.

You can toggle auto renewal from the details menu in the top right:

The menu item for toggling the auto renewal status of your Domain.

Auto Renewal Off

If auto renewal is off, Vercel will not try to re-register the Domain when it expires at the end of the registration period. You will not be charged for the Domain any longer, but you will lose access to the Domain when it expires. Recovering the Domain, if even possible, may be subject to a redemption fee of $85 USD. Please contact our support team as soon as possible.

Vercel will send you three emails regarding the Domain before this happens. 24 and 14 days before the Domain is set to expire, you will be notified that auto renewal is off and the Domain will expire soon. A final email will notify you when the Domain expires.

Auto Renewal On

If auto renewal is on, Vercel will begin daily attempts to renew the domain one week before the domain expires. You will receive three emails regarding the renewal process: 17 days and 7 days before renewal attempts begin, and finally when the Domain has either been successfully renewed or failed to renew.

Note: Renewal attempts may begin earlier than 7 days in advance for certain TLDs.

Third-Party Domains

Third-Party Domains (ones not purchased with or transferred into Vercel) are not subject to auto-renewal. Please refer to your Domain name registrar's policy regarding renewals.

Moving Domains

You can move domains to another profile or team using the Domains tab from the Vercel Dashboard.

Selecting the Domains tab from the Vercel Dashboard page.

Once on the Domains tab, select the domain(s) you wish to move by using the checkbox next to each domain then click Move.

Selecting which domains to move from the Domains tab.

After selecting the domain(s) and clicking Move, you will be asked to confirm which profile or team you wish to move them to.

Entering a new profile or team destination for a domain.

When selecting the input field, you will be provided with a list of teams you belong to. If the profile or team you wish to move the domain(s) to is not present, enter the slug value instead. You can find the slug value in Settings page for both profiles and teams.

Warning: When moving domains to another team or profile, they will be removed from all projects they are currently part of.

To confirm the change, select Move. The domains will be transferred to the new profile of team immediately.

Transferring Domains Out

For domains that are registered with Vercel, you can retrieve an authorization code for transferring out to another registrar from the Domains tab of the Vercel dashboard.

Selecting the Domains tab from the Vercel Dashboard page.

Once on the Domains tab, click on the triple-dot menu trigger button for the relevant domain, a menu-item button to transfer the domain out will be presented if the domain is registered with Vercel.

Menu item button for getting domain's transfer authorization code.

Note: If under a team scope, only Owners will see the menu-item button.

After clicking the menu-item button, a modal will open up with the authorization code required to transfer the domain. Transferring a domain can take up to a week.

Menu item button for getting domain's transfer authorization code.

Assigning a Domain to a Git Branch

Every commit pushed to the Production Branch of your connected Git repository will be assigned the domains configured in your project.

In order to automatically assign a domain to a different branch, you can enter it in the Git Branch field of your Domain:

A Custom Domain that is automatically assigned to the staging Git Branch.

Removing a Domain

To remove a domain that is assigned to a project, navigate to the Domains tab from the Project Overview and click the Edit button for the domain you want to remove:

A configured domain on the Project Domains page with the option to edit.

Once the Edit button has been clicked, you will be presented with further options. Click the Remove button to remove the domain from the project:

A configured domain on the Project Domains page with the option to remove.

Provider Specific Instructions

Cloudflare

To use Cloudflare-managed domains, follow these steps:

  1. Configure your domain such that SSL is disabled for the path /.well-known/**.
  2. Run curl http://<domain>/.well-known/acme-challenge (Replace <domain> with your domain. Notice that it’s http and not https).

If the above curl command returns an error (e.g. {"error":{...}}), then you’re good to go - it means that Vercel can generate certificates successfully. Otherwise, make sure that SSL is disabled for /.well-known/** and try again.

Related

For more information on what to do next, we recommend the following article:


Last Edited on April 13th 2021