mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
be7a1371ac
* docs: update custom domain setup for new dashboard flow Reflect the new custom domain UI: hosting mode selector (domain/subdomain vs subpath), traffic routing options (Mintlify-managed vs proxy-only), arbitrary base paths with reserved-path list, and base path changes that redeploy with rollback on failure. Replace references to the removed Host at /docs toggle in the Vercel and reverse proxy guides. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * copy edit * update images * docs: update subpath proxy guides for dashboard base paths Custom subpaths no longer require documentation files to live in a directory matching the subpath. The base path set in the dashboard is applied at build time, so the custom subpath reverse proxy setup now uses the same routing configuration as /docs with the path substituted. Add dashboard base path setup steps to the Vercel, Cloudflare Worker, and Route 53/CloudFront guides. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * 💅 * add plan gate Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * update vercel generator Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * remove gate * remove gate * Fix review findings: shared subpath setup snippet, generalize /docs framing, clarify Host header and script guidance Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Align hosting mode and traffic routing labels with dashboard UI, update screenshot alt text Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Fix root-only special file routing: path-preserving nginx destinations, restore sitemap/robots/mcp rewrites, sanitize generator input Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Add apex domain DNS provider requirements Apex domains get the same CNAME instruction as subdomains, but a CNAME at the apex requires provider support for CNAME flattening or ALIAS records. Document the requirement and supported providers, and link to it from the hosting mode section. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Correct special-file routing to base-path destinations per live verification, remove stale toggle images, generalize propagation snippet Verified against mintlify.mintlify.site: all special files (sitemap.xml, robots.txt, mcp, skill.md, llms.txt) serve under the base path and 404 at root, so root-mapping rewrites are reverted and optional root routes now proxy to base-path destinations. Broken links in es/fr/zh from image deletion resolve via post-merge translation automation. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * remove outdated images * Update dashboard instructions for Host at toggle UI (mint #8979) The hosting mode selector and traffic routing options were replaced with a Host at toggle and inline base path input; routing is now inferred from DNS. Verified against mint origin/main commit 6fb20b1789. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * 💅 --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
28 lines
1.9 KiB
Plaintext
28 lines
1.9 KiB
Plaintext
---
|
|
title: "Host docs at a subpath"
|
|
description: "Host your Mintlify documentation at a subpath like /docs on your main domain using Cloudflare Workers, Vercel rewrites, or an nginx reverse proxy."
|
|
keywords: ["subpath routing", "/docs setup", "base path"]
|
|
boost: 3
|
|
---
|
|
|
|
Host your documentation at a subpath like `your-domain.com/docs` to keep your docs on your main domain, which makes them easier to find and maintains a cohesive brand experience for your users.
|
|
|
|
## Let Mintlify manage your domain
|
|
|
|
If your domain hosts nothing else, Mintlify can serve your documentation at your subpath without a proxy. On the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page in your dashboard, enable the **Host at** toggle, enter your base path, and add your domain. Then configure the DNS records shown in your dashboard to point your domain at Mintlify. See [Custom domain](/customize/custom-domain) for setup instructions.
|
|
|
|
Only use this option if Mintlify can receive all paths on the domain.
|
|
|
|
## Set up by hosting provider
|
|
|
|
If another site runs on your domain, configure your hosting provider to proxy your subpath to Mintlify. Choose your hosting provider and follow the setup instructions.
|
|
|
|
- [Cloudflare](/deploy/cloudflare): Set up Cloudflare Workers for your domain to serve your documentation at your subpath.
|
|
- [AWS Route 53 and CloudFront](/deploy/route53-cloudfront): Deploy your documentation at your subpath using AWS with Route 53 DNS and CloudFront CDN.
|
|
- [Vercel](/deploy/vercel): Use rewrites to deploy your documentation at your subpath.
|
|
- [Custom reverse proxy](/deploy/reverse-proxy): For other hosting platforms, set up a reverse proxy to deploy your documentation at your subpath.
|
|
|
|
### Additional configuration for strict security policies
|
|
|
|
If you proxy all traffic on your custom domain, you may need to configure your proxy or firewall rules to add the correct [headers](/deploy/csp-configuration) so your documentation displays properly.
|