Définir un domaine personnalisé

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

This feature is available on Premium and Ultimate site plans.

Cette page montre comment configurer un domaine et un sous-domaine personnalisés. 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 domaine [subdomain].gitbook.io.

Vous pouvez personnaliser cela en définissant un domaine personnalisé, ce qui signifie que votre audience pourra accéder à votre documentation sur un domaine de votre choix.

1

Choisissez un sous-domaine

Lors du choix d’un sous-domaine, vous pouvez utiliser www ou un sous-domaine personnalisé. Quelques sous-domaines couramment utilisés sont :

• docs.example.com

• help.example.com

• developers.example.com

2

Démarrer 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à, une fenêtre s’affichera où vous pourrez saisir le domaine personnalisé choisi à la première étape. Saisissez-le et cliquez sur Suivant.

3

Configurer le DNS

À cette étape, une fenêtre s’affichera 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 pour les utiliser chez votre fournisseur DNS. Chaque fournisseur est différent, donc en cas de doute, vérifiez directement auprès d’eux comment ajouter cet enregistrement. Vous devriez pouvoir choisir le Type d’enregistrement dans une liste chez votre fournisseur.

Après avoir ajouté l’enregistrement, il peut s’écouler un certain temps avant que les modifications ne se propagent. Nous recommandons d’attendre au moins 1 heure avant de passer à l’étape suivante. Cliquez sur Suivant lorsque vous êtes prêt.

4

Finalisez votre configuration

Après avoir ajouté l’enregistrement et qu’il a été propagé, il est temps de passer en ligne ! 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, et nous vous enverrons une notification une fois le processus terminé de notre côté.

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 lors de ce processus et fournissons des solutions détaillées pour chacun d’eux.

Erreur SSL : une erreur s’est produite lors de la mise en place de votre certificat SSL.

Lorsqu’un domaine personnalisé est défini pour votre organisation, collection ou espace, nous configurons un certificat SSL de notre côté afin que votre documentation soit chargée 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.

Des erreurs peuvent parfois survenir à 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 finaliser la configuration du domaine personnalisé.

2. Laissez 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 tiers de recherche DNS, 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 en mode proxy comme expliqué ici.

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

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 voir le contenu auquel le domaine personnalisé est déjà connecté. Cela peut vous aider à décider quoi faire ensuite.

Il est également possible que vous n’ayez pas accès au contenu — si c’est le cas, contactez l’équipe de support qui pourra vous aider pour la suite.

La solution à cette erreur sera toujours l’une des deux suivantes :

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.