connbyte

README

ConnByte module for Caddy

This package contains a DNS provider module for Caddy. It can be used to manage DNS records with ConnByte, for example to get wildcard certificates with the ACME DNS challenge.

It uses libdns/connbyte and the ConnByte DNS API.

Caddy module name

dns.providers.connbyte

Build

xcaddy build --with github.com/caddy-dns/connbyte

Config examples

Create an API token in your ConnByte account.

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": "connbyte",
				"api_token": "{env.CONNBYTE_TOKEN}"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns connbyte {env.CONNBYTE_TOKEN}
}

# one site
*.example.com {
	tls {
		dns connbyte {env.CONNBYTE_TOKEN}
	}
}

Block syntax:

dns connbyte {
	api_token {env.CONNBYTE_TOKEN}
}

Documentation

Overview

Package connbyte provides a Caddy DNS provider module for ConnByte (https://connbyte.com/).

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{ *libdnsconnbyte.Provider }

Provider lets Caddy read and manipulate DNS records hosted by ConnByte.

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. It resolves placeholders such as {env.CONNBYTE_TOKEN}.

func (*Provider) UnmarshalCaddyfile

func (p *Provider) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

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

connbyte [<api_token>] {
    api_token <api_token>
    base_url <url>
}