Custom Domains
Connect a custom domain to your documentation site so visitors see docs.yourdomain.com instead of {slug}.skrypthq.dev. Custom domains are a Pro feature.
Requirements
- A Pro plan subscription
- A domain you control with access to DNS settings
- A deployed Skrypt project (deploy at least once before adding a custom domain)
Set up a custom domain
1. Open domain settings
Go to your project in the dashboard. Click Settings, then select the Domain tab. You will see your default subdomain displayed as {slug}.skrypthq.dev.
2. Enter your domain
Type your custom domain in the Custom domain field. Use a subdomain like docs.yourdomain.com rather than a bare apex domain.
3. Configure DNS
Add a CNAME record at your DNS provider pointing to your Skrypt Pages project:
| Type | Name | Value |
|---|---|---|
| CNAME | docs | skrypt-{slug}.pages.dev |
Replace docs with your subdomain prefix and {slug} with your project slug. For example, if your project slug is my-api and your domain is docs.example.com:
| Type | Name | Value |
|---|---|---|
| CNAME | docs | skrypt-my-api.pages.dev |
The dashboard shows these exact values in the DNS Configuration panel after you enter your domain.
4. Verify
Click the Verify button next to your domain input. Skrypt checks that your CNAME record resolves correctly. On success, you see a green confirmation:
Domain verified! SSL certificate will be issued shortly.
5. Save
Click Save domain to persist the custom domain to your project. Future deployments will serve traffic on both the default subdomain and your custom domain.
SSL provisioning
SSL certificates are provisioned automatically through Cloudflare after domain verification. No manual certificate management is needed. The certificate typically activates within a few minutes of successful verification.
How it works
Each Skrypt project maps to a Cloudflare Pages project named skrypt-{slug}. When you add a custom domain, the platform calls the Cloudflare Pages Domains API to register your hostname on that project. Cloudflare handles TLS termination, certificate renewal, and edge caching.
Domain statuses returned by Cloudflare:
| Status | Meaning |
|---|---|
active | Domain is verified and serving traffic |
pending | Waiting for DNS propagation or certificate issuance |
error | Verification failed, check DNS settings |
Troubleshooting
DNS propagation delay
CNAME changes can take up to 48 hours to propagate, though most providers complete within 5 minutes. If verification fails immediately after adding the record, wait a few minutes and click Verify again.
Verification failure
If the Verify button shows a red error:
- Confirm the CNAME record exists at your DNS provider
- Check that the Name field matches your subdomain (e.g.
docs, notdocs.yourdomain.com-- some providers append the apex automatically) - Check that the Value field is exactly
skrypt-{slug}.pages.dev - Remove any conflicting A or AAAA records for the same subdomain
- Wait for propagation and retry
Apex domains
Bare apex domains (e.g. yourdomain.com without a subdomain) do not support standard CNAME records. Use a subdomain like docs.yourdomain.com instead. Some DNS providers offer CNAME flattening or ALIAS records for apex domains, but these are not officially supported.
Removing a custom domain
Clear the custom domain field in Settings and click Save domain. The default {slug}.skrypthq.dev subdomain continues to work.
What's next
- Deploying, deploy your site before or after adding a domain
- Web Editor, edit docs and deploy from the browser
- Configuration, customize your project settings