Skip to main content

Before you start

  • Sign in to Peak as an Admin.
  • Use a domain where you can add DNS records.

Set the domain

  1. Open Previews.
  2. Open your repository.
  3. Under Preview domain, enter your domain.
  4. Select Save.
Use one domain for each repository.

Add the DNS records

Add the two CNAME records that Peak shows under Preview domain. Set both records to DNS only. Do not proxy them. Keep both records. Peak renews the certificate with the first one.

Check the status

Expect the certificate to fail if the first record is missing for 72 hours.

Open a preview

Expect each pull request preview at its number on your domain.
Expect Peak to use this URL in the pull request comment, the GitHub deployment, and the preview URL variables. Expect the peakview.now URL to keep working. Expect the default branch preview to stay on peakview.now.

Remove the domain

  1. Open your repository in Previews.
  2. Under Preview domain, select Remove.
  3. Select Remove again.
Expect previews to stop loading on your domain. Then delete both DNS records.