Configurer un domaine personnalisé

Un domaine personnalisé sert votre documentation Docsbook depuis une adresse qui vous appartient — docs.example.com au lieu de docsbook.io/user/repo. Docsbook émet automatiquement le certificat SSL dès que le DNS pointe correctement.

La diffusion du site, du domaine et de son certificat ne fait appel à aucun modèle d’IA. Un domaine personnalisé ne prélève donc rien sur le solde du projet, quel que soit le volume de trafic qu’il reçoit.

Pourquoi servir la documentation depuis votre propre domaine#

• L'autorité de recherche s'accumule sur votre domaine. Les liens que les internautes créent vers votre documentation pointent vers example.com, de sorte que l'autorité véhiculée par ces liens s'accumule sur le domaine que vous cherchez à classer, et non sur docsbook.io.
• Les lecteurs voient une seule entreprise. La barre d'adresse correspond au produit d'où ils viennent.
• L'adresse reste valable en cas de changement. Si vous quittez un jour Docsbook, docs.example.com continuera de fonctionner avec le service qui le desservira ensuite ; une URL docsbook.io/user/repo ne le fera pas.

Avant de commencer#

Vous avez besoin de deux choses :

1. Un domaine que vous contrôlez, enregistré auprès de n’importe quel bureau d’enregistrement.
2. Un accès aux paramètres DNS de ce domaine, afin de pouvoir ajouter un enregistrement.

Étape 1 : ouvrir le paramètre de domaine personnalisé#

1. Ouvrez votre documentation après vous être connecté.
2. Cliquez sur le Float Widget en bas à droite.
3. Ouvrez Paramètres → Domaine personnalisé.

Étape 2 : saisissez votre domaine#

1. Saisissez votre domaine, par exemple docs.example.com.
2. Cliquez sur Enregistrer.

Docsbook génère l’enregistrement DNS dont vous avez besoin et l’affiche immédiatement, avec un bouton Copier pour chaque valeur.

Étape 3 : ajoutez l’enregistrement DNS chez votre bureau d’enregistrement#

Le type d’enregistrement dépend de l’utilisation d’un sous-domaine ou de la racine du domaine.

Sous-domaine — recommandé, par exemple docs.example.com. Ajoutez un enregistrement CNAME :

Domaine racine ou apex — par exemple example.com. La plupart des bureaux d’enregistrement refusent un CNAME sur la racine. Ajoutez donc un enregistrement A :

Copiez les valeurs depuis le panneau Domaine personnalisé plutôt que depuis cette page. Le panneau affiche la cible exacte pour votre domaine ; les valeurs ci-dessus sont les valeurs par défaut habituelles et peuvent différer.

Où se trouvent les paramètres DNS chez les bureaux d’enregistrement courants#

GoDaddy

1. Connectez-vous sur godaddy.com.
2. Accédez à Mes domaines → votre domaine → DNS.
3. Cliquez sur Ajouter et renseignez : Type CNAME, Nom docs, Pointe vers cname.vercel-dns.com.
4. Enregistrez.

Namecheap

1. Connectez-vous sur namecheap.com.
2. Accédez à Liste des domaines → Gérer → DNS avancé.
3. Ajoutez un enregistrement : Type CNAME, Hôte docs, Valeur cname.vercel-dns.com, TTL 3600.
4. Enregistrez.

Ionos (anciennement 1&1)

1. Connectez-vous et ouvrez Domaines.
2. Sélectionnez votre domaine et ouvrez Gérer le DNS.
3. Ajoutez un enregistrement : Type CNAME, Sous-domaine docs, Alias cname.vercel-dns.com.
4. Enregistrez.

Tout autre bureau d’enregistrement fonctionne de la même manière : trouvez le panneau DNS ou des serveurs de noms, ajoutez un enregistrement du type indiqué dans le panneau Docsbook, puis collez la valeur.

Si vous voulez le domaine racine plutôt qu’un sous-domaine#

Utilisez docs.example.com lorsque cela est possible. Il est plus facile à configurer et laisse example.com libre pour votre site produit.

Si vous avez besoin du domaine racine, utilisez l’enregistrement A ci-dessus — copiez l’adresse IP exacte affichée dans le panneau Domaine personnalisé — et écrivez à support@docsbook.io si l’interface de votre registraire ne permet pas d’en ajouter un.

Étape 4 : attendre la propagation du DNS#

Les modifications DNS prennent généralement 15 à 30 minutes avant d’être visibles et peuvent prendre jusqu’à 48 heures.

Cliquez sur Vérifier l’état du domaine dans le panneau Domaine personnalisé. Il indique l’un des trois états suivants :

Pour confirmer depuis l’extérieur de Docsbook, effectuez une recherche :

nslookup docs.example.com

La réponse doit nommer cname.vercel-dns.com. DNSChecker affiche la même réponse depuis plusieurs pays à la fois, ce qui est utile lorsque la propagation est partielle.

Étape 5 : laisser le certificat SSL être émis#

Une fois la résolution DNS effectuée, Docsbook détecte le domaine, demande un certificat Let's Encrypt et active le HTTPS. Aucun clic n’est nécessaire.

Votre documentation est alors accessible à l’adresse :

https://docs.example.com

Dépannage#

Modifier ou supprimer le domaine#

Pour passer à un autre domaine : ouvrez Paramètres → Domaine personnalisé, remplacez la valeur, cliquez sur Enregistrer et ajoutez l’enregistrement DNS du nouveau domaine. L’ancien domaine ne diffuse plus votre documentation.

Pour revenir à l’adresse Docsbook : effacez le champ Domaine personnalisé et cliquez sur Enregistrer. Votre documentation revient à docsbook.io/username/repo.

Une fois le domaine en ligne#

• Mettez à jour chaque lien qui pointe vers l’ancienne adresse — votre fichier README GitHub, votre site produit, votre signature e-mail et vos profils sociaux. Les liens laissés sur l’ancienne adresse transmettent de l’autorité à docsbook.io.
• Privilégiez un sous-domaine par usage — docs.example.com, guide.example.com, api.example.com. Placer la documentation à la racine entre en concurrence avec votre site principal.
• Surveillez le trafic entrant. Les outils d’analyse web indiquent les consultations, les sites référents et les requêtes de recherche associées au nouveau domaine dès la première visite.

Étapes suivantes#

• Activer les traductions par IA — chaque langue est disponible sous le même domaine, avec son propre chemin indexé.
• Restreindre l’accès à votre documentation — un domaine personnalisé et une protection par mot de passe ou SSO fonctionnent ensemble.
• Gérer votre site de documentation — le reste du panneau des paramètres.