Skip to main content

About custom domains and GitHub Pages

GitHub Pages supports using custom domains, or changing the root of your site's URL from the default, like octocat.github.io, to any domain you own.

GitHub Pages está disponível em repositórios públicos com GitHub Free e GitHub Free para organizações, e em repositórios públicos e privados com GitHub Pro, GitHub Team, GitHub Enterprise Cloud e GitHub Enterprise Server. Para obter mais informações, confira "produtos de GitHub".

Supported custom domains

GitHub Pages works with two types of domains: subdomains and apex domains. For a list of unsupported custom domains, see "Troubleshooting custom domains and GitHub Pages."

Supported custom domain typeExample
www subdomainwww.example.com
Custom subdomainblog.example.com
Apex domainexample.com

You can set up either or both of apex and www subdomain configurations for your site. For more information on apex domains, see "Using an apex domain for your GitHub Pages site."

We recommend always using a www subdomain, even if you also use an apex domain. When you create a new site with an apex domain, we automatically attempt to secure the www subdomain for use when serving your site's content, but you need to make the DNS changes to use the www subdomain. If you configure a www subdomain, we automatically attempt to secure the associated apex domain. For more information, see "Managing a custom domain for your GitHub Pages site."

After you configure a custom domain for a user or organization site, the custom domain will replace the <user>.github.io or <organization>.github.io portion of the URL for any project sites owned by the account that do not have a custom domain configured. For example, if the custom domain for your user site is www.octocat.com, and you have a project site with no custom domain configured that is published from a repository called octo-project, the GitHub Pages site for that repository will be available at www.octocat.com/octo-project. For more information about each type of site and handling custom domains, see "Types of GitHub Pages sites."

Using a subdomain for your GitHub Pages site

A subdomain is the part of a URL before the root domain. You can configure your subdomain as www or as a distinct section of your site, like blog.example.com.

Subdomains are configured with a CNAME record through your DNS provider. For more information, see "Managing a custom domain for your GitHub Pages site."

www subdomains

A www subdomain is the most commonly used type of subdomain. For example, www.example.com includes a www subdomain.

www subdomains are the most stable type of custom domain because www subdomains are not affected by changes to the IP addresses of GitHub Enterprise Cloud's servers.

Custom subdomains

A custom subdomain is a type of subdomain that doesn't use the standard www variant. Custom subdomains are mostly used when you want two distinct sections of your site. For example, you can create a site called blog.example.com and customize that section independently from www.example.com.

Using an apex domain for your GitHub Pages site

An apex domain is a custom domain that does not contain a subdomain, such as example.com. Apex domains are also known as base, bare, naked, root apex, or zone apex domains.

An apex domain is configured with an A, ALIAS, or ANAME record through your DNS provider. For more information, see "Managing a custom domain for your GitHub Pages site."

Se você estiver usando um domínio apex como seu domínio personalizado, recomendaremos também configurar um subdomínio www. Se você configurar os registros corretos para cada tipo de domínio através do seu provedor DNS, GitHub Pages irá automaticamente criar redirecionamentos entre os domínios. Por exemplo, se você configurar www.example.com como o domínio personalizado para seu site e tiver os registros DNS do GitHub Pages configurados para o apex e os domínios www, example.com fará o redirecionamento para www.example.com. Observe que os redirecionamentos automáticos só se aplicam ao subdomínio www. Os redirecionamentos automáticos não se aplicam a nenhum outro subdomínio, como blog. For more information, see "Managing a custom domain for your GitHub Pages site."

Securing the custom domain for your GitHub Pages site

Se o site do GitHub Pages estiver desabilitado, mas tiver um domínio personalizado configurado, ele correrá o risco de uma tomada de controle de domínio. Ter um domínio personalizado configurado com o provedor DNS enquanto o site está desabilitado pode fazer com que outra pessoa acabe hospedando um site em um de seus subdomínios.

Verificar seu domínio personalizado impede que outros usuários do GitHub usem seu domínio com os repositórios deles. Se o seu domínio não for verificado e o seu site do GitHub Pages estiver desabilitado, você deverá atualizar ou remover imediatamente seus registros DNS com o provedor DNS. For more information, see "Verifying your custom domain for GitHub Pages" and "Managing a custom domain for your GitHub Pages site."

There are a couple of reasons your site might be automatically disabled.

  • If you downgrade from GitHub Pro to GitHub Free, any GitHub Pages sites that are currently published from private repositories in your account will be unpublished. For more information, see "Downgrading your GitHub billing plan."
  • If you transfer a private repository to a personal account that is using GitHub Free, the repository will lose access to the GitHub Pages feature, and the currently published GitHub Pages site will be unpublished. For more information, see "Transferring a repository."

Further reading