Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 5.93 KB

troubleshooting-custom-domains-and-github-pages.md

File metadata and controls

76 lines (50 loc) · 5.93 KB
title intro redirect_from product versions topics shortTitle
Troubleshooting custom domains and GitHub Pages
You can check for common errors to resolve issues with custom domains or HTTPS for your {% data variables.product.prodname_pages %} site.
/articles/my-custom-domain-isn-t-working
/articles/custom-domain-isn-t-working
/articles/troubleshooting-custom-domains
/articles/troubleshooting-custom-domains-and-github-pages
/github/working-with-github-pages/troubleshooting-custom-domains-and-github-pages
{% data reusables.gated-features.pages %}
fpt ghec
*
*
Pages
Troubleshoot a custom domain

CNAME errors

If you are publishing from a custom {% data variables.product.prodname_actions %} workflow, any CNAME file is ignored and is not required.

If you are publishing from a branch, custom domains are stored in a CNAME file in the root of your publishing source. You can add or update this file through your repository settings or manually. For more information, see AUTOTITLE.

For your site to render at the correct domain, make sure your CNAME file still exists in the repository. For example, many static site generators force push to your repository, which can overwrite the CNAME file that was added to your repository when you configured your custom domain. If you build your site locally and push generated files to {% data variables.product.github %}, make sure to pull the commit that added the CNAME file to your local repository first, so the file will be included in the build.

Then, make sure the CNAME file is formatted correctly.

  • The CNAME filename must be all uppercase.
  • The CNAME file can contain only one domain. To point multiple domains to your site, you must set up a redirect through your DNS provider.
  • The CNAME file must contain the domain name only. For example, www.example.com, blog.example.com, or example.com.
  • The domain name must be unique across all {% data variables.product.prodname_pages %} sites. For example, if another repository's CNAME file contains example.com, you cannot use example.com in the CNAME file for your repository.

DNS misconfiguration

If you have trouble pointing the default domain for your site to your custom domain, contact your DNS provider.

You can also use one of the following methods to test whether your custom domain's DNS records are configured correctly:

  • A CLI tool such as dig. For more information, see AUTOTITLE.
  • An online DNS lookup tool.

Custom domain names that are unsupported

If your custom domain is unsupported, you may need to change your domain to a supported domain. You can also contact your DNS provider to see if they offer forwarding services for domain names.

Make sure your site does not:

  • Use more than one apex domain. For example, both example.com and anotherexample.com.

  • Use more than one www subdomain. For example, both www.example.com and www.anotherexample.com.

  • Use both an apex domain and custom subdomain. For example, both example.com and docs.example.com.

    The one exception is the www subdomain. If configured correctly, the www subdomain is automatically redirected to the apex domain. For more information, see AUTOTITLE.

{% data reusables.pages.wildcard-dns-warning %}

For a list of supported custom domains, see AUTOTITLE.

HTTPS errors

{% data variables.product.prodname_pages %} sites using custom domains that are correctly configured with CNAME, ALIAS, ANAME, or A DNS records can be accessed over HTTPS. For more information, see AUTOTITLE.

It can take up to an hour for your site to become available over HTTPS after you configure your custom domain. After you update existing DNS settings, you may need to remove and re-add your custom domain to your site's repository to trigger the process of enabling HTTPS. For more information, see AUTOTITLE.

If you're using Certification Authority Authorization (CAA) records, at least one CAA record must exist with the value letsencrypt.org for your site to be accessible over HTTPS. For more information, see Certificate Authority Authorization (CAA) in the Let's Encrypt documentation.

URL formatting on Linux

If the URL for your site contains a username or organization name that begins or ends with a dash, or contains consecutive dashes, people browsing with Linux will receive a server error when they attempt to visit your site. To fix this, change your {% data variables.product.github %} username to remove non-alphanumeric characters. For more information, see AUTOTITLE.

Browser cache

If you've recently changed or removed your custom domain and can't access the new URL in your browser, you may need to clear your browser's cache to reach the new URL. For more information on clearing your cache, see your browser's documentation.

Domain name taken

If you're trying to use a custom domain and it says the domain is already in use, you can make the domain available for your own use by verifying it first. For more information, see AUTOTITLE.