Skip to main content
Pour héberger votre documentation à un sous-chemin tel que yoursite.com/docs avec AWS Route 53 et CloudFront, vous devez configurer votre fournisseur DNS pour qu’il pointe vers votre distribution CloudFront.

​
Vue d’ensemble

Dirigez le trafic vers ces chemins avec une stratégie de mise en cache (Cache Policy) de CachingDisabled :
  • /.well-known/acme-challenge/* - Requis pour la vérification des certificats Let’s Encrypt
  • /.well-known/vercel/* - Requis pour la vérification du domaine
  • /docs/* - Requis pour le routage par sous-chemin
  • /docs/ - Requis pour le routage par sous-chemin
Dirigez le trafic vers ce chemin avec une stratégie de mise en cache (Cache Policy) de CachingEnabled :
  • /mintlify-assets/_next/static/*
  • Default (*) - La page d’accueil de votre site web
Tous les Behaviors doivent avoir une origin request policy de AllViewerExceptHostHeader.

​
Créer une distribution CloudFront

  1. Accédez à CloudFront dans la console AWS.
  2. Sélectionnez Create distribution.
  1. Pour le domaine d’origine, saisissez [SUBDOMAIN].mintlify.dev, où [SUBDOMAIN] est le sous-domaine propre à votre projet.
  1. Pour « Web Application Firewall (WAF) », activez les protections de sécurité.
  1. Laissez les autres paramètres avec leurs valeurs par défaut.
  2. Sélectionnez Create distribution.

​
Ajouter une origine par défaut

  1. Après avoir créé la distribution, accédez à l’onglet « Origins ».
  1. Trouvez votre URL d’environnement de staging qui reflète le domaine principal. Cela varie selon la façon dont votre page d’accueil est hébergée. Par exemple, l’URL de staging de Mintlify est mintlify-landing-page.vercel.app.
Si votre page d’accueil est hébergée sur Webflow, utilisez l’URL de staging de Webflow. Elle se terminera par .webflow.io.Si vous utilisez Vercel, utilisez le domain .vercel.app disponible pour chaque projet.
  1. Créez une nouvelle Origin et ajoutez votre URL de staging comme « Origin domain ».
À ce stade, vous devriez avoir deux Origins : une avec [SUBDOMAIN].mintlify.app et une autre avec votre URL de staging.

​
Définir les comportements

Les comportements dans CloudFront permettent de contrôler la logique des sous-chemins. Globalement, nous voulons mettre en place la logique suivante :
  • Si un utilisateur arrive sur votre sous-chemin personnalisé, le rediriger vers [SUBDOMAIN].mintlify.dev.
  • Si un utilisateur arrive sur une autre page, le diriger vers la page d’accueil actuelle.
  1. Accédez à l’onglet « Behaviors » de votre distribution CloudFront.
  1. Cliquez sur le bouton Create behavior et créez les comportements suivants.

​
/.well-known/*

Créez des comportements pour les chemins de vérification de domaine Vercel avec un Path pattern de /.well-known/* et définissez Origin and origin groups sur l’URL de vos docs. Pour la « Cache policy », sélectionnez CachingDisabled afin de garantir que ces requêtes de vérification passent sans mise en cache.
Si /.well-known/* est trop générique, vous pouvez le restreindre à au moins 2 comportements pour Vercel :
  • /.well-known/vercel/* - Requis pour la vérification de domaine Vercel
  • /.well-known/acme-challenge/* - Requis pour la vérification de certificat Let’s Encrypt

​
Votre sous-chemin

Créez un comportement avec un Path pattern défini sur le sous-chemin de votre choix, par exemple /docs, avec Origin and origin groups pointant vers l’URL .mintlify.dev (dans notre cas acme.mintlify.dev).
  • Définissez « Cache policy » sur CachingOptimized.
  • Définissez « Origin request policy » sur AllViewerExceptHostHeader.
  • Définissez « Viewer Protocol Policy » sur Redirect HTTP to HTTPS.

​
Votre sous-chemin avec caractère générique

Créez un comportement avec un Path pattern correspondant au sous-chemin de votre choix suivi de /*, par exemple /docs/*, et des Origin and origin groups pointant vers la même URL en .mintlify.dev. Ces paramètres doivent correspondre exactement au comportement de votre sous-chemin de base, à l’exception du Path pattern.
  • Définissez “Cache policy” sur CachingOptimized.
  • Définissez “Origin request policy” sur AllViewerExceptHostHeader.
  • Définissez “Viewer protocol policy” sur Redirect HTTP to HTTPS.

​
/mintlify-assets/_next/static/*

  • Définissez la « Cache policy » sur CachingOptimized
  • Définissez la « Origin request policy » sur AllViewerExceptHostHeader
  • Définissez la « Viewer protocol policy » sur Redirect HTTP to HTTPS

​
Default (*)

Enfin, nous allons modifier le comportement Default (*).
  1. Modifiez le paramètre Origin and origin groups du comportement par défaut pour utiliser l’URL d’environnement de préproduction (dans notre cas mintlify-landing-page.vercel.app).
  1. Cliquez sur Enregistrer les modifications.

​
Vérifiez que les comportements sont correctement configurés

Si vous suivez les étapes précédentes, vos comportements devraient être les suivants:

​
Aperçu de la distribution

Vous pouvez maintenant vérifier si votre distribution est correctement configurée en accédant à l’onglet « General » et en ouvrant l’URL Distribution domain name.
Toutes les pages devraient renvoyer vers votre page d’accueil principale. En revanche, si vous ajoutez à l’URL le sous-chemin de votre choix — par exemple /docs — vous devriez être redirigé vers votre instance de documentation Mintlify.

​
Connecter avec Route 53

Nous allons maintenant faire pointer votre domaine principal vers la distribution CloudFront.
Pour cette section, vous pouvez également consulter le guide officiel d’AWS sur la configuration d’Amazon Route 53 pour acheminer le trafic vers une distribution CloudFront
  1. Accédez à Route 53 dans la console AWS.
  2. Accédez à la « Hosted zone » de votre domaine principal.
  3. Sélectionnez Create record.
  1. Activez Alias, puis, pour Route traffic to, choisissez l’option Alias to CloudFront distribution.
  1. Sélectionnez Create records.
Vous devrez peut-être supprimer l’enregistrement A existant s’il y en a un.
Votre documentation est maintenant en ligne au sous-chemin choisi de votre domaine principal.
Après avoir configuré votre DNS, les sous-domaines personnalisés sont généralement disponibles en quelques minutes. La propagation DNS peut parfois prendre 1 à 4 heures, et dans de rares cas jusqu’à 48 heures. Si votre sous-domaine n’est pas immédiatement disponible, veuillez patienter avant de tenter de résoudre le problème.