netlify

README

NETLIFY module for Caddy

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

Caddy module name

dns.providers.netlify

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": "netlify",
				"api_token": "YOUR_PERSONNAL_ACCESS_TOKEN"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns netlify ... 
}

# one site
tls {
	dns netlify ...
}

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

Provider wraps the provider implementation as a Caddy module.

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

Before using the provider config, resolve placeholders in the API token. Implements caddy.Provisioner.

func (*Provider) UnmarshalCaddyfile

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

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

netlify <api_token>

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