CmdocsCmdocs
Deployment

Custom Domains

Use your own domain for a cmdocs site deployed on the dashboard.

Custom Domains

Every cmdocs project gets a built-in <slug>.cmdocs.app subdomain, but you'll usually want your docs on something like docs.yourcompany.com. This page walks through adding a custom domain end-to-end.

How DNS resolution works

cmdocs's static router uses the incoming Host header to find the right project, then serves its built static files. TLS is handled at the edge.

Walkthrough

Open the Domains tab

Navigate to Project → Settings → Domains in the dashboard.

Domains tab inside project settings

Add your domain

Click Add Domain and enter the full hostname you want to use, e.g. docs.yourcompany.com. cmdocs validates the format and checks that the domain isn't already claimed by another project.

Add domain form with hostname input

Create the DNS record

cmdocs shows you the exact DNS record to create at your registrar. For most cases, it's a single CNAME:

DNS instructions panel showing CNAME target
TypeNameValueTTL
CNAMEdocscmdocs.app3600

For an apex domain (e.g. yourcompany.com with no subdomain), use an ALIAS or ANAME record if your DNS provider supports them — otherwise an A record to the IP shown in the dashboard.

Wait for verification

cmdocs polls DNS automatically. Once the CNAME resolves, the domain status flips to Verified and TLS provisioning begins via Let's Encrypt.

Domain status showing Verifying then Verified

Verification usually completes within 1–10 minutes depending on your registrar's TTL.

TLS auto-provision

As soon as the domain verifies, cmdocs requests an HTTPS certificate. When the certificate is issued, the status turns Live and your site is reachable over https://.

Domain row showing Live status with HTTPS lock

DNS examples

  1. Open DNS → Records for your domain.
  2. Click Add record.
  3. Type CNAME, Name docs, Target cmdocs.app.
  4. Set Proxy status to DNS only (gray cloud). Cloudflare's orange-cloud proxy will break TLS provisioning.
  1. Domain List → Manage → Advanced DNS.
  2. Add New Record → Type CNAME Record, Host docs, Value cmdocs.app., TTL Automatic.
  1. Hosted zones → your zone → Create record.
  2. Record name docs, Type CNAME, Value cmdocs.app, TTL 300.
  1. DNS → Manage custom records.
  2. Host docs, Type CNAME, TTL 1H, Data cmdocs.app..

Domain settings reference

Prop

Type

You can attach multiple domains to a single environment. Set one as primary to redirect the others to it for canonical SEO.

Troubleshooting

What's next

Github

GitHub Integration

Connect a repo and ship on every push.

Deployment Overview

Dashboard vs CLI export comparison.

How is this guide?

GitHub Integration

Connect your GitHub repo to cmdocs and ship docs on every push.

CI Validation

Run cmdocs check locally and in CI so broken docs never reach main.

On this page

Custom DomainsHow DNS resolution worksWalkthroughOpen the Domains tabAdd your domainCreate the DNS recordWait for verificationTLS auto-provisionDNS examplesDomain settings referenceTroubleshootingWhat's next