Passer au contenu principal

​
Fichier vercel.json

Le fichier vercel.json définit la façon dont votre projet est construit et déployé. Il se trouve à la racine de votre projet et contrôle divers aspects du déploiement, notamment le routage, les redirections, les en-têtes et les paramètres de build. Nous utilisons la configuration rewrites pour mettre en proxy les requêtes depuis votre domaine principal vers votre documentation. Les réécritures font pointer les requêtes entrantes vers d’autres destinations sans changer l’URL dans le navigateur. Lorsque quelqu’un visite yoursite.com/docs, Vercel récupère en interne le contenu depuis your-subdomain.mintlify.dev/docs, mais l’utilisateur voit toujours yoursite.com/docs dans son navigateur. Cela diffère des redirections, qui envoient les utilisateurs vers une autre URL. Vous pouvez personnaliser le sous-chemin avec n’importe quelle valeur, comme /docs, /help ou /guides. Vous pouvez également utiliser des sous-chemins profondément imbriqués comme /product/docs.

​
Configuration

​
Héberger depuis /docs

  1. Accédez à la configuration du domaine personnalisé dans votre Dashboard.
  2. Activez l’option Héberger à /docs.
Capture d’écran de la page de configuration du domaine personnalisé. L’option « Héberger à `/docs` » est activée et mise en évidence par un rectangle orange.
  1. Renseignez votre domain.
  2. Sélectionnez Ajouter un domain.
  3. Ajoutez les réécritures suivantes à votre fichier vercel.json. Remplacez [subdomain] par votre sous-domaine :
  {
    "rewrites": [
      {
        "source": "/docs",
        "destination": "https://[subdomain].mintlify.dev/docs"
      },
      {
        "source": "/docs/:match*",
        "destination": "https://[subdomain].mintlify.dev/docs/:match*"
      }
    ]
  }
  • source: Le modèle de chemin sur votre domain qui déclenche la réécriture.
  • destination: La cible vers laquelle la requête doit être mise en proxy.
  • :match*: Un caractère générique qui capture tous les segments de chemin après votre sous-chemin.
Pour en savoir plus, consultez Configuring projects with vercel.json: Rewrites dans la documentation Vercel.

​
Héberger depuis un chemin personnalisé

Pour utiliser un sous-chemin personnalisé (tout chemin autre que /docs), vous devez organiser vos fichiers de documentation dans votre référentiel pour qu’ils correspondent à la structure de ce sous-chemin. Par exemple, si votre documentation est hébergée à yoursite.com/help, vos fichiers de documentation doivent se trouver dans un répertoire help/. Utilisez le générateur ci-dessous pour créer votre configuration de réécriture. Ajoutez les règles de réécriture à votre fichier vercel.json.

​
Utiliser des proxys externes avec Vercel

Si vous utilisez un proxy externe (comme Cloudflare ou AWS CloudFront) devant votre déploiement Vercel, vous devez le configurer correctement pour éviter les conflits avec la vérification de domaine par Vercel et la délivrance des certificats SSL. Une configuration de proxy incorrecte peut empêcher Vercel d’émettre des certificats SSL Let’s Encrypt et provoquer des échecs de vérification de domaine. Consultez les fournisseurs pris en charge dans la documentation de Vercel.

​
Liste d’autorisation des chemins requis

Votre proxy externe doit autoriser le trafic vers ces chemins spécifiques sans le bloquer, le rediriger ni le mettre fortement en cache :
  • /.well-known/acme-challenge/* - Requis pour la vérification du certificat Let’s Encrypt
  • /.well-known/vercel/* - Requis pour la vérification du domain Vercel
  • /mintlify-assets/_next/static/* - Requis pour les ressources statiques
Ces chemins doivent être transmis directement à votre déploiement Vercel sans modification.

​
Exigences de transfert des en-têtes

Assurez-vous que votre proxy transmet correctement l’en-tête HOST. Sans un transfert correct des en-têtes, les requêtes de vérification échoueront.

​
Tester la configuration de votre proxy

Pour vérifier que votre proxy est correctement configuré :
  1. Vérifiez que https://[yourdomain].com/.well-known/vercel/ renvoie une réponse.
  2. Assurez-vous que les certificats SSL sont correctement provisionnés dans votre Dashboard Vercel.
  3. Vérifiez que la vérification du domain s’effectue correctement.
⌘I