Custom Domain

​

Setting up a Custom Domain

Docsalot lets you connect your own domain to a documentation site from either the dashboard or the CLI.

Use the dashboard when you want a visual setup flow. Use the CLI when you want an agent, script, or terminal workflow to manage the same domain setup.

​

Default Subdomain

Every Docsalot documentation site comes with a default subdomain:

• Format: your-project.docsalot.dev
• SSL/TLS: Automatically provisioned
• Availability: Instant

​

Add a Custom Domain from the Dashboard

​

Add a Custom Domain from the CLI

First find the documentation ID:

docsalot docs list

Then add the custom domain:

docsalot domains add --documentation-id <documentation-id> --domain docs.yourcompany.com

The CLI returns the DNS record to create and the hostname-id to verify later.

After DNS is ready, verify the domain:

docsalot domains verify --documentation-id <documentation-id> --hostname-id <hostname-id>

You can also list or remove custom domains:

docsalot domains list --documentation-id <documentation-id>
docsalot domains remove --documentation-id <documentation-id> --hostname-id <hostname-id>

​

Ask Your Agent

If you have installed the Docsalot CLI skill, you can ask Claude Code, Codex, or another coding agent:

use docsalot cli to point this documentation to docs.yourcompany.com, show me the DNS record I need to add, and verify it when DNS is ready

The agent should be able to find or ask for the documentation ID, start setup through the CLI, and guide you through the DNS record.

​

DNS Configuration

Once you add a custom domain, you’ll receive specific DNS instructions. Add a CNAME record with these values:

Type: CNAME
Name: [your subdomain or @]
Value: docsalot.dev

​

Domain Status and Verification

Your custom domain can have one of three statuses:

​

Verifying Your Domain

After adding DNS records:

1. Wait 5-15 minutes for initial propagation
2. Click the refresh icon next to your domain in the management interface
3. The system will re-check your DNS configuration
4. Once verified, your domain status will change to “Active”

​

DNS Propagation

DNS changes typically take 5-15 minutes to propagate for initial verification, though global propagation can take up to 24 hours in some cases. You can verify your DNS is configured correctly using DNSChecker.

​

Managing Multiple Domains

You can add multiple custom domains to a single documentation site. This is useful for:

• Supporting multiple branded domains
• Transitioning from an old domain to a new one
• Regional domain variations

Each domain is managed independently with its own:

• SSL certificate
• DNS configuration
• Verification status

To remove a domain, simply click the delete icon next to it in the domain management interface.

​

Automatic SSL/TLS Provisioning

Docsalot automatically provisions free SSL/TLS certificates for all custom domains. The process includes:

1. Certificate Generation: SSL certificates are automatically generated when you add a domain
2. Auto-renewal: Certificates are automatically renewed before expiration
3. No configuration needed: SSL works out of the box once your domain is verified

​

Troubleshooting

​

Common Issues and Solutions

​

CAA Records

If your domain uses CAA (Certification Authority Authorization) records, you must authorize Let’s Encrypt to issue certificates. Add this CAA record:

0 issue "letsencrypt.org"

​

Reserved Paths

The /.well-known/acme-challenge path is reserved for certificate validation. Do not redirect or rewrite this path.

​

SEO Configuration

​

Set a Canonical URL

After configuring your custom domain, set a canonical URL to ensure search engines index your preferred domain. This improves SEO when your documentation is accessible from multiple URLs and prevents issues with duplicate content.

Add the canonical meta tag to your layout.json:

"seo": {
    "metatags": {
        "canonical": "https://www.your-custom-domain-here.com"
    }
}

Replace https://www.your-custom-domain-here.com with your actual custom domain. For example, if your custom domain is docs.yourcompany.com:

"seo": {
    "metatags": {
        "canonical": "https://docs.yourcompany.com"
    }
}

​

Need Help?

If you encounter any issues with custom domain setup or need assistance: