metaname

README

Metaname module for Caddy

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

Caddy module name

dns.providers.metaname

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": "metaname",
				"api_key": "YOUR_API_KEY",
				"account_reference": "YOUR_ACCOUNT_REFERENCE"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns metaname {env.YOUR_METANAME_ACCOUNT_REFERENCE} {env.YOUR_METANAME_API_KEY}
}

# one site
tls {
	dns metaname {env.YOUR_METANAME_ACCOUNT_REFERENCE} {env.YOUR_METANAME_API_KEY}
}

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

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

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

providername [<account_reference>] [<api_key>] {
    account_reference <account_reference>
    api_key <api_token>
    endpoint <endpoint>
}