miab

README

Mail-In-A-Box custom DNS API module for Caddy

This package contains a DNS provider module for Caddy. It can be used to manage DNS records with Mail-In-A-Box.

Caddy Mail-In-A-Box

dns.providers.miab

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": "miab",
				"api_url": "https://[your main-in-a-box domain name]/admin/dns/custom"
                "email_address": "[admin account email address]"
                "password": "[corresponding password]"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns maib {
        api_url https://[your main-in-a-box domain name]/admin/dns/custom
        email_address [admin account email address]
        password [corresponding password]
    }
}

# one site
tls {
	dns maib {
        api_url https://[your main-in-a-box domain name]/admin/dns/custom
        email_address [admin account email address]
        password [corresponding password]
    }
}

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

miab {
    api_url <api_url>
    email_address <email_address>
    password <password>
}