template

README

TransIP module for Caddy

This package contains a DNS provider module for Caddy. It can be used to manage DNS records with TransIP. It makes use of libdns/transip

Caddy module name

dns.providers.transip

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": "transip",
				"account_name": "YOUR_TRANSIP_ACCOUNT_NAME",
				"private_key_path": "PATH_TO_YOUR_TRANSIP_PRIVATE_KEY"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns transip <accountName> <privateKeyPath>
}

# one site
tls {
	dns transip <accountName> <privateKeyPath>
}

or alternatively:

tls {
	dns transip {
		account_name <accountName> 
		private_key_path <privateKeyPath>
	}
}

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

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

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