template

README

<ZDNS> ZDNS for Caddy

This package contains a DNS provider ZDNS for Caddy. It can be used to manage DNS records with <ZDNS>.

Caddy module name

dns.providers.zdns

Config examples

To use this module for the ACME DNS challenge, configure the ACME issuer in your Caddy JSON like so:

{
	"module": "acme",
	"challenges": {
		"dns": {
			"provider": {
				"name": "zdns",
				"api_token": "ZDNS_API_TOKEN"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns zdns ...
}

# one site
tls {
	dns zdns ...
}

Documentation

Index

• type Provider
  • func (Provider) CaddyModule() caddy.ModuleInfo
  • func (p *Provider) Provision(ctx caddy.Context) error
  • func (p *Provider) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Types

type Provider

type Provider struct{ *zdns.Provider }

Provider lets Caddy read and manipulate DNS records hosted by this DNS provider.

func (Provider) CaddyModule

func (Provider) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Provider) Provision

func (p *Provider) Provision(ctx caddy.Context) error

TODO: This is just an example. Useful to allow env variable placeholders; update accordingly. Provision sets up the module. Implements caddy.Provisioner.

func (*Provider) UnmarshalCaddyfile

func (p *Provider) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile sets up the DNS provider from Caddyfile tokens. Syntax:

zdns [<api_token>] {
    api_token <api_token>
}