docs
Try the demo Get started
Esc
↑↓ moveEnter openEsc close

Run it · 4 of 12

DNS, DKIM and certificates

How inbuxa handles a domain's DNS records, DKIM keys and TLS certificates: by hand, or kept up to date by the server through your DNS host and an ACME provider.

11 min read

On this page

Every domain needs three things kept right: its DNS records, its DKIM keys, and a TLS certificate for the names clients connect to. Each one can be done by hand or left to the server, separately, per domain.

By hand Left to the server
DNS records You add them at your DNS host, from a list the server gives you The server writes them through your DNS host's API, and rewrites them when anything changes
DKIM keys You create and publish keys The server creates them, and with automatic DNS also publishes, rotates and retires them. This is the default
Certificates You upload them The server gets and renews them from an ACME provider such as Let's Encrypt

All three are set in the console. The webmail's Administration shows the records and keys, and which way each domain is set, but changing it is the console's job. See the webmail's side below.

DNS records

A new domain's DNS Management is Manual DNS management: the server tells you what to publish, and you publish it.

By hand

The records to publish are listed in the webmail's Administration › Domains, each with a copy button, and Copy all as a zone file for hosts that can import one.

The console lists them too, and checks them as you go. On the domain's page, choose Set it up, then Guide me. When your DNS host is one the server can't update, or you choose Add the records by hand instead, the guide becomes a list of the records to add. Each one ticks green once the internet can see it.

The console checks by asking Cloudflare's public DNS-over-HTTPS resolver, so a green tick means the record is visible from outside, not only from your own network. The page says which resolver it asks.

Left to the server

The server can write the records itself, through the API of your DNS host. It supports 68 hosts, plus RFC 2136 dynamic updates for a DNS server you run yourself. Among them are Cloudflare, AWS Route 53, Google Cloud DNS, Azure DNS, DigitalOcean, Hetzner, OVH, Gandi, Porkbun, Namecheap, GoDaddy, IONOS, Linode, Vultr, deSEC, and cPanel and Plesk servers.

On the domain's page, the card Let the server publish your DNS records has Set it up, which offers Guide me or I'll do it myself.

The domain's DNS card, and the choice between Guide me and I'll do it myself

Guide me opens Publish DNS for your domain, in five steps:

  1. Your DNS host. The console looks up where the domain's DNS is hosted and names the host it found. If that's wrong, choose your host from the list. If it's a host the server can't update, you are offered the records to add by hand instead.
  2. Connect. Paste an API key for that host, or reuse a connection you already have. Give the server a key that can edit DNS for this domain and nothing else: if it ever leaked, that's all it could touch. The key is stored in the server's settings and never shown again.
  3. Records. Choose which records to publish. Only the names listed are written. Records the server doesn't own, such as your website's, are left as they are.
  4. Review. What will happen, before anything changes.
  5. Go live. The connection is saved, the domain switches to automatic DNS, and the server starts writing. Most hosts show the records within a minute or two, and each one ticks green as it goes live.

Publish DNS for a domain: each record to add, grouped by what it does, with its live check

If a step fails, nothing is kept. If your DNS host turns the update down, the page says so and shows what the host said.

I'll do it myself goes straight to the domain's DNS Management setting. Set it to Automatic DNS management, with:

Field What it is
DNS Server The connection to your DNS host, from Settings › Network › DNS providers
Zone Origin Only when the domain sits inside a bigger zone at your host, such as mail.example.com kept in example.com
Record Types Which records to publish

Record Types starts with everything except TLSA and CAA:

Record On by default
DKIM public keys, SPF records, MX records, DMARC policy yes
SRV records, Autoconfig records, Legacy Autoconfig records, Microsoft Autodiscover records yes
MTA-STS policy record, TLS reporting record yes
TLSA records, CAA records no

TLSA (DANE) records pin a certificate. Publish them only when you understand what happens to them when the certificate is renewed.

CAA records

A CAA record goes at the top of the domain, names your ACME provider, and ties it to this server's ACME account. It covers every name under the domain, so any other ACME client there, such as certbot on a web server, is refused at its next renewal, even with the same provider. Nothing warns you when it's published, and the failure can come weeks later.

Turn it on only if this server is the only thing getting certificates under the domain. If the server only handles mail.example.com, add that as its own domain instead of example.com, and the record stays off everything else.

Older versions turned CAA on by default, so a domain connected back then may already have one. Turning CAA records off doesn't delete it: remove it at your DNS host too.

From then on, the server rewrites the records whenever something they depend on changes, such as a DKIM key rotating.

Only for certificates

A DNS-01 certificate order answers its challenge through the domain's automatic DNS connection. If that's all a domain needs, for example when its mail records are kept somewhere else, leave every Record Type off (in the guided setup, turn them all off at the Records step). Nothing is published, and the server still answers the challenge each time it orders or renews the certificate.

Older versions wouldn't save an empty list. There, turn on only TLS reporting record and leave the domain's report address empty: that record is only written when there's an address, so nothing is published.

Challenges answered in another zone

Some DNS hosts only allow updates in one zone set aside for challenges. Point each name's challenge there with a CNAME, and the server writes the answer at the end of it. Since server 27.1-rc.13.

For mail.example.com, with acme.example.com the zone that takes updates:

_acme-challenge.mail.example.com.  CNAME  acme.example.com.

On the domain, set DNS Server to the connection that can update acme.example.com, and Zone Origin to acme.example.com. Several names can point at the same place: the server answers their challenges one at a time. It follows up to eight CNAMEs, using its own resolver, so the CNAME has to be published before the order starts.

Stopping it

Set DNS Management back to Manual DNS management. Updates stop, and the records already written stay where they are.

DKIM keys

DKIM keys sign outgoing mail so receiving servers can check it came from you. A new domain's DKIM Management is Automatic DKIM management, with these defaults:

Field Default
Signing Algorithms DKIM1 (Ed25519 SHA-256) and DKIM1 (RSA SHA-256): a key of each kind
Selector Template v{version}-{algorithm}-{date-%Y%m%d}
Rotate After 90 days
Retire After 7 days
Delete After 30 days

Every setting after the algorithms depends on automatic DNS, because each step changes what is published:

  • Rotate After: how often a new key replaces the current one. The server creates it and publishes its record.
  • Retire After: how long the old key's record stays published after rotation, so mail it already signed can still be checked. Then the record is removed.
  • Delete After: how long the old key is kept on the server after rotation, before it's deleted for good.

With manual DNS, the domain's keys don't rotate. They keep signing until you replace them.

The keys are listed under Management › Domains › DKIM Signatures.

Manual DKIM management stops the rotation. You then create keys, and remove them, yourself.

Certificates

A new domain's Certificate Management is Manual TLS certificate management. For the server to get certificates itself, set it to ACME TLS certificate management, with:

Field What it is
ACME Provider Which provider to use, from Settings › Security › Automatic certificates (ACME)
Certificate Hostnames The names the certificate covers, in place of the defaults. Up to 27.1-rc.9 the field is called Additional Hostnames

Leave Certificate Hostnames empty for the defaults: *.example.org and example.org with a DNS challenge, otherwise mta-sts, ua-auto-config, autoconfig and autodiscover under the domain, plus the server name, mail exchangers and service hostnames within it. A list replaces all of that rather than adding to it. A name without a dot gets the domain added (mail becomes mail.example.org), and a name with a dot is used as written, so put example.org itself in the list if the certificate should cover it. Changing the list orders a new certificate straight away.

The certificates guide

Certificates, automatically, on Settings › Overview, sets this up for you in about two minutes:

  1. Domains. Pick them. Each shows whether it's managed by hand, and until when its current certificate is valid.
  2. Check names. Nothing is ordered yet. A domain whose DNS is connected is checked through DNS: its certificate covers the domain and everything under it (*.domain), and nothing needs to reach this server. Any other domain's names are looked up in public DNS and compared with where this server points, and each problem is named: a name that doesn't exist (add a CNAME to this server), one that goes through the Cloudflare proxy (set it to DNS only), or one that points somewhere else. Fix those and check again, connect the domain's DNS, or order anyway, and it keeps retrying until the names are fixed. One certificate covers all of a domain's names, so a single failing name holds up the whole order.
  3. Account. An email address for Let's Encrypt, which writes only about problems with your account or certificates. Creating the account accepts their Subscriber Agreement. A Let's Encrypt account already set up on the server is reused. Staging issues certificates browsers don't trust, with far looser limits: use it to see everything work, then run the guide again without it. Up to console 27.1-rc.7, the guide couldn't create an account and only worked with one already set up.
  4. Review. Which domains switch, how each is checked, and which are left as they are until their names are fixed.
  5. Watch them arrive. The guide checks every few seconds; most certificates arrive within a minute.

The server renews each certificate well before it expires. To undo, set a domain's Certificate Management back to manual; certificates already issued stay until they expire.

Order a certificate for names you choose

Order a certificate, on Settings › Security › Certificates, orders one certificate for the names you enter. Since console 27.1-rc.8.

  1. Names. One per line. A wildcard (*.example.org) covers every name one level under it. Every name has to fall under one of your domains, because the server orders each certificate for a domain, and the names become that domain's Certificate Hostnames. The guide picks the closest domain that covers them all. If none does, it offers to add one: a domain added this way is only for certificates, with no DKIM keys and nothing published. If the domain already orders a certificate, the guide says which names the new one drops; Keep those names too adds them back.
  2. Check names. With the domain's DNS connected, the names are checked through DNS. Otherwise Let's Encrypt connects to this server on port 443 for each name, so the guide looks each one up, as the certificates guide does. A wildcard can only be checked through DNS, so it needs the domain's DNS connected.
  3. Account. As in the certificates guide.
  4. Review. What the domain gets, how it's checked, and which names are no longer renewed.
  5. Watch it arrive. Once it's issued, Make it the default certificate makes it the one sent to a connection that asks for a name no certificate covers. A connection that asks for one of its names gets it either way, so there's nothing to assign.

Why an order failed

Ordered automatically, above the list on Settings › Security › Certificates, shows each certificate the server orders: its names, the domain that renews it, until when it's valid, and its next renewal. When an order fails, it shows the reason. A failed renewal is also under Management › Tasks › Failed.

Order again appears after a failure, or when nothing is queued. It runs the domain's renewal now instead of at the next retry, so fix what the reason says first. The list needs permission to read tasks; without it, only the names and dates show.

ACME providers

Under Settings › Security › Automatic certificates (ACME). A new provider starts with Let's Encrypt's directory. The fields that matter most:

Field Default What it is
Directory URL Let's Encrypt The provider's ACME directory
Challenge type TLS-ALPN-01 How you prove you own the name. DNS-01 works with automatic DNS, and is the one to use when port 443 doesn't reach the server
Contact Email none Where the provider sends expiry warnings
Renew before 2/3 of the remaining time until expiration When renewal starts
Key ID, HMAC Key none External account binding, for providers that need it

TLS-ALPN-01 is answered on port 443, so the server has to receive that port's TLS itself, not a proxy in front of it that ends TLS. HTTP-01 is answered on port 80.

A provider can belong to a tenant, in its Tenant field. That tenant's administrators then see and use it, and nobody else's domains can.

Certificates, whether from ACME or uploaded, are listed under Settings › Security › Certificates.

What the webmail shows

The webmail's Administration › Domains is for the people who look after domains day to day. For each domain it shows:

  • whether its DNS records, DKIM keys and certificate are Automatic or By hand;
  • its DNS records, each with a copy button, and Copy all as a zone file;
  • its DKIM keys, and where each one is in its life.

It doesn't change any of those settings. Moving a domain between automatic and manual, connecting a DNS host, and choosing an ACME provider are done in the console.

The webmail's Administration › Domains, with a domain open: its settings and its DNS records, each with a copy button

See Administration › Domains for the webmail's side in full.

DNS lookups the server makes

Settings › Network › DNS resolver sets how the server itself looks names up, for delivering mail and checking senders: System Resolver, a Custom DNS server, or Cloudflare DNS, Quad9 DNS or Google DNS. This is separate from publishing records.