OrbitsDocs
esc
    Open Orbits
    DomainsOrbits DNS

    Use Orbits DNS

    Hand a domain's DNS to Orbits by pointing its nameservers at ns1 and ns2.theorbits.app, then manage its records, import a zone file and set up email here.

    With Orbits DNS, Orbits answers for the whole domain. It keeps the records your projects need by itself, and you manage every other record (email, verification TXT records and so on) on the domain's page in Orbits.

    Hand a domain to Orbits

    Press Add domain on the team's Domains and DNS page, type the domain and choose Use Orbits DNS ("Hand its DNS to Orbits and manage every record here."). The domain becomes a zone, and its page shows the nameservers to use:

    text
    ns1.theorbits.app
    ns2.theorbits.app

    What you do with them depends on the domain:

    At your registrar (where you bought the domain), replace its nameservers with ns1.theorbits.app and ns2.theorbits.app. Remove any others.

    Before you switch, copy your existing records into Orbits (see import a zone file), so email and anything else on the domain keeps working the moment the nameservers change.

    Verification

    The domain page's Nameservers card shows what Orbits found. The zone is valid once all of its nameservers are Orbits', and misconfigured while only some are. Orbits asks the parent zone (for example.com, the .com registry) which nameservers it hands out, so the change shows as soon as the registry publishes it rather than after a cached answer expires. Registries can still take a few hours to publish: "Nameserver changes can take a few hours to spread."

    If the nameservers still aren't Orbits' an hour after you added the zone, the person who added it gets one email saying what to change and what was found.

    Records Orbits keeps

    You don't add records for your projects: Orbits creates them, marked Managed by Orbits, and keeps them in step with the team's domains.

    • When the zone's own name serves a project, it gets an A record to Orbits and, for an apex, a www CNAME to cname.theorbits.app beside it. Add your own www record and it replaces Orbits'.
    • Each name in the zone that serves a project, such as shop.example.com, gets a CNAME to cname.theorbits.app.

    Managed records can't be edited or deleted on the zone's page: "Records used by a project are created by Orbits. Change them from that project's Domains page." To serve another name, add it as a domain from the project; Orbits adds its record, so there's nothing to wait for at another provider.

    When a name in the zone starts serving a project, your own A, AAAA or CNAME records at that name are deleted, since you've chosen to point it at the project.

    Domains added inside the zone are on Orbits DNS whatever you choose, and removing the zone hands its subdomains back to outside DNS.

    Your records

    The zone's page lists its records. Press Add record to add one, or use a record's menu to edit or delete it. Changes on Orbits DNS go live in under a minute.

    TypeValue
    AAn IPv4 address
    AAAAAn IPv6 address
    CNAMEA hostname
    MXA priority and a mail server, such as 10 mx.example.com
    TXTThe text to publish, without quotes
    CAAFlags, a tag and a value, such as 0 issue "letsencrypt.org"

    Names are relative to the zone, with @ for the zone itself, and can include *. for a wildcard and underscores (for _dmarc and similar). Values are up to 2,048 characters.

    TTL is one of Auto (5 minutes), 1 minute, 5 minutes, 1 hour or 1 day.

    Rules a record must follow:

    • A CNAME can't sit at @: use an A record there.
    • A CNAME can't share its name with any other record.
    • A name Orbits manages for a project can't take another record there.
    • The same record (type, name and value) can't be added twice.

    The zone's SOA and NS records are Orbits' and aren't listed.

    Import a zone file

    To bring records over from another provider, export the zone from it (most offer a BIND zone file) and choose Import zone file on the zone's page. Paste the file or drop it in. Orbits shows what it found before anything is saved, such as "4 records found: 1 new, 3 already here", then Import adds the new ones.

    • Records already in the zone (same type, name and value) are left as they are.
    • Lines Orbits can't use are counted as skipped, not guessed at: SOA and NS records, records for another domain, types Orbits doesn't host, and names it manages for a project.
    • A record written over several lines in parentheses, such as a long DKIM key, counts as one.
    • A TTL is rounded to the nearest one Orbits offers.

    A zone file can be up to 200,000 characters.

    Email

    Email setup on the zone's page adds the MX and SPF records for Google Workspace, Microsoft 365 or Zoho Mail in one step. See email records.

    Limits and what's not available yet

    • Zones don't nest. A zone around one your team already has on Orbits DNS is refused, and so is one inside or around another team's zone.
    • One team per name. A domain or zone belongs to one team.
    • Not available yet: DNSSEC, and zone transfers to a secondary nameserver.

    The API for records and zone imports is in DNS.

    Was this page helpful?

    Updated