Skip to main content

Deploy

Subdomain

Every project gets a free subdomain under nookdocs.site — here's what you can pick, how to rename it, and what's reserved.

Default subdomain

Every project gets a free subdomain at <slug>.nookdocs.site the moment it's created. The slug is whatever you pick on the new-project screen — so a project with slug acme-docs is live at https://acme-docs.nookdocs.site.

SSL is auto-provisioned; there's nothing to configure.

The subdomain is assigned automatically from the project slug at <slug>.nookdocs.site; there is no DNS record or API call to deploy it. Slugs must be 3–32 chars, lowercase letters/digits/hyphens, start and end alphanumeric, no consecutive hyphens, and not match a reserved name (api, app, www, docs, admin, status, etc.). Renaming preserves the old subdomain as a 301 redirect for exactly 90 days, after which it is released for reuse. For a customer-owned hostname use a CNAME (Custom domain); the subpath option uses a customer-controlled reverse proxy, not DNS.

Constraints

Slugs are immutable-looking but actually rename-able. See Renaming below.

RuleExample
3–32 charactersa (too short), acme-docs-for-the-entire-enterprise-and-more (too long)
Lowercase letters, digits, and hyphens onlyacme-docs ✅, Acme_Docs
Must start and end with a letter or digit-acme ❌, acme-
No consecutive hyphensacme--docs
Not a reserved subdomainapi ❌, www

Validation runs both in the create form and on the server — we reject anything that slips through the client check.

Renaming

Yes, you can change your slug after you've shipped.

Open Settings → Domain

In the dashboard, pick your project and open the Domain section.

Change the slug

Type the new slug. Validation runs inline so you'll see conflicts and format errors before you hit save.

Confirm the rename

We move the site to the new subdomain and set up a redirect from the old one. The old subdomain keeps working for 90 days, returning a 301 to the new URL — enough time to update any links and let search engines re-index.

The 90-day redirect window is a hard deadline. After that, the old subdomain becomes eligible for someone else to claim.

Reserved subdomains

Some subdomains are permanently reserved for platform infrastructure and can never be claimed by a project:

ReservedUsed for
apiPublic REST API (api.nookdocs.com)
appDashboard (app.nookdocs.com)
www, nookdocs, nookdocsMarketing site
admin, dashboard, accountReserved for future auth flows
docsdocs.nookdocs.com (NookDocs' own docs)
status, health, monitorReserved for status pages
mail, email, smtp, imapReserved for email infrastructure

If you need a slug that's currently reserved, open a support ticket — we may be able to release it case-by-case.

Ready to use your own domain?

See Custom domain for attaching docs.yourcompany.com.

Was this page helpful?

Last updated August 13, 2026