dnsimple

README

DNSimple module for Caddy

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

Caddy module name

dns.providers.dnsimple

DNSimple API access tokens

An account_id must be provided when using this module with a DNSimple user token. The account_id can be omitted when using an account token since the account token already defines the account being used.

See the article on account tokens vs user tokens for more information.

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": "dnsimple",
        "account_id": "YOUR_ACCOUNT_ID",
        "api_access_token": "YOUR_API_ACCESS_TOKEN"
      }
    }
  }
}

or with the Caddyfile:

Global setting

{
	acme_dns dnsimple {$DNSIMPLE_API_ACCESS_TOKEN}
}

example.com {
	...
}

Single site setting

example.com {
	tls {
		dns dnsimple {$DNSIMPLE_API_ACCESS_TOKEN}
	}
	...
}

Provide account ID

example.com {
	tls {
		dns dnsimple {
			account_id {$DNSIMPLE_ACCOUNT_ID}
			api_access_token {$DNSIMPLE_API_ACCESS_TOKEN}
		}
	}
	...
}

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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

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

dnsimple [<api_access_token>] {
    api_access_token <api_access_token>
    account_id <account_id>
}