Cloudflare

使用 Cloudflare Workers 在自定义子路径托管文档

要使用 Cloudflare 将文档托管在自定义子路径（例如 yoursite.com/docs），你需要创建并配置一个 Cloudflare Worker。

开始之前，你需要一个 Cloudflare 账户和一个域名（可在 Cloudflare 内或外进行管理）。

​

存储库结构

为匹配所选的子路径结构，必须在存储库中合理组织文档文件。比如，如果希望文档位于 yoursite.com/docs，则需创建一个 docs/ 目录，并将所有文档文件放入其中。

​

设置 Cloudflare Worker

如果尚未创建，请按照 Cloudflare Workers 入门指南创建一个 Cloudflare Worker。

如果你的 DNS（域名系统）服务商是 Cloudflare，请不要为该 CNAME 记录启用代理。

​

使用 Vercel 部署时的代理

如果你在 Vercel 部署中使用 Cloudflare 作为代理，必须正确配置，以避免与 Vercel 的 domain 验证和 SSL 证书签发发生冲突。

错误的代理配置可能会阻止 Vercel 为 Let’s Encrypt 的 SSL 证书进行签发，并导致 domain 验证失败。

​

必需的路径允许列表

你的 Cloudflare Worker 必须允许以下特定路径的流量，不得阻止或重定向：

• /.well-known/acme-challenge/* - 供 Let’s Encrypt 证书验证使用
• /.well-known/vercel/* - 供 Vercel domain 验证使用

尽管 Cloudflare 会自动处理许多验证规则，额外创建自定义规则可能会无意间阻断这些关键流量。

​

标头转发要求

请确保在你的 Worker 配置中正确转发 HOST 标头。若未正确转发该标头，验证请求将会失败。

​

配置路由

在你的 Cloudflare 控制台中，选择 Edit Code，将以下脚本添加到你的 Worker 代码中。有关编辑 Worker 的更多信息，请参阅 Cloudflare 文档。

将 [SUBDOMAIN] 替换为你的唯一子域，将 [YOUR_DOMAIN] 替换为你网站的基础 URL；若子路径不同，将 /docs 替换为你期望的子路径。

addEventListener("fetch", (event) => {
  event.respondWith(handleRequest(event.request));
});

async function handleRequest(request) {
  try {
    const urlObject = new URL(request.url);
    
    // 如果请求是 Vercel 验证路径，允许其通过
    if (urlObject.pathname.startsWith('/.well-known/')) {
      return await fetch(request);
    }
    
    // 如果请求是 docs 子目录
    if (/^\/docs/.test(urlObject.pathname)) {
      // 代理到 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");
      // 如果部署到 Vercel，保留客户端 IP
      proxyRequest.headers.set("CF-Connecting-IP", request.headers.get("CF-Connecting-IP"));

      return await fetch(proxyRequest);
    }
  } catch (error) {
    // 如果未找到匹配操作，执行原始请求
    return await fetch(request);
  }
}

选择 Deploy，并等待更改生效。

配置好 DNS（域名系统）后，自定义子域通常会在几分钟内生效。DNS 传播有时可能需要 1–4 小时，极少数情况下可达 48 小时。如果您的子域未能立即生效，请先耐心等待，再进行故障排查。

​

测试你的 Worker

在部署代码后，测试你的 Worker，确保它能将流量路由到你的 Mintlify 文档。

1. 使用 Worker 的预览 URL 进行测试：your-worker.your-subdomain.workers.dev/docs
2. 确认该 Worker 能正确路由到你的 Mintlify 文档和你的网站。

​

添加自定义 domain

1. 在你的 Cloudflare 控制台中，进入你的 Worker。
2. 前往 Settings > Domains & Routes > Add > Custom Domain。
3. 添加你的 domain。

我们建议同时添加带有 www. 前缀和不带 www. 前缀的 domain。

更多信息请参见 Cloudflare 文档：Add a custom domain。

​

解决 DNS 冲突

如果你的 domain 已经指向其他服务，你必须移除现有的 DNS 记录。你的 Cloudflare Worker 必须配置为接管该 domain 的全部流量。

1. 删除该 domain 的现有 DNS 记录。更多信息请参阅 Cloudflare 文档中的Delete DNS records。
2. 返回你的 Worker 并添加你的自定义 domain。

​

Webflow 自定义路由

如果你使用 Webflow 托管主站，并希望在同一 domain 的 /docs 路径下提供 Mintlify 文档，则需要通过 Cloudflare Workers 配置自定义路由，将所有非文档流量代理到你的主站。

在部署此 Worker 之前，请先将你的主站设置在一个着陆页上，否则访问主站的访客会看到错误。

1. 在 Webflow 中，为主站设置一个着陆页，例如 landing.yoursite.com。当访客访问你的网站时会看到该页面。
2. 将主站部署到该着陆页。这样可确保在你配置 Worker 的过程中主站仍然可访问。
3. 为避免冲突，将主站中的任何绝对 URL 更新为相对路径。
4. 在 Cloudflare 中选择 Edit Code，并将以下脚本添加到你的 Worker 代码中。

将 [SUBDOMAIN] 替换为你唯一的子域，[YOUR_DOMAIN] 替换为你网站的基础 URL，[LANDING_DOMAIN] 替换为你的着陆页 URL；如需更改，将 /docs 替换为你想要的子路径。

  addEventListener("fetch", (event) => {
  event.respondWith(handleRequest(event.request));
  });
  async function handleRequest(request) {
  try {
    const urlObject = new URL(request.url);
    
    // 如果请求指向 Vercel 验证路径，允许其通过
    if (urlObject.pathname.startsWith('/.well-known/')) {
      return await fetch(request);
    }
    
    // 如果请求指向 docs 子目录
    if (/^\/docs/.test(urlObject.pathname)) {
      // 代理到 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");
      // 如果部署到 Vercel，保留客户端 IP
      proxyRequest.headers.set("CF-Connecting-IP", request.headers.get("CF-Connecting-IP"));
      return await fetch(proxyRequest);
    }
    // 将其他所有请求路由到主站点
    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) {
    // 如果未找到匹配操作，返回原始请求
    return await fetch(request);
  }
  }

5. 选择 Deploy，并等待更改生效。

配置好 DNS（域名系统）后，自定义子域通常会在几分钟内生效。DNS 传播有时可能需要 1–4 小时，极少数情况下可达 48 小时。如果您的子域未能立即生效，请先耐心等待，再进行故障排查。