Définir un domaine personnalisé

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

Cette fonctionnalité est disponible sur les forfaits de site Premium et Ultimate.

Cette page explique 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 le Définir un sous-répertoire personnalisé page du site.

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 un domaine choisi.

1

Choisir un sous-domaine

Lorsque vous choisissez un sous-domaine, vous pouvez soit utiliser www soit un sous-domaine personnalisé. Parmi les sous-domaines couramment utilisés, on trouve :

• 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 à l’étape 1. Saisissez-le puis cliquez sur Suivant.

3

Configurer le DNS

À cette étape, vous verrez une fenêtre avec trois champs : Type, Nom, Cible.

Ce sont les informations que vous utiliserez pour définir 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 sélectionner le Tapez du type d’enregistrement dans une liste proposée par votre fournisseur.

Après l’ajout de l’enregistrement, la propagation des changements peut prendre un certain temps. 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 l’ajout de l’enregistrement et sa propagation, 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, 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équemment rencontrés au cours de ce processus et fournissons des solutions détaillées pour chacun d’eux.

Erreur SSL : une erreur s’est produite lors du provisionnement 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 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 ce cas, nous vous recommandons 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 de recherche DNS tiers, comme WhatsMyDNS, pour savoir ce que les serveurs considèrent comme correct pour votre enregistrement CNAME.

4. Si vous utilisez Cloudflare, veuillez confirmer que l’enregistrement n’est pas proxifié 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 contenu 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 suite à donner.

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

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

1. Choisir un autre domaine personnalisé ; ou

2. Déconnecter le domaine personnalisé du contenu auquel il est déjà connecté, puis le reconnecter au nouveau contenu.