template

README

Manual DNS module for Caddy

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

Caddy module name

dns.providers.manual_dns

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": "manual_dns",
				"wait_in_mins": "1",
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns manual_dns ...
}

# one site
tls {
	dns manual_dns ...
}

Documentation

Index

• type Provider
  • func (p *Provider) AppendRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
  • func (Provider) CaddyModule() caddy.ModuleInfo
  • func (p *Provider) DeleteRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
  • func (p *Provider) Provision(ctx caddy.Context) error
  • func (p *Provider) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Types

type Provider

type Provider struct {
	WaitInMins string `json:"wait_in_mins,omitempty"`
}

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

func (*Provider) AppendRecords

func (p *Provider) AppendRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)

AppendRecords doesn't do anything and simply returns the records that were asked to be added.

func (Provider) CaddyModule

func (Provider) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Provider) DeleteRecords

func (p *Provider) DeleteRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)

DeleteRecords doesn't do anything and simply returns the records that were asked to be deleted.

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:

providername [<wait_in_mins>] {
    wait_in_mins <wait_in_mins>
}