Configurar um domínio personalizado

Um domínio personalizado disponibiliza sua documentação do Docsbook em um endereço que você possui — docs.example.com em vez de docsbook.io/user/repo. O Docsbook emite o certificado SSL automaticamente assim que o DNS for resolvido.

A veiculação do site, do domínio e de seu certificado não usa nenhum modelo de IA, portanto, um domínio personalizado não consome o saldo do projeto, independentemente da quantidade de tráfego que receba.

Por que disponibilizar a documentação no seu próprio domínio#

• A autoridade de pesquisa se acumula no seu domínio. Os links que as pessoas criam para a sua documentação apontam para example.com, então a autoridade transmitida por esses links chega ao domínio que você está tentando posicionar, não a docsbook.io.
• Os leitores veem uma única empresa. A barra de endereço corresponde ao produto de onde vieram.
• O endereço permanece válido após uma migração. Se você algum dia deixar o Docsbook, docs.example.com continuará funcionando com o que quer que o disponibilize no futuro; uma URL docsbook.io/user/repo não.

Antes de começar#

Você precisa de duas coisas:

1. Um domínio que você controla, registrado em qualquer registrador.
2. Acesso às configurações de DNS desse domínio, para que você possa adicionar um registro.

Etapa 1: abra a configuração de domínio personalizado#

1. Abra sua documentação enquanto estiver conectado.
2. Clique no Float Widget no canto inferior direito.
3. Abra Configurações → Domínio personalizado.

Etapa 2: insira seu domínio#

1. Digite seu domínio, por exemplo docs.example.com.
2. Clique em Salvar.

O Docsbook gera o registro DNS de que você precisa e o exibe imediatamente, com um botão Copiar em cada valor.

Etapa 3: adicione o registro DNS no seu registrador#

O tipo de registro depende de você usar um subdomínio ou a raiz do domínio.

Subdomínio — recomendado, por exemplo, docs.example.com. Adicione um CNAME:

Domínio raiz ou apex — por exemplo, example.com. A maioria dos registradores rejeita um CNAME na raiz, portanto adicione um registro A:

Copie os valores do painel Domínio personalizado, e não desta página. O painel mostra o destino exato para o seu domínio; os valores acima são os padrões usuais e podem ser diferentes.

Onde ficam as configurações de DNS nos registradores comuns#

GoDaddy

1. Faça login em godaddy.com.
2. Vá para Meus domínios → seu domínio → DNS.
3. Clique em Adicionar e preencha: Tipo CNAME, Nome docs, Aponta para cname.vercel-dns.com.
4. Salve.

Namecheap

1. Faça login em namecheap.com.
2. Vá para Lista de domínios → Gerenciar → DNS avançado.
3. Adicione um registro: Tipo CNAME, Host docs, Valor cname.vercel-dns.com, TTL 3600.
4. Salve.

Ionos (anteriormente 1&1)

1. Faça login e abra Domínios.
2. Selecione seu domínio e abra Gerenciar DNS.
3. Adicione um registro: Tipo CNAME, Subdomínio docs, Alias cname.vercel-dns.com.
4. Salve.

Qualquer outro registrador funciona da mesma forma: encontre o painel de DNS ou de servidores de nomes, adicione um registro do tipo mostrado no painel do Docsbook e cole o valor.

Se você quiser o domínio raiz em vez de um subdomínio#

Use docs.example.com sempre que possível. É mais fácil de configurar e deixa example.com livre para o seu site de produto.

Se você realmente precisar do domínio raiz, use o registro A acima — copie o IP exato mostrado no painel Domínio personalizado — e escreva para support@docsbook.io se a interface do seu registrador não oferecer um.

Etapa 4: aguarde a propagação do DNS#

As alterações de DNS geralmente levam de 15 a 30 minutos para ficarem visíveis e podem levar até 48 horas.

Clique em Verificar status do domínio no painel Domínio personalizado. Ele informa um dos três estados:

Para confirmar fora do Docsbook, execute uma consulta:

nslookup docs.example.com

A resposta deve indicar cname.vercel-dns.com. O DNSChecker mostra a mesma resposta de vários países simultaneamente, o que é útil enquanto a propagação é parcial.

Etapa 5: deixe o certificado SSL ser emitido#

Assim que o DNS for resolvido, o Docsbook detectará o domínio, solicitará um certificado da Let's Encrypt e habilitará o HTTPS. Não é necessário clicar em nada.

Sua documentação será então disponibilizada em:

https://docs.example.com

Solução de problemas#

Alterar ou remover o domínio#

Para mudar para um domínio diferente: abra Configurações → Domínio personalizado, substitua o valor, clique em Salvar e adicione o registro DNS para o novo domínio. O domínio antigo deixará de disponibilizar sua documentação.

Para voltar ao endereço do Docsbook: limpe o campo Domínio personalizado e clique em Salvar. Sua documentação retornará a docsbook.io/username/repo.

Quando o domínio estiver ativo#

• Atualize todos os links que apontam para o endereço antigo — seu README do GitHub, seu site do produto, sua assinatura de e-mail e seus perfis nas redes sociais. Os links deixados no endereço antigo direcionam autoridade para docsbook.io.
• Prefira um subdomínio para cada finalidade — docs.example.com, guide.example.com, api.example.com. Colocar a documentação no domínio raiz compete com seu site principal.
• Acompanhe o tráfego que chega. Análises da web informam visualizações, referências e consultas de pesquisa no novo domínio desde a primeira visita.

Próximos passos#

• Ativar traduções com IA — cada idioma é servido no mesmo domínio, em seu próprio caminho indexado.
• Restringir quem pode ler sua documentação — um domínio personalizado e uma senha ou barreira de SSO funcionam em conjunto.
• Gerenciar seu site de documentação — o restante do painel de configurações.