enum

README

enum module for Caddy

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

Caddy module name

dns.providers.enum

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": "enum",
				"api_key": "{env.ENUM_API_KEY}",
				"project_id": "{env.ENUM_PROJECT_ID}"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns enum {
		api_key {env.ENUM_API_KEY}
		project_id {env.ENUM_PROJECT_ID}
	}
}

# one site
tls {
	dns enum {
		api_key {env.ENUM_API_KEY}
		project_id {env.ENUM_PROJECT_ID}
	}
}

api_key is the API key of a service account, project_id the ID of the project that owns the zone. See libdns/enum for caveats.

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{ *enum.Provider }

Provider lets Caddy read and manipulate DNS records hosted by enum.

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:

enum {
    api_key <api_key>
    project_id <project_id>
}