bunny

README

Bunny.net module for Caddy

This package contains a DNS provider module for Caddy. It can be used to manage DNS records with Bunny.net accounts.

Caddy module name

dns.providers.bunny

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": "bunny",
				"access_key": "{env.BUNNY_API_KEY}",
			}
		}
	}
}

or with the Caddyfile:

tls {
	acme_dns bunny {env.BUNNY_API_KEY}
}

You can replace {env.BUNNY_API_KEY} with the actual auth token if you prefer to put it directly in your config instead of an environment variable.

Authenticating

To authenticate you need to supply a Bunny.net API Key.

Debugging

When global debug mode is enabled, this module logs additional information.

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{ *bunny.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

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:

bunny [<access_token>] {
    access_key <access_token>
}

Expansion of placeholders in the API token is left to the JSON config caddy.Provisioner (above).