Définir un domaine personnalisé

Définissez un domaine personnalisé pour vos sites de documentation

Cette page explique comment configurer un domaine personnalisé et un sous-domaine. Si vous souhaitez configurer un sous-répertoire personnalisé (tel que example.com/docs), consultez la Définir un sous-répertoire personnalisé page.

Par défaut, vos sites sont accessibles sur un [subdomain].gitbook.io domaine.

Vous pouvez personnaliser cela en définissant un domaine personnalisé, ce qui permet à votre public d’accéder à votre documentation sur le domaine de votre choix.

1

Choisissez un sous-domaine

Lorsque vous choisissez un sous-domaine, vous pouvez utiliser www ou un sous-domaine personnalisé. Voici quelques sous-domaines couramment utilisés :

• docs.example.com
• help.example.com
• developers.example.com

2

Lancer la configuration du domaine personnalisé

Accédez au site pour lequel vous souhaitez définir le domaine personnalisé. Cliquez sur Paramètres, puis choisissez Configurer un domaine personnalisé.

À partir de là, vous verrez une fenêtre dans laquelle vous pourrez saisir le domaine personnalisé choisi à la première étape. Saisissez-le puis cliquez sur Suivant.

3

Configurer le DNS

À ce stade, vous verrez une fenêtre avec trois champs : Type, Nom, Cible.

Ce sont les informations que vous utiliserez pour configurer votre domaine personnalisé chez votre fournisseur DNS. Cela se fait en dehors de GitBook, chez le fournisseur que vous utilisez pour votre domaine.

Copiez le contenu des champs Nom et Cible à utiliser chez votre fournisseur DNS. Chaque fournisseur est différent, donc en cas de doute, vérifiez directement auprès de lui comment ajouter cet enregistrement. Vous devriez pouvoir choisir le Type d’enregistrement dans une liste proposée par votre fournisseur.

Après avoir ajouté l’enregistrement, les modifications peuvent mettre un certain temps à se propager. Nous recommandons d’attendre au moins 1 heure avant de passer à l’étape suivante. Cliquez sur Suivant quand vous êtes prêt.

4

Finaliser votre configuration

Après avoir ajouté l’enregistrement et une fois celui-ci propagé, il est temps de passer en production ! GitBook vérifiera le domaine, l’enregistrement que vous avez ajouté et configurera automatiquement le certificat SSL pour votre domaine.

Une fois terminé, vous recevrez une notification et pourrez cliquer sur Terminer. Vous pouvez également fermer la fenêtre si besoin ; nous vous enverrons une notification une fois le processus terminé de notre côté.

Modifier ou mettre à jour votre domaine personnalisé

Pour modifier le domaine personnalisé d’un site, ouvrez les Paramètres, sous Général dans la barre latérale du site, puis cliquez sur Domaine et URL. Vous pouvez supprimer le domaine actuel et en ajouter un nouveau, ou modifier la configuration existante.

N’oubliez pas de mettre à jour les paramètres DNS chez votre fournisseur de domaine afin de les faire pointer vers la nouvelle configuration GitBook — le processus est le même que pour la configuration initiale, avec un enregistrement CNAME pointant vers la valeur fournie par GitBook.

Dépannage

La configuration d’un domaine personnalisé peut parfois rencontrer des obstacles. Ci-dessous, nous décrivons les problèmes fréquents rencontrés au cours de ce processus et proposons des solutions détaillées pour chacun d’eux.

Mon sous-domaine personnalisé ne fonctionne pas.

Les problèmes de domaine personnalisé sont généralement liés au DNS. Vérifiez votre configuration DNS :

1. Vérifiez que vous avez créé un enregistrement CNAME (et non un enregistrement A) pointant vers la valeur fournie par GitBook.
2. Assurez-vous d’utiliser le format de sous-domaine (docs.votresite.com ou www.votresite.com).
3. Si vous utilisez Cloudflare, désactivez le proxy (nuage orange) — l’enregistrement doit être défini sur « DNS uniquement ».

Problèmes DNS courants :

• Enregistrements en conflit — supprimez tous les enregistrements A, AAAA ou autres existants pour le même sous-domaine.
• Délais TTL — les modifications DNS peuvent mettre jusqu’à 48 heures à se propager dans le monde entier.
• Enregistrements CAA — si vous avez des enregistrements CAA, ajoutez 0 issue "pki.goog" pour autoriser les certificats SSL de GitBook.

Pour tester votre configuration, utilisez un outil de recherche DNS tel que WhatsMyDNS pour vérifier que votre enregistrement CNAME pointe vers la bonne adresse GitBook. Si les problèmes persistent après 48 heures, contactez l’assistance avec le nom de votre domaine et la valeur CNAME fournie par GitBook.

Erreur SSL : une erreur s’est produite lors de la provision de votre certificat SSL.

Lorsqu’un domaine personnalisé est défini pour votre organisation, groupe ou section, nous configurons un certificat SSL de notre côté afin que votre documentation se charge de manière sécurisée, via HTTPS. Cela se fait automatiquement lorsque vous définissez votre domaine personnalisé — vous n’avez pas besoin d’acheter ou de configurer un certificat SSL.

Il arrive parfois que des erreurs se produisent à cette étape, généralement lorsque l’enregistrement CNAME du domaine personnalisé n’a pas encore été propagé.

Dans ces cas, nous pouvons recommander ce qui suit :

1. Vérifiez que votre enregistrement CNAME est correctement configuré. Veuillez consulter notre page sur la configuration du DNS pour vous aider. Si l’enregistrement CNAME est incorrect, nous ne pourrons pas configurer le certificat SSL et terminer la configuration du domaine personnalisé.
2. Autorisez au moins une heure entre la configuration de l’enregistrement CNAME et la finalisation de la configuration du domaine personnalisé.
3. Vérifiez si le CNAME a été propagé. Vous pouvez essayer d’utiliser un outil de recherche DNS tiers, tel que WhatsMyDNS, pour savoir ce que les serveurs considèrent comme correct pour votre enregistrement CNAME.
4. Si vous utilisez Cloudflare, veuillez confirmer que vous n’avez pas l’enregistrement proxy comme expliqué ici.

Erreur de domaine déjà connecté : votre sous-domaine est déjà configuré pour un contenu différent.

Un domaine personnalisé attribué à un site doit être unique. Tenter d’utiliser le même domaine personnalisé à plusieurs endroits entraînera une erreur.

Si cela se produit, vous pouvez cliquer sur le lien dans le message d’erreur pour consulter le contenu auquel le domaine personnalisé est déjà connecté. Cela peut vous aider à décider de la prochaine étape.

Il est également possible que vous n’ayez pas accès au contenu — dans ce cas, contactez l’équipe d’assistance et elle pourra vous aider à déterminer les étapes suivantes.

La solution à cette erreur sera toujours l’une de ces deux choses :

1. Choisissez un autre domaine personnalisé ; ou
2. Dissociez le domaine personnalisé du contenu auquel il est déjà connecté, puis reconnectez-le au nouveau contenu.