7.8 KiB
title, intro, redirect_from, product, versions, topics, shortTitle
| title | intro | redirect_from | product | versions | topics | shortTitle | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Managing a custom domain for your GitHub Pages site | You can set up or update certain DNS records and your repository settings to point the default domain for your {% data variables.product.prodname_pages %} site to a custom domain. |
|
{% data reusables.gated-features.pages %} |
|
|
Manage a custom domain |
People with admin permissions for a repository can configure a custom domain for a {% data variables.product.prodname_pages %} site.
About custom domain configuration
Make sure you add your custom domain to your {% data variables.product.prodname_pages %} site before configuring your custom domain with your DNS provider. Configuring your custom domain with your DNS provider without adding your custom domain to {% data variables.product.product_name %} could result in someone else being able to host a site on one of your subdomains.
{% windows %}
The dig command, which can be used to verify correct configuration of DNS records, is not included in Windows. Before you can verify that your DNS records are configured correctly, you must install BIND.
{% endwindows %}
{% note %}
Note: DNS changes can take up to 24 hours to propagate.
{% endnote %}
Configuring a subdomain
To set up a www or custom subdomain, such as www.example.com or blog.example.com, you must add your domain in the repository settings, which will create a CNAME file in your site’s repository. After that, configure a CNAME record with your DNS provider.
{% data reusables.pages.navigate-site-repo %}
{% data reusables.repositories.sidebar-settings %}
{% data reusables.pages.sidebar-pages %}
4. Under "Custom domain", type your custom domain, then click Save. This will create a commit that adds a CNAME file in the root of your publishing source.
5. Navigate to your DNS provider and create a CNAME record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain www.example.com for your user site, create a CNAME record that points www.example.com to <user>.github.io. If you want to use the subdomain www.anotherexample.com for your organization site, create a CNAME record that points www.anotherexample.com to <organization>.github.io. The CNAME record should always point to <user>.github.io or <organization>.github.io, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %}
{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %}
{% data reusables.command_line.open_the_multi_os_terminal %}
6. To confirm that your DNS record configured correctly, use the dig command, replacing WWW.EXAMPLE.COM with your subdomain.
$ dig <em>WWW.EXAMPLE.COM</em> +nostats +nocomments +nocmd
> ;<em>WWW.EXAMPLE.COM.</em> IN A
> <em>WWW.EXAMPLE.COM.</em> 3592 IN CNAME <em>YOUR-USERNAME</em>.github.io.
> <em>YOUR-USERNAME</em>.github.io. 43192 IN CNAME <em> GITHUB-PAGES-SERVER </em>.
> <em> GITHUB-PAGES-SERVER </em>. 22 IN A 192.0.2.1
{% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %}
Configuring an apex domain
To set up an apex domain, such as example.com, you must configure a CNAME file in your {% data variables.product.prodname_pages %} repository and at least one ALIAS, ANAME, or A record with your DNS provider.
{% data reusables.pages.www-and-apex-domain-recommendation %} For more information, see "Configuring a subdomain."
{% data reusables.pages.navigate-site-repo %}
{% data reusables.repositories.sidebar-settings %}
{% data reusables.pages.sidebar-pages %}
4. Under "Custom domain", type your custom domain, then click Save. This will create a commit that adds a CNAME file in the root of your publishing source.
5. Navigate to your DNS provider and create either an ALIAS, ANAME, or A record. {% data reusables.pages.contact-dns-provider %}
- To create an ALIAS or ANAME record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %}
- To create A records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}.
shell 185.199.108.153 185.199.109.153 185.199.110.153 185.199.111.153
{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %}
{% data reusables.command_line.open_the_multi_os_terminal %}
6. To confirm that your DNS record configured correctly, use the dig command, replacing EXAMPLE.COM with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above.
$ dig <em>EXAMPLE.COM</em> +noall +answer
> <em>EXAMPLE.COM</em> 3600 IN A 185.199.108.153
> <em>EXAMPLE.COM</em> 3600 IN A 185.199.109.153
> <em>EXAMPLE.COM</em> 3600 IN A 185.199.110.153
> <em>EXAMPLE.COM</em> 3600 IN A 185.199.111.153
{% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %}
Configuring an apex domain and the www subdomain variant
When using an apex domain, we recommend configuring your {% data variables.product.prodname_pages %} site to host content at both the apex domain and that domain's www subdomain variant.
To set up a www subdomain alongside the apex domain, you must first configure an apex domain, which will create an ALIAS, ANAME, or A record with your DNS provider. For more information, see "Configuring an apex domain."
After you configure the apex domain, you must configure a CNAME record with your DNS provider.
- Navigate to your DNS provider and create a
CNAMErecord that pointswww.example.comto the default domain for your site:<user>.github.ioor<organization>.github.io. Do not include the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} - To confirm that your DNS record configured correctly, use the
digcommand, replacing WWW.EXAMPLE.COM with yourwwwsubdomain variant.
$ dig <em>WWW.EXAMPLE.COM</em> +nostats +nocomments +nocmd
> ;<em>WWW.EXAMPLE.COM.</em> IN A
> <em>WWW.EXAMPLE.COM.</em> 3592 IN CNAME <em>YOUR-USERNAME</em>.github.io.
> <em>YOUR-USERNAME</em>.github.io. 43192 IN CNAME <em> GITHUB-PAGES-SERVER </em>.
> <em> GITHUB-PAGES-SERVER </em>. 22 IN A 192.0.2.1
Removing a custom domain
{% data reusables.pages.navigate-site-repo %}
{% data reusables.repositories.sidebar-settings %}
{% data reusables.pages.sidebar-pages %}
4. Under "Custom domain," click Remove.
