mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
32 lines
2.4 KiB
Plaintext
32 lines
2.4 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. This 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. In your dashboard, open the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page. 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.
|
|
|
|
<Note>
|
|
When your own proxy serves your subpath, do not add the DNS records shown on the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page. The verification `TXT` records stay unverified because traffic for your domain never routes to Mintlify. This is expected and does not affect your documentation. See [_cf-custom-hostname TXT record stuck unverified](/help-center/cf-custom-hostname-txt-record-stuck-unverified).
|
|
</Note>
|
|
|
|
### 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). This ensures that your documentation displays properly.
|