easydns

README

EasyDNS module for Caddy

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

Caddy module name

dns.providers.easydns

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": "easydns",
				"api_token": "YOUR_PROVIDER_API_TOKEN",
				"api_key": "YOUR_PROVIDER_API_KEY",
				"api_url": "https://rest.easydns.net"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns easydns {
		api_token <your_api_token>
		api_key <your_api_key>
		api_url "https://rest.easydns.net"
	}
}

# one site
tls {
	dns easydns {
		api_token <your_api_token>
		api_key <your_api_key>
		api_url "https://rest.easydns.net"
	}
}

Alternatively, the token and key can be specified in environment variables and the URL can also be overridden via the environment

• CADDY_EASYDNS_TOKEN
• CADDY_EASYDNS_KEY
• CADDY_EASYDNS_URL

If you only want to use the environment overrides, then the caddy file might look similar to:

# globally
{
	acme_dns easydns
}

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

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

providername [<api_token>] {
    api_token <api_token>
}

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