Définir un domaine personnalisé

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

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

Cette page montre 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éfinition d'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 un domaine choisi.

1

Choisir un sous-domaine

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

• docs.example.com

• help.example.com

• developers.example.com

2

Initier 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 où vous pourrez saisir le domaine personnalisé que vous avez choisi à la première étape. Tapez-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 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 Nom et Cible champs à utiliser dans 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 du enregistrement dans une liste chez votre fournisseur.

Après avoir ajouté l'enregistrement, il peut falloir un certain temps pour que les modifications 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

Finaliser votre configuration

Après avoir ajouté l'enregistrement et après propagation, il est temps de mettre 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 aussi fermer la fenêtre si nécessaire, 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 présentons 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 fourniture 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 produit automatiquement lorsque vous définissez votre domaine personnalisé — vous n'avez pas besoin d'acheter ou de configurer un certificat SSL.

Occasionnellement, des erreurs se produisent à cette étape, généralement lorsque l'enregistrement CNAME pour le domaine personnalisé ne s'est pas 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 ni finaliser la configuration du domaine personnalisé.

2. Attendez 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 s'est 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 mis l'enregistrement en proxy comme expliqué ici.

Erreur : 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é à plus d'un endroit 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 marche à suivre.

Il est également possible que vous n'ayez pas accès au contenu — si c'est le cas, contactez l'équipe d'assistance et elle pourra vous aider pour les prochaines étapes.

La solution à cette erreur sera cependant toujours l'une des deux options suivantes :

1. Choisir un domaine personnalisé différent ; ou

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