ApisCP Docs

# Hetzner DNS Provider

This is a drop-in provider for ApisCP (opens new window) to enable DNS support for accounts that use Hetzner. This provider is built into Hetzner.

# Configuring

EditDomain -c dns,provider=hetzner -c dns,key=21KUB...tIYvUSq domain.com

Where the key is created within Hetzner. See Hetzner: Getting Started (opens new window) for information.

# Setting as default

Hetzner may be configured as the default provider for all sites using the dns.default-provider Scope (opens new window). When adding a site in Nexus or AddDomain (opens new window) the key will be replaced with "DEFAULT". This is substituted automatically on account creation.

In a multi-user environment, Keyring usage is necessary to protect users from accessing the password. When setting this value using the dns.default-provider-key in 3.2.42+, this value is automatically encoded as a Keyring value. Automatic wrapping as a Keyring object may be altered by changing [auth] => keyring_provider_types.

cpcmd scope:set dns.default-provider hetzner
# Note, this method is insecure prior to 3.2.42, see below!
cpcmd scope:set dns.default-provider-key '21KUB...tIYvUSq'

WARNING

Note that it is not safe to set this value directly in config.ini as a server-wide default in untrusted multiuser environments. A user with panel access can retrieve your key common_get_service_value dns key or even using Javascript in the panel, apnscp.cmd('common_get_service_value',['dns','key'], {async: false}).

Implicit Keyring encoding masks the actual value using a server secret.

# Components

# Minimal module methods

All module methods can be overwritten. The following are the bare minimum that are overwritten for this DNS provider to work:

  • atomicUpdate() attempts a record modification, which must retain the original record if it fails
  • zoneAxfr() returns all DNS records
  • add_record() add a DNS record
  • remove_record() removes a DNS record
  • get_hosting_nameservers() returns nameservers for the DNS provider
  • add_zone_backend() creates DNS zone
  • remove_zone_backend() removes a DNS zone

See also: Creating a provider (opens new window) (hq.apnscp.com)

# Contributing

Submit a PR and have fun!

← Katapult DNS Provider →