template

README

clouddns module for Caddy

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

Caddy module name

dns.provider.clouddns

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": "clouddns",
        "json_key_file": "path to json key file",
        "project": "project name"
      }
    }
  }
}

or with the Caddyfile:

# globally
{
  acme_dns clouddns {
    json_key_file {env.GOOGLE_APPLICATION_CREDENTIALS}
    project {env.PROJECT_ID}
  }
}

# one site
tls {
  dns clouddns {
    json_key_file {env.GOOGLE_APPLICATION_CREDENTIALS}
    project {env.PROJECT_ID}
  }
}

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{ *clouddns.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:

clouddns {env.GOOGLE_APPLICATION_CREDENTIALS}

clouddns {
    json_key_file {env.GOOGLE_APPLICATION_CREDENTIALS}
    project {env.PROJECT_ID}
}

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