diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index fe9b86142..ea51bb693 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -11,7 +11,7 @@ keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password'] - Authentication is only available for documentation hosted on a custom domain or Mintlify subdomain (for example, `docs.example.com` or `example.mintlify.dev`). Authentication is **not supported** when using a [custom basepath](/deploy/docs-subpath) (for example, `example.com/docs`). + Authentication is only available for documentation hosted on a custom domain or Mintlify subdomain (for example, `docs.example.com` or `example.mintlify.cc`). Authentication is **not supported** when using a [custom basepath](/deploy/docs-subpath) (for example, `example.com/docs`). Authentication requires users to log in before accessing your documentation. diff --git a/deploy/cloudflare.mdx b/deploy/cloudflare.mdx index e20c40365..25673cfd0 100644 --- a/deploy/cloudflare.mdx +++ b/deploy/cloudflare.mdx @@ -65,7 +65,7 @@ async function handleRequest(request) { // If the request is to the docs subpath if (/^\/docs/.test(urlObject.pathname)) { // Then Proxy to Mintlify - const DOCS_URL = "[SUBDOMAIN].mintlify.dev"; + const DOCS_URL = "[SUBDOMAIN].mintlify.cc"; const CUSTOM_URL = "[YOUR_DOMAIN]"; let url = new URL(request.url); @@ -148,7 +148,7 @@ If you use Webflow to host your main site and want to serve Mintlify docs at `/d // If the request is to the docs subpath if (/^\/docs/.test(urlObject.pathname)) { // Proxy to Mintlify - const DOCS_URL = "[SUBDOMAIN].mintlify.dev"; + const DOCS_URL = "[SUBDOMAIN].mintlify.cc"; const CUSTOM_URL = "[YOUR_DOMAIN]"; let url = new URL(request.url); url.hostname = DOCS_URL; diff --git a/deploy/csp-configuration.mdx b/deploy/csp-configuration.mdx index 0ee0f384b..29b7324c1 100644 --- a/deploy/csp-configuration.mdx +++ b/deploy/csp-configuration.mdx @@ -24,7 +24,7 @@ The following CSP directives control which resources a page can load: | Domain | Purpose | CSP directive | Required | |:-------|:--------|:--------------|:-------| | `d4tuoctqmanu0.cloudfront.net` | KaTeX CSS, fonts | `style-src`, `font-src` | Required | -| `*.mintlify.dev` | Documentation content | `connect-src`, `frame-src` | Required | +| `*.mintlify.cc` | Documentation content | `connect-src`, `frame-src` | Required | | `*.mintlify.com` | Dashboard, API, analytics proxy | `connect-src` | Required | | `leaves.mintlify.com` | Assistant API | `connect-src` | Required | | `d3gk2c5xim1je2.cloudfront.net` | Icons, images, logos | `img-src` | Required | @@ -62,9 +62,9 @@ browser.sentry-cdn.com js.sentry-cdn.com hcaptcha.com *.hcaptcha.com; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com hcaptcha.com *.hcaptcha.com; font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net mintlify.s3.us-west-1.amazonaws.com; -connect-src 'self' *.mintlify.dev *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com +connect-src 'self' *.mintlify.cc *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com www.googletagmanager.com cdn.segment.com plausible.io us.posthog.com browser.sentry-cdn.com hcaptcha.com *.hcaptcha.com; -frame-src 'self' *.mintlify.dev hcaptcha.com *.hcaptcha.com; +frame-src 'self' *.mintlify.cc hcaptcha.com *.hcaptcha.com; ``` ## Common configurations by proxy type @@ -82,7 +82,7 @@ Create a Response Header Transform Rule: - **Header name**: `Content-Security-Policy` - **Header value**: ```text wrap - default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval' cdn.jsdelivr.net hcaptcha.com *.hcaptcha.com; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com hcaptcha.com *.hcaptcha.com; font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net mintlify.s3.us-west-1.amazonaws.com; connect-src 'self' *.mintlify.dev *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com hcaptcha.com *.hcaptcha.com; frame-src 'self' *.mintlify.dev hcaptcha.com *.hcaptcha.com; + default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval' cdn.jsdelivr.net hcaptcha.com *.hcaptcha.com; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com hcaptcha.com *.hcaptcha.com; font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net mintlify.s3.us-west-1.amazonaws.com; connect-src 'self' *.mintlify.cc *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com hcaptcha.com *.hcaptcha.com; frame-src 'self' *.mintlify.cc hcaptcha.com *.hcaptcha.com; ``` 4. Deploy your rule. @@ -97,7 +97,7 @@ Add a response headers policy in CloudFront: "Config": { "SecurityHeadersConfig": { "ContentSecurityPolicy": { - "ContentSecurityPolicy": "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval' cdn.jsdelivr.net hcaptcha.com *.hcaptcha.com; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com hcaptcha.com *.hcaptcha.com; font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net mintlify.s3.us-west-1.amazonaws.com; connect-src 'self' *.mintlify.dev *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com hcaptcha.com *.hcaptcha.com; frame-src 'self' *.mintlify.dev hcaptcha.com *.hcaptcha.com;", + "ContentSecurityPolicy": "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval' cdn.jsdelivr.net hcaptcha.com *.hcaptcha.com; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com hcaptcha.com *.hcaptcha.com; font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net mintlify.s3.us-west-1.amazonaws.com; connect-src 'self' *.mintlify.cc *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com hcaptcha.com *.hcaptcha.com; frame-src 'self' *.mintlify.cc hcaptcha.com *.hcaptcha.com;", "Override": true } } @@ -118,7 +118,7 @@ Add to your `vercel.json`: "headers": [ { "key": "Content-Security-Policy", - "value": "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval' cdn.jsdelivr.net hcaptcha.com *.hcaptcha.com; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com hcaptcha.com *.hcaptcha.com; font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net mintlify.s3.us-west-1.amazonaws.com; connect-src 'self' *.mintlify.dev *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com hcaptcha.com *.hcaptcha.com; frame-src 'self' *.mintlify.dev hcaptcha.com *.hcaptcha.com;" + "value": "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval' cdn.jsdelivr.net hcaptcha.com *.hcaptcha.com; style-src 'self' 'unsafe-inline' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com hcaptcha.com *.hcaptcha.com; font-src 'self' d4tuoctqmanu0.cloudfront.net fonts.googleapis.com; img-src 'self' data: blob: d3gk2c5xim1je2.cloudfront.net mintcdn.com *.mintcdn.com cdn.jsdelivr.net mintlify.s3.us-west-1.amazonaws.com; connect-src 'self' *.mintlify.cc *.mintlify.com d1ctpt7j8wusba.cloudfront.net mintcdn.com *.mintcdn.com hcaptcha.com *.hcaptcha.com; frame-src 'self' *.mintlify.cc hcaptcha.com *.hcaptcha.com;" } ] } diff --git a/deploy/reverse-proxy.mdx b/deploy/reverse-proxy.mdx index 2c3342d81..076845305 100644 --- a/deploy/reverse-proxy.mdx +++ b/deploy/reverse-proxy.mdx @@ -12,7 +12,7 @@ When you implement a reverse proxy, monitor for potential issues with domain ver Mintlify supports two reverse proxy configurations depending on your subpath requirements. -- **Host at `/docs`**: Use `mintlify.dev` as the proxy target. Enable the **Host at `/docs`** toggle on the [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. This is a simpler configuration with fewer routes. +- **Host at `/docs`**: Use `mintlify.cc` as the proxy target. Enable the **Host at `/docs`** toggle on the [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. This is a simpler configuration with fewer routes. - **Custom subpath**: Use `mintlify.app` as the proxy target. This approach supports any subpath and requires additional routing rules. ## Host at `/docs` subpath @@ -26,7 +26,7 @@ Before configuring your reverse proxy: 3. Enter your domain and click **Add domain**. - When you enable **Host at `/docs`**, your canonical docs URL becomes `.mintlify.dev`. Cache invalidation stops on `mintlify.app`, and you must proxy to `mintlify.dev` for updates to appear. + When you enable **Host at `/docs`**, your canonical docs URL becomes `.mintlify.cc`. Cache invalidation stops on `mintlify.app`, and you must proxy to `mintlify.cc` for updates to appear. ### Routing configuration @@ -35,14 +35,14 @@ Proxy these paths to your Mintlify subdomain: | Path | Destination | Caching | | --------------------------------- | ------------------------------------ | -------- | -| `/docs` | `.mintlify.dev/docs` | No cache | -| `/docs/*` | `.mintlify.dev/docs` | No cache | -| `/.well-known/vercel/*` | `.mintlify.dev` | No cache | -| `/.well-known/skills/*` (optional) | `.mintlify.dev/docs` | No cache | -| `/.well-known/agent-skills/*` (optional) | `.mintlify.dev/docs` | No cache | -| `/skill.md` (optional) | `.mintlify.dev/docs` | No cache | -| `/llms.txt` (optional) | `.mintlify.dev/docs` | No cache | -| `/llms-full.txt` (optional) | `.mintlify.dev/docs` | No cache | +| `/docs` | `.mintlify.cc/docs` | No cache | +| `/docs/*` | `.mintlify.cc/docs` | No cache | +| `/.well-known/vercel/*` | `.mintlify.cc` | No cache | +| `/.well-known/skills/*` (optional) | `.mintlify.cc/docs` | No cache | +| `/.well-known/agent-skills/*` (optional) | `.mintlify.cc/docs` | No cache | +| `/skill.md` (optional) | `.mintlify.cc/docs` | No cache | +| `/llms.txt` (optional) | `.mintlify.cc/docs` | No cache | +| `/llms-full.txt` (optional) | `.mintlify.cc/docs` | No cache | The `/.well-known/skills/*`, `/.well-known/agent-skills/*`, `/skill.md`, `/llms.txt`, and `/llms-full.txt` routes are optional. Include them only if you want to serve AI files at root paths like `your-domain.com/llms.txt` instead of under your docs subpath like `your-domain.com/docs/llms.txt`. @@ -50,7 +50,7 @@ The `/.well-known/skills/*`, `/.well-known/agent-skills/*`, `/skill.md`, `/llms. Configure your reverse proxy with these header requirements: -- **Origin**: Contains the target subdomain `.mintlify.dev` +- **Origin**: Contains the target subdomain `.mintlify.cc` - **X-Forwarded-For**: Preserves client IP information - **X-Forwarded-Proto**: Preserves original protocol (HTTP/HTTPS) - **X-Real-IP**: Forwards the real client IP address @@ -69,8 +69,8 @@ server { # Vercel verification paths location ~ ^/\.well-known/vercel/ { - proxy_pass https://.mintlify.dev; - proxy_set_header Origin .mintlify.dev; + proxy_pass https://.mintlify.cc; + proxy_set_header Origin .mintlify.cc; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; @@ -81,8 +81,8 @@ server { # AI skills paths location ^~ /.well-known/skills/ { - proxy_pass https://.mintlify.dev/docs; - proxy_set_header Origin .mintlify.dev; + proxy_pass https://.mintlify.cc/docs; + proxy_set_header Origin .mintlify.cc; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; @@ -93,8 +93,8 @@ server { # Agent-skills discovery paths location ^~ /.well-known/agent-skills/ { - proxy_pass https://.mintlify.dev/docs; - proxy_set_header Origin .mintlify.dev; + proxy_pass https://.mintlify.cc/docs; + proxy_set_header Origin .mintlify.cc; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; @@ -105,8 +105,8 @@ server { # Skill manifest (optional) location = /skill.md { - proxy_pass https://.mintlify.dev/docs; - proxy_set_header Origin .mintlify.dev; + proxy_pass https://.mintlify.cc/docs; + proxy_set_header Origin .mintlify.cc; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; @@ -117,8 +117,8 @@ server { # LLM index files (optional) location = /llms.txt { - proxy_pass https://.mintlify.dev/docs; - proxy_set_header Origin .mintlify.dev; + proxy_pass https://.mintlify.cc/docs; + proxy_set_header Origin .mintlify.cc; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; @@ -128,8 +128,8 @@ server { } location = /llms-full.txt { - proxy_pass https://.mintlify.dev/docs; - proxy_set_header Origin .mintlify.dev; + proxy_pass https://.mintlify.cc/docs; + proxy_set_header Origin .mintlify.cc; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; @@ -140,8 +140,8 @@ server { # Documentation root location = /docs { - proxy_pass https://.mintlify.dev/docs; - proxy_set_header Origin .mintlify.dev; + proxy_pass https://.mintlify.cc/docs; + proxy_set_header Origin .mintlify.cc; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; @@ -152,8 +152,8 @@ server { # All documentation paths location /docs/ { - proxy_pass https://.mintlify.dev/docs/; - proxy_set_header Origin .mintlify.dev; + proxy_pass https://.mintlify.cc/docs/; + proxy_set_header Origin .mintlify.cc; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; @@ -381,9 +381,9 @@ server { **Symptoms**: You publish documentation updates, but the changes don't appear on your site. -**Cause**: You have **Host at `/docs`** enabled in your dashboard but your reverse proxy points to `mintlify.app` instead of `mintlify.dev`. +**Cause**: You have **Host at `/docs`** enabled in your dashboard but your reverse proxy points to `mintlify.app` instead of `mintlify.cc`. -**Solution**: Update your reverse proxy configuration to point to `.mintlify.dev` instead of `.mintlify.app`. +**Solution**: Update your reverse proxy configuration to point to `.mintlify.cc` instead of `.mintlify.app`. ### 404 error @@ -394,7 +394,7 @@ server { **Solution**: - Remove `Host` header forwarding -- Set `Origin` header to your Mintlify subdomain (`mintlify.dev` for a `/docs` subpath or `mintlify.app` for a different subpath) +- Set `Origin` header to your Mintlify subdomain (`mintlify.cc` for a `/docs` subpath or `mintlify.app` for a different subpath) ### Performance issues diff --git a/deploy/route53-cloudfront.mdx b/deploy/route53-cloudfront.mdx index d63db1249..cf3abbcae 100644 --- a/deploy/route53-cloudfront.mdx +++ b/deploy/route53-cloudfront.mdx @@ -36,10 +36,10 @@ All Behaviors must have an **origin request policy** of `AllViewerExceptHostHead ![CloudFront Distributions page with the "Create distribution" button emphasized.](/images/cloudfront/create-distribution.png) -3. For the Origin domain, input `[SUBDOMAIN].mintlify.dev` where `[SUBDOMAIN]` is your project's unique subdomain. +3. For the Origin domain, input `[SUBDOMAIN].mintlify.cc` where `[SUBDOMAIN]` is your project's unique subdomain. - ![CloudFront "Create distribution" page showing "acme.mintlify.dev" as the origin domain.](/images/cloudfront/origin-name.png) + ![CloudFront "Create distribution" page showing "acme.mintlify.cc" as the origin domain.](/images/cloudfront/origin-name.png) 4. For "Web Application Firewall (WAF)," enable security protections. @@ -83,7 +83,7 @@ By this point, you should have two Origins: one with `[SUBDOMAIN].mintlify.app` Behaviors in CloudFront enable control over the subpath logic. At a high level, we're looking to create the following logic: -- **If a user lands on your custom subpath**, go to `[SUBDOMAIN].mintlify.dev`. +- **If a user lands on your custom subpath**, go to `[SUBDOMAIN].mintlify.cc`. - **If a user lands on any other page**, go to the current landing page. 1. Navigate to the "Behaviors" tab of your CloudFront distribution. @@ -112,19 +112,19 @@ If `.well-known/*` is too generic, it can be narrowed down to 2 behaviors at a m ### Your subpath -Create a behavior with a **Path pattern** of your chosen subpath, for example `/docs`, with **Origin and origin groups** pointing to the `.mintlify.dev` URL (in our case `acme.mintlify.dev`). +Create a behavior with a **Path pattern** of your chosen subpath, for example `/docs`, with **Origin and origin groups** pointing to the `.mintlify.cc` URL (in our case `acme.mintlify.cc`). - Set "Cache policy" to **CachingOptimized**. - Set "Origin request policy" to **AllViewerExceptHostHeader**. - Set Viewer Protocol Policy to **Redirect HTTP to HTTPS** - ![CloudFront "Create behavior" page with a "Path pattern" of "/docs/*" and "Origin and origin groups" pointing to the `acme.mintlify.dev` URL.](/images/cloudfront/behavior-1.png) + ![CloudFront "Create behavior" page with a "Path pattern" of "/docs/*" and "Origin and origin groups" pointing to the `acme.mintlify.cc` URL.](/images/cloudfront/behavior-1.png) ### Your subpath with wildcard -Create a behavior with a **Path pattern** of your chosen subpath followed by `/*`, for example `/docs/*`, and **Origin and origin groups** pointing to the same `.mintlify.dev` URL. +Create a behavior with a **Path pattern** of your chosen subpath followed by `/*`, for example `/docs/*`, and **Origin and origin groups** pointing to the same `.mintlify.cc` URL. These settings should exactly match your base subpath behavior. With the exception of the **Path pattern**. diff --git a/deploy/vercel.mdx b/deploy/vercel.mdx index f0d4ea200..0496981d3 100644 --- a/deploy/vercel.mdx +++ b/deploy/vercel.mdx @@ -15,7 +15,7 @@ The `vercel.json` file configures how your project builds and deploys. It sits i We use the `rewrites` configuration in your `vercel.json` file to proxy requests from your main domain to your documentation. -Rewrites map incoming requests to different destinations without changing the URL in the browser. When someone visits `yoursite.com/docs`, Vercel internally fetches content from `your-subdomain.mintlify.dev/docs`, but the user still sees `yoursite.com/docs` in their browser. This is different from redirects, which send users to another URL entirely. +Rewrites map incoming requests to different destinations without changing the URL in the browser. When someone visits `yoursite.com/docs`, Vercel internally fetches content from `your-subdomain.mintlify.cc/docs`, but the user still sees `yoursite.com/docs` in their browser. This is different from redirects, which send users to another URL entirely. ## Configuration @@ -36,11 +36,11 @@ Rewrites map incoming requests to different destinations without changing the UR "rewrites": [ { "source": "/docs", - "destination": "https://[subdomain].mintlify.dev/docs" + "destination": "https://[subdomain].mintlify.cc/docs" }, { "source": "/docs/:match*", - "destination": "https://[subdomain].mintlify.dev/docs/:match*" + "destination": "https://[subdomain].mintlify.cc/docs/:match*" } ] }