Passer au contenu principal
Pour héberger votre documentation sur un domaine personnalisé :
  1. Ajoutez votre domain dans votre Dashboard.
  2. Configurez les paramètres DNS auprès de votre fournisseur de domain.
  3. Laissez le temps au DNS de se propager et aux certificats TLS d’être automatiquement provisionnés.
Vous souhaitez configurer un sous-répertoire personnalisé comme mintlify.com/docs ? Consultez la documentation sur le sous-répertoire personnalisé.

Ajoutez votre domaine personnalisé

  1. Accédez à la page Configuration du domaine personnalisé dans votre Dashboard.
  2. Saisissez votre nom de domaine. Par exemple, docs.example.com ou www.example.com.
  3. Cliquez sur Ajouter le domaine.
La page de configuration du domaine personnalisé affichant le champ pour saisir l'URL de votre domaine personnalisé.

Configurer votre DNS

  1. Sur le site de votre fournisseur de domaine, accédez aux paramètres DNS de votre domaine.
  2. Créez un nouvel enregistrement DNS avec les [objet Objet] suivants :
CNAME | docs | cname.vercel-dns.com.
Chaque fournisseur de domaine a une méthode différente pour ajouter des enregistrements DNS. Consultez la documentation de votre fournisseur de domaine pour des instructions spécifiques.
Exemple de paramètres CNAME pour un domaine personnalisé hébergé sur Vercel.

Propagation du DNS

Les modifications DNS se propagent généralement en 1 à 24 heures dans le monde entier, mais cela peut prendre jusqu’à 48 heures dans certains cas. Vous pouvez vérifier que votre DNS est correctement configuré avec DNSChecker. Une fois vos enregistrements DNS actifs, votre documentation est d’abord accessible en HTTP. Le HTTPS sera disponible après que Vercel aura provisionné votre certificat TLS.

Provisionnement automatique de TLS

Une fois que vos enregistrements DNS ont propagé et se résolvent correctement, Vercel provisionne automatiquement un certificat SSL/TLS gratuit pour votre domaine avec Let’s Encrypt. Cette étape s’achève généralement dans les heures qui suivent la propagation DNS, bien que cela puisse prendre jusqu’à 24 heures dans de rares cas. Les certificats sont automatiquement renouvelés avant leur expiration.

Enregistrements CAA

Si votre domain utilise des enregistrements CAA (Certification Authority Authorization), vous devez autoriser Let’s Encrypt à émettre des certificats pour votre domain. Ajoutez l’enregistrement CAA suivant à vos paramètres DNS :
0 problème "letsencrypt.org"

Chemins réservés

Le chemin /.well-known/acme-challenge est réservé à la validation de certificats et ne peut pas être redirigé ni réécrit. Si vous avez configuré des redirections ou des réécritures pour ce chemin, l’émission du certificat échouera.

Paramètres spécifiques au fournisseur

Si Vercel est votre fournisseur de domaine, vous devez ajouter un enregistrement TXT de vérification. Ces informations s’affichent dans votre Dashboard après l’envoi de votre domaine personnalisé et vous sont également envoyées par e‑mail.
Si Cloudflare est votre fournisseur DNS, vous devez activer le mode « Full (strict) » pour le paramètre de chiffrement SSL/TLS. Désactivez également « Always Use HTTPS » dans vos paramètres Edge Certificates. La redirection HTTPS de Cloudflare empêchera Let’s Encrypt de valider votre domaine lors de la mise à disposition du certificat.

Définir une URL canonique

Après avoir configuré votre DNS, définissez une URL canonique pour indiquer aux moteurs de recherche d’indexer votre domaine préféré. Une URL canonique précise aux moteurs de recherche quelle version de votre documentation est la principale. Cela améliore le SEO lorsque votre documentation est accessible via plusieurs URL et évite les problèmes de contenu dupliqué. Ajoutez la balise meta canonical à votre docs.json :
"seo": {
    "metatags": {
        "canonical": "https://www.your-custom-domain-here.com"
    }
}
Remplacez https://www.your-custom-domain-here.com par votre domain personnalisé réel. Par exemple, si votre domain personnalisé est docs.mintlify.com, vous utiliseriez :
"seo": {
    "metatags": {
        "canonical": "https://docs.mintlify.com"
    }
}