vercel.json 文件,将主域名的请求代理到文档所在的子路径。
vercel.json 文件
vercel.json 文件用于配置项目的构建和部署方式。它位于项目的根目录,用来控制部署的各个方面,包括路由、重定向、请求头以及构建设置。
我们会在你的 vercel.json 文件中使用 rewrites 配置,将来自主域名的请求代理到你的文档站点。
Rewrites 会在不更改浏览器中 URL 的情况下,将传入请求映射到不同的目标。当有人访问 yoursite.com/docs 时,Vercel 会在内部从 your-subdomain.mintlify.site/docs 获取内容,但用户在浏览器中仍然看到的是 yoursite.com/docs。这与重定向不同,后者会将用户直接带到另一个完全不同的 URL。
配置
在 /docs 子路径下托管
- 在控制台中前往 Custom domain setup。
- 启用 Host at 开关。
- 输入你的域名。
-
输入
docs作为你的基础路径。 - 选择 Add domain。
-
在你的
vercel.json文件中添加以下重写规则。将[subdomain]替换为你的子域,它出现在控制台 URL 的末尾。例如,app.mintlify.com/your-organization/your-subdomain的子域标识符是your-subdomain。
rewrites 配置会将你域名上的 /docs 子路径映射到你的文档站点上的 /docs 子路径。
source:你域名上触发重写的路径模式。destination:请求应被代理到的位置。:match*:用于捕获子路径之后任意路径片段的通配符。
/_mintlify 和 /mintlify-assets 重写规则是 API playground 和静态资源正常工作所必需的。
如需了解更多信息,请参阅 Vercel 文档中的 Configuring projects with vercel.json: Rewrites。
在自定义子路径下托管
/docs 的路径):
- 在控制台中前往 Custom domain setup 页面。
- 启用 Host at 开关并输入你的基础路径。例如
/docs或/help。 - 输入你的域名。
- 输入你的基础路径。
- 选择 Add domain。
vercel.json 文件中。
Mintlify 会重新构建你的文档以在你的基础路径下提供服务,因此你的文档文件不需要位于与子路径相匹配的目录中。
Vercel 前的外部代理
必需的路径白名单
/.well-known/acme-challenge/*:用于 Let’s Encrypt 证书验证。/.well-known/vercel/*:用于 Vercel 域名验证。/mintlify-assets/_next/static/*:用于静态资源。
请求头转发要求
Host 请求头。如果请求头未正确转发,验证请求会失败。
测试你的代理配置
- 测试
https://[yourdomain].com/.well-known/vercel/是否有响应。 - 确认 SSL 证书已在你的 Vercel 控制台中正确签发并生效。
- 检查 domain 验证是否已成功完成。