Skip to content

Choose A Site Name

Use this guide to understand generated names, explicit names, and the local name resolution used by the CLI. For the basic named deployment, follow Deploy Your First Site.

A site name:

  • Contains 1 to 63 characters.
  • Starts with a lowercase letter or number.
  • Uses lowercase letters, numbers, hyphens, or underscores after the first character.
  • Is converted to lowercase and has surrounding whitespace removed by the server.
  • Is unique on the Buzz server.

You can redeploy a name that you own. You cannot deploy to a name owned by another user.

Buzz currently accepts underscores, but ordinary DNS hostnames do not. Use letters, numbers, and hyphens for public site names.

When no name is supplied or stored, the server generates one. After every successful deployment, the CLI writes the deployed name to a CNAME file in the directory where the command ran.

The CLI resolves a site name in this order:

  1. The --subdomain option.
  2. A CNAME file in the current working directory.
  3. A CNAME file inside the deployment directory.
  4. A name generated by the server.

The CNAME file contains a Buzz site name, not a DNS CNAME record. Commit it when everyone deploying the project should target the same site. An explicit --subdomain value overrides it.