Pour héberger votre documentation sous un sous-chemin personnalisé tel que yoursite.com/docs avec Cloudflare, vous devez créer et configurer un Cloudflare Worker.
Avant de commencer, vous devez disposer d’un compte Cloudflare et d’un nom de domaine (qui peut être géré sur Cloudflare ou en dehors).
yoursite.com/docs, créez un répertoire docs/ contenant tous vos fichiers de documentation.
Créez un Cloudflare Worker en suivant le guide de prise en main de Cloudflare Workers, si ce n’est pas déjà fait.
Proxys avec des déploiements Vercel
Liste d’autorisation des chemins requise
/.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
Bien que Cloudflare gère automatiquement de nombreuses règles de vérification, la création de règles personnalisées supplémentaires peut involontairement bloquer ce trafic essentiel.
Assurez-vous que l’en-tête HOST est correctement transmis dans la configuration de votre Worker. Une transmission incorrecte des en-têtes entraînera l’échec des requêtes de vérification.
Dans votre Dashboard Cloudflare, sélectionnez Edit Code et ajoutez le script suivant au code de votre Worker. Consultez la documentation Cloudflare pour plus d’informations sur la modification d’un Worker.
Remplacez [SUBDOMAIN] par votre sous-domaine unique, [YOUR_DOMAIN] par l’URL de base de votre site web, et /docs par le sous-chemin souhaité le cas échéant.
addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
async function handleRequest(request) {
try {
const urlObject = new URL(request.url);
// Si la requête concerne un chemin de vérification Vercel, la laisser passer
if (urlObject.pathname.startsWith('/.well-known/')) {
return await fetch(request);
}
// Si la requête concerne le sous-répertoire docs
if (/^\/docs/.test(urlObject.pathname)) {
// Alors rediriger vers Mintlify via proxy
const DOCS_URL = "[SUBDOMAIN].mintlify.dev";
const CUSTOM_URL = "[YOUR_DOMAIN]";
let url = new URL(request.url);
url.hostname = DOCS_URL;
let proxyRequest = new Request(url, request);
proxyRequest.headers.set("Host", DOCS_URL);
proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL);
proxyRequest.headers.set("X-Forwarded-Proto", "https");
// Si déploiement sur Vercel, préserver l'IP du client
proxyRequest.headers.set("CF-Connecting-IP", request.headers.get("CF-Connecting-IP"));
return await fetch(proxyRequest);
}
} catch (error) {
// Si aucune action trouvée, traiter la requête normalement
return await fetch(request);
}
}
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 d’entreprendre tout dépannage.
- Testez à l’aide de l’URL d’aperçu du Worker :
your-worker.your-subdomain.workers.dev/docs
- Vérifiez que le Worker redirige vers votre documentation Mintlify et votre site web.
Ajouter un domaine personnalisé
- Dans votre Dashboard Cloudflare, accédez à votre Worker.
- Allez dans Settings > Domains & Routes > Add > Custom Domain.
- Ajoutez votre domain.
Nous vous recommandons d’ajouter votre domain avec et sans le préfixe www..
Résoudre les conflits DNS
- Supprimez l’enregistrement DNS existant pour votre domaine. Consultez la section Delete DNS records de la documentation Cloudflare pour en savoir plus.
- Retournez dans votre Worker et ajoutez votre domaine personnalisé.
Routage personnalisé avec Webflow
/docs sur le même domain, vous devrez configurer un routage personnalisé via Cloudflare Workers afin de mettre en proxy tout le trafic non lié aux docs vers votre site principal.
Assurez-vous que votre site principal pointe vers une page d’accueil (landing page) avant de déployer ce Worker, sinon les visiteurs de votre site principal verront des erreurs.
- Dans Webflow, configurez une page d’accueil pour votre site principal, par exemple
landing.yoursite.com. C’est la page que les visiteurs verront lorsqu’ils accéderont à votre site.
- Déployez votre site principal sur cette page d’accueil. Cela garantit que votre site principal reste accessible pendant la configuration du Worker.
- Pour éviter les conflits, remplacez les URL absolues de votre site principal par des URL relatives.
- Dans Cloudflare, sélectionnez Edit Code et ajoutez le script suivant dans le code de votre Worker.
Remplacez [SUBDOMAIN] par votre sous-domaine unique, [YOUR_DOMAIN] par l’URL de base de votre site web, [LANDING_DOMAIN] par l’URL de votre page d’accueil, et /docs par le sous-chemin souhaité si différent.
addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
async function handleRequest(request) {
try {
const urlObject = new URL(request.url);
// Si la requête est destinée à un chemin de vérification Vercel, la laisser passer
if (urlObject.pathname.startsWith('/.well-known/')) {
return await fetch(request);
}
// Si la requête est destinée au sous-répertoire docs
if (/^\/docs/.test(urlObject.pathname)) {
// Proxy vers Mintlify
const DOCS_URL = "[SUBDOMAIN].mintlify.dev";
const CUSTOM_URL = "[YOUR_DOMAIN]";
let url = new URL(request.url);
url.hostname = DOCS_URL;
let proxyRequest = new Request(url, request);
proxyRequest.headers.set("Host", DOCS_URL);
proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL);
proxyRequest.headers.set("X-Forwarded-Proto", "https");
// Si déploiement sur Vercel, préserver l'IP du client
proxyRequest.headers.set("CF-Connecting-IP", request.headers.get("CF-Connecting-IP"));
return await fetch(proxyRequest);
}
// Rediriger tout le reste vers le site principal
const MAIN_SITE_URL = "[LANDING_DOMAIN]";
if (MAIN_SITE_URL && MAIN_SITE_URL !== "[LANDING_DOMAIN]") {
let mainSiteUrl = new URL(request.url);
mainSiteUrl.hostname = MAIN_SITE_URL;
return await fetch(mainSiteUrl, {
method: request.method,
headers: request.headers,
body: request.body
});
}
} catch (error) {
// Si aucune action n'est trouvée, traiter la requête normalement
return await fetch(request);
}
}
- Sélectionnez Déployer et attendez la propagation des modifications.
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 d’entreprendre tout dépannage.
