template

README

DEVELOPER INSTRUCTIONS:

• Update module name in go.mod
• Update dependencies to latest versions
• Update name and year in license
• Customize configuration and Caddyfile parsing
• Update godocs / comments (especially provider name and nuances)
• Update README and remove this section

---

<PROVIDER> module for Caddy

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

Caddy module name

dns.providers.provider_name

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": "provider_name",
				"api_token": "YOUR_PROVIDER_API_TOKEN"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns provider_name ...
}

# one site
tls {
	dns provider_name ...
}

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

TODO: This is just an example. Update accordingly. UnmarshalCaddyfile sets up the DNS provider from Caddyfile tokens. Syntax:

webpanel {
    host <host_url>
    key <api_key>
}

**THIS IS JUST AN EXAMPLE AND NEEDS TO BE CUSTOMIZED.**