Add a custom domain to a branch

In this guide, you will learn how to add a custom domain (staging.example.com) that will point to a specific branch (staging) on your Pages project.

This will allow you to have a custom domain that will always show the latest build for a specific branch on your Pages project.

Note

Currently, this setup is only supported when using Cloudflare DNS.

If you attempt to follow this guide using an external DNS provider, your custom alias will be sent to the production branch of your Pages project.

First, make sure that you have a successful deployment on the branch you would like to set up a custom domain for.

Next, add a custom domain under your Pages project for your desired custom domain, for example, staging.example.com.

To do this:

1. Log in to the Cloudflare dashboard ↗.
2. In Account Home, go to Workers & Pages.
3. Select your Pages project.
4. Select Custom domains > Setup a custom domain.
5. Input the domain you would like to use, such as staging.example.com
6. Select Continue > Activate domain

After activating your custom domain, go to DNS ↗ for the example.com zone and find the CNAME record with the name staging and change the target to include your branch alias.

In this instance, change your-project.pages.dev to staging.your-project.pages.dev.

Now the staging branch of your Pages project will be available on staging.example.com.