Custom domain | Radiant Docs

Use a custom domain when readers should access your docs from your own domain, such as docs.example.com.

Custom domains are available on the Free and Pro plans. Each docs site can have one custom domain. Only organization owners can add or remove it.

Supported domain patterns

Pattern	Example	How Radiant handles it
Subdomain	`docs.example.com`	Radiant provides a CNAME target and manages SSL readiness
Public docs URL with path	`example.com/docs`	Radiant stores the public URL for display and routing context

Root domains such as example.com are not supported yet for Radiant-managed custom domains. Use a subdomain such as docs.example.com.

Add a managed subdomain

Open the domain settings

In the Radiant dashboard, open the domain settings for your docs project.

Enter your docs URL

Enter the docs subdomain you want readers to use, such as docs.example.com, and select Set docs URL.

Add the CNAME record

Radiant shows the CNAME record to add at your DNS provider. Add that record for the subdomain.

Return to Radiant

Go back to the dashboard and check the domain status. DNS and certificate readiness can take time to propagate.

Host docs at a subpath

Use a pathname URL when your docs should appear alongside your existing site, such as example.com/docs. Your hosting setup must be able to proxy requests for that path to Radiant.

Enter the public docs URL

Enter the complete hostname and path, such as example.com/docs, and select Set docs URL. Radiant recognizes the path and starts a build configured for it.

Copy the Radiant target

The dashboard displays a stable Radiant target for the docs site. Copy the generated target rather than the example placeholder below.

Configure the proxy

Route both the exact path and every URL below it to the corresponding URL on the Radiant target without redirecting visitors.

Check the setup

Return to the dashboard after the docs build finishes and select Check setup. Radiant verifies that the public URL reaches the correct docs site.

For a public URL of https://example.com/docs and a generated target of https://SITE_ID.radiantdocs.com/docs, the configuration looks like this:

Use the Vercel configuration when your website is deployed on Vercel, regardless of its framework. Use the Next.js configuration when a running Next.js server handles your website’s routing. Next.js rewrites do not run in a static export.

{  "rewrites": [    {      "source": "/docs",      "destination": "https://SITE_ID.radiantdocs.com/docs"    },    {      "source": "/docs/:path*",      "destination": "https://SITE_ID.radiantdocs.com/docs/:path*"    }  ]}

export default {  async rewrites() {    return [      {        source: "/docs",        destination: "https://SITE_ID.radiantdocs.com/docs",      },      {        source: "/docs/:path*",        destination: "https://SITE_ID.radiantdocs.com/docs/:path*",      },    ];  },};

export default {  async fetch(request) {    const url = new URL(request.url);     if (url.pathname === "/docs" || url.pathname.startsWith("/docs/")) {      url.protocol = "https:";      url.hostname = "SITE_ID.radiantdocs.com";      return fetch(new Request(url, request));    }     return fetch(request);  },};

location = /docs {  proxy_set_header Host SITE_ID.radiantdocs.com;  proxy_ssl_server_name on;  proxy_ssl_name SITE_ID.radiantdocs.com;  proxy_pass https://SITE_ID.radiantdocs.com/docs;} location /docs/ {  proxy_set_header Host SITE_ID.radiantdocs.com;  proxy_ssl_server_name on;  proxy_ssl_name SITE_ID.radiantdocs.com;  proxy_pass https://SITE_ID.radiantdocs.com;}

Your existing website continues to manage DNS and TLS for its hostname. Radiant does not create a DNS record or certificate for a pathname URL.

Managed domain status

Status	Meaning
Pending	Radiant is waiting for DNS or certificate readiness
Active	The custom domain is ready for readers
Failed	Radiant could not activate the domain

When a managed domain becomes Active, readers can use it to access the docs site. Pathname URLs display their build and proxy status separately in the dashboard.

Change or remove a domain

Organization owners can remove the current custom domain from the dashboard. After removal, the docs site continues to be available from its Radiant-hosted URL unless the project is otherwise unpublished or deleted.

To switch domains, remove the current domain and add the new one.

Common questions

Not yet. Use a subdomain such as docs.example.com for a Radiant-managed custom domain.

Pending usually means DNS or certificate readiness has not completed yet. Confirm the CNAME record matches the value shown in Radiant, then check the status again after propagation.

Organization owners can add or remove custom domains. Each docs site can have one custom domain.

Radiant builds the docs for that path and displays a generated Radiant target with proxy configuration examples. Your website must forward the path to Radiant before it becomes active.

Next steps

Deployments

Watch changes go live.

Billing and usage

Check plan access.