OrbitsDocs
esc
    Open Orbits
    DomainsOverview

    Domains

    Every project's free theorbits.app address, the custom domains your team adds, what a domain can serve, and where to manage them.

    Every project answers on a free address the moment it's deployed. You can add domains you own on top, point them at a project's production or at a branch, or make them redirect.

    The free address

    Each project gets https://<project>.theorbits.app, from its slug, with a certificate. It always serves the project's current production deployment. On the project's Domains page it's listed as Free address from Orbits.

    The slug is unique across Orbits, so the free address is yours for as long as the project keeps its name. Renaming the project changes it (see rename a project).

    Orbits also gives each deployment and each branch with a ready preview an address under theorbits.app:

    AddressServes
    <project>.theorbits.appProduction
    <project>-<sha7>.theorbits.appOne deployment
    <project>-git-<branch>.theorbits.appA branch's newest ready preview

    See deployment addresses and preview addresses.

    Custom domains

    A custom domain is a name you own, such as shop.example.com or example.com, added to your team. Domains belong to the team rather than to one project, so:

    • the team's Domains and DNS page lists every domain the team has, with filters for status, DNS and project;
    • a project's Domains page lists the domains pointing at that project ("Addresses that point at this project. Their DNS records live in the team's Domains and DNS.");
    • a domain can be added before any project uses it, and moved from one project to another;
    • deleting a project detaches its domains rather than deleting them.

    A domain belongs to one team. If another team already has it, adding it is refused.

    What a domain can serve

    When you add a domain, or later with Change on its hostname card, you choose what it does:

    ChoiceWhat visitors get
    Serve productionThe project's current production deployment.
    Serve a preview branchThe newest ready preview of the branch you pick, as it changes with each push. Good for staging.example.com.
    Redirect to another domainA 308 redirect, keeping the path, to another of the team's domains or the project's free address. Good for sending www.example.com to example.com.
    No projectNothing yet: the domain is kept, shown as Not in use.

    The project's Domains page shows production's domains, the branch addresses under Follows the branch, and redirects under Redirects.

    Two ways to set up DNS

    Add one recordUse Orbits DNS
    Your DNS staysAt your current providerMoves to Orbits
    What you doAdd one record where the domain's DNS is hostedPoint the domain's nameservers at ns1.theorbits.app and ns2.theorbits.app
    Good forOne subdomain, or keeping a DNS setup you already haveA whole domain, managing every record here, including email

    Either way, Orbits checks the DNS, issues the certificate once it's found, then serves the domain. See custom domains for adding one, and Orbits DNS for handing your DNS to Orbits.

    States

    StateMeaning
    Waiting for DNS (pending)The record (or nameservers) isn't there yet.
    ValidDNS points at Orbits.
    MisconfiguredA record is there but points elsewhere; the domain page shows what was found.

    Separately, each domain's certificate is waiting, active or failed. The team page's stat cards count the domains that need attention.

    Who can manage domains

    Owners, admins and members add, change and remove domains and DNS records. Viewers see them. Anyone in the team can press Check now.

    Next

    Was this page helpful?

    Updated