Proxy inverse

Pour diffuser votre documentation via un proxy inverse personnalisé, vous devez configurer des règles de routage, des stratégies de mise en cache et la transmission des en-têtes. Lorsque vous mettez en place un proxy inverse, surveillez les problèmes potentiels liés à la vérification du domain, à l’émission des certificats SSL, aux parcours d’authentification, aux performances et au suivi Analytics.

Choisissez votre approche de déploiement

Mintlify prend en charge deux configurations de proxy inverse en fonction de vos exigences en matière de sous-chemin.

Héberger sur /docs : Activez le bouton Héberger sur /docs sur la page Configuration du domaine personnalisé de votre Dashboard. Il s’agit d’une configuration plus simple avec moins de routes.
Sous-chemin personnalisé : utilisez n’importe quel sous-chemin de votre choix. Cette approche nécessite des règles de routage supplémentaires.

Dans les deux configurations, utilisez mintlify.site comme cible du proxy.

Héberger sur le sous-chemin `/docs`

Utilisez cette configuration lorsque vous souhaitez servir la documentation sur le chemin /docs de votre domaine. Avant de configurer votre reverse proxy :

Accédez à Custom domain setup dans votre Dashboard.
Activez l’option Host at /docs.
Saisissez votre domaine et sélectionnez Add domain.

Lorsque vous activez Host at /docs, l’URL canonique de votre documentation devient <your-subdomain>.mintlify.site/docs. Configurez le proxy vers <your-subdomain>.mintlify.site pour que l’invalidation du cache et les mises à jour prennent effet.

Configuration du routage

Redirigez ces chemins via un proxy vers votre sous-domaine Mintlify :

Path	Destination	Caching
`/docs`	`<your-subdomain>.mintlify.site/docs`	No cache
`/docs/*`	`<your-subdomain>.mintlify.site/docs`	No cache
`/.well-known/vercel/*`	`<your-subdomain>.mintlify.site`	No cache
`/.well-known/skills/*` (optional)	`<your-subdomain>.mintlify.site/docs`	No cache
`/.well-known/agent-skills/*` (optional)	`<your-subdomain>.mintlify.site/docs`	No cache
`/skill.md` (optional)	`<your-subdomain>.mintlify.site/docs`	No cache
`/llms.txt` (optional)	`<your-subdomain>.mintlify.site/docs`	No cache
`/llms-full.txt` (optional)	`<your-subdomain>.mintlify.site/docs`	No cache

Les routes /.well-known/skills/*, /.well-known/agent-skills/*, /skill.md, /llms.txt et /llms-full.txt sont facultatives. Ne les incluez que si vous souhaitez servir des fichiers d’IA sur des chemins à la racine comme your-domain.com/llms.txt plutôt que sous votre sous-chemin de documentation, par exemple your-domain.com/docs/llms.txt.

Configuration d’en-têtes requise

Configurez votre reverse proxy avec les en-têtes suivants :

Origin : contient le sous-domaine cible <your-subdomain>.mintlify.site
X-Forwarded-For : conserve les informations d’adresse IP du client
X-Forwarded-Proto : conserve le protocole d’origine (HTTP/HTTPS)
X-Real-IP : transmet la véritable adresse IP du client
User-Agent : transmet l’agent utilisateur

Assurez-vous que l’en-tête Host n’est pas transmis.

Exemple de configuration Nginx

server {
    listen 80;
    server_name <your-domain>.com;

    # Vercel verification paths
    location ~ ^/\.well-known/vercel/ {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # AI skills paths
    location ^~ /.well-known/skills/ {
        proxy_pass https://<your-subdomain>.mintlify.site/docs;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # Agent-skills discovery paths
    location ^~ /.well-known/agent-skills/ {
        proxy_pass https://<your-subdomain>.mintlify.site/docs;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # Manifeste de compétence (facultatif)
    location = /skill.md {
        proxy_pass https://<your-subdomain>.mintlify.site/docs;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # Fichiers d'index LLM (facultatif)
    location = /llms.txt {
        proxy_pass https://<your-subdomain>.mintlify.site/docs;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    location = /llms-full.txt {
        proxy_pass https://<your-subdomain>.mintlify.site/docs;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # Documentation root
    location = /docs {
        proxy_pass https://<your-subdomain>.mintlify.site/docs;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # All documentation paths
    location /docs/ {
        proxy_pass https://<your-subdomain>.mintlify.site/docs/;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }
}

Sous-chemin personnalisé

Les configurations de proxy inverse pour les sous-chemins personnalisés ne sont prises en charge que pour les offres Enterprise.

Lorsque vous avez besoin d’un sous-chemin autre que /docs (comme /help ou /resources), utilisez la configuration de routage suivante. Redirigez ces chemins vers votre sous-domaine Mintlify avec les politiques de mise en cache indiquées :

Chemin	Destination	Mise en cache
`/.well-known/vercel/*`	`<your-subdomain>.mintlify.site`	Pas de cache
`/.well-known/skills/*`	`<your-subdomain>.mintlify.site`	Pas de cache
`/.well-known/agent-skills/*`	`<your-subdomain>.mintlify.site`	Pas de cache
`/skill.md`	`<your-subdomain>.mintlify.site`	Pas de cache
`/llms.txt`	`<your-subdomain>.mintlify.site`	Pas de cache
`/llms-full.txt`	`<your-subdomain>.mintlify.site`	Pas de cache
`/mintlify-assets/_next/static/*`	`<your-subdomain>.mintlify.site`	Cache activé
`/_mintlify/*`	`<your-subdomain>.mintlify.site`	Pas de cache
`/*`	`<your-subdomain>.mintlify.site`	Pas de cache
`/`	`<your-subdomain>.mintlify.site`	Pas de cache

Mintlify sert llms.txt, llms-full.txt et skill.md à la racine. Si votre documentation se trouve sous un sous-chemin (comme /help), vous pouvez également servir ces fichiers depuis ce sous-chemin (par exemple, /help/llms.txt). Pour cela, ajoutez des blocs location qui réécrivent le sous-chemin vers le chemin racine. Consultez l’exemple nginx ci-dessous pour les deux approches.

Configuration d’en-têtes requise

Configurez votre reverse proxy avec les en-têtes suivants :

Origin : contient le sous-domaine cible <your-subdomain>.mintlify.site
X-Forwarded-For : conserve les informations d’adresse IP du client
X-Forwarded-Proto : conserve le protocole d’origine (HTTP/HTTPS)
X-Real-IP : transmet la véritable adresse IP du client
User-Agent : transmet l’agent utilisateur

Assurez-vous que l’en-tête Host n’est pas transmis

Exemple de configuration Nginx

server {
    listen 80;
    server_name <your-domain>.com;

    # Vercel verification paths
    location ~ ^/\.well-known/vercel/ {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        # Désactiver la mise en cache pour les chemins de vérification
        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # AI skills paths
    location ^~ /.well-known/skills/ {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        # Désactiver la mise en cache pour les chemins de vérification
        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # Agent-skills discovery paths
    location ^~ /.well-known/agent-skills/ {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        # Désactiver la mise en cache pour les chemins agent-skills
        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # Skill manifest
    location = /skill.md {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        # Disable caching for skill manifest
        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # Fichiers d'index LLM
    location = /llms.txt {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    location = /llms-full.txt {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # Facultatif : Servir les fichiers d'IA sous votre sous-chemin avec réécriture de chemin.
    # Remplacez "/help" par votre sous-chemin. Ces blocs réécrivent le
    # sous-chemin afin que Mintlify reçoive le chemin racine attendu.
    #
    # location = /help/llms.txt {
    #     proxy_pass https://<your-subdomain>.mintlify.site/llms.txt;
    #     proxy_set_header Origin <your-subdomain>.mintlify.site;
    #     proxy_set_header X-Real-IP $remote_addr;
    #     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    #     proxy_set_header X-Forwarded-Proto $scheme;
    #     proxy_set_header User-Agent $http_user_agent;
    #     add_header Cache-Control "no-cache, no-store, must-revalidate";
    # }
    #
    # location = /help/llms-full.txt {
    #     proxy_pass https://<your-subdomain>.mintlify.site/llms-full.txt;
    #     proxy_set_header Origin <your-subdomain>.mintlify.site;
    #     proxy_set_header X-Real-IP $remote_addr;
    #     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    #     proxy_set_header X-Forwarded-Proto $scheme;
    #     proxy_set_header User-Agent $http_user_agent;
    #     add_header Cache-Control "no-cache, no-store, must-revalidate";
    # }
    #
    # location = /help/skill.md {
    #     proxy_pass https://<your-subdomain>.mintlify.site/skill.md;
    #     proxy_set_header Origin <your-subdomain>.mintlify.site;
    #     proxy_set_header X-Real-IP $remote_addr;
    #     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    #     proxy_set_header X-Forwarded-Proto $scheme;
    #     proxy_set_header User-Agent $http_user_agent;
    #     add_header Cache-Control "no-cache, no-store, must-revalidate";
    # }

    # Static assets with caching
    location ~ ^/mintlify-assets/_next/static/ {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        # Enable caching for static assets
        add_header Cache-Control "public, max-age=86400";
    }

    # Mintlify-specific paths
    location ~ ^/_mintlify/ {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        # Disable caching for Mintlify paths
        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # Root path
    location = / {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        # Disable caching for dynamic content
        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }

    # All other documentation paths
    location / {
        proxy_pass https://<your-subdomain>.mintlify.site;
        proxy_set_header Origin <your-subdomain>.mintlify.site;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header User-Agent $http_user_agent;

        # Disable caching for dynamic content
        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }
}

Résolution des problèmes

Les modifications n’apparaissent pas

Symptômes : Vous publiez des mises à jour de la documentation, mais les modifications n’apparaissent pas sur votre site. Cause : Votre proxy inverse pointe vers un nom d’hôte obsolète. Solution : Mettez à jour la configuration de votre proxy inverse pour qu’il pointe vers <your-subdomain>.mintlify.site.

Erreur 404

Symptômes : La documentation se charge, mais certaines fonctionnalités ne fonctionnent pas. Les appels à l’API échouent. Cause : Le proxy inverse transmet l’en-tête Host ou l’en-tête Origin est manquant. Solution :

Supprimer le transfert de l’en-tête Host
Définir l’en-tête Origin sur votre sous-domaine Mintlify (<your-subdomain>.mintlify.site)

Problèmes de performances

Symptômes : temps de chargement lents et décalages de mise en page. Cause : configuration de la mise en cache incorrecte. Solution : pour les configurations de sous-chemins personnalisées, activez la mise en cache uniquement pour les chemins /mintlify-assets/_next/static/*. La configuration du sous-chemin /docs gère automatiquement la mise en cache.

Prise en main

Organiser

Personnaliser

Créer du contenu

Documenter des API

Déployer

Optimisation

Choisissez votre approche de déploiement

Héberger sur le sous-chemin `/docs`

Configuration du routage

Configuration d’en-têtes requise

Exemple de configuration Nginx

Sous-chemin personnalisé

Configuration d’en-têtes requise

Exemple de configuration Nginx

Résolution des problèmes

Les modifications n’apparaissent pas

Erreur 404

Problèmes de performances

​Choisissez votre approche de déploiement

​Héberger sur le sous-chemin /docs

​Configuration du routage

​Configuration d’en-têtes requise

​Exemple de configuration Nginx

​Sous-chemin personnalisé

​Configuration d’en-têtes requise

​Exemple de configuration Nginx

​Résolution des problèmes

​Les modifications n’apparaissent pas

​Erreur 404

​Problèmes de performances

Choisissez votre approche de déploiement

Héberger sur le sous-chemin `/docs`

Configuration du routage

Configuration d’en-têtes requise

Exemple de configuration Nginx

Sous-chemin personnalisé

Configuration d’en-têtes requise

Exemple de configuration Nginx

Résolution des problèmes

Les modifications n’apparaissent pas

Erreur 404

Problèmes de performances