constellix

package module
v0.0.0-...-bd88b06 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 13, 2024 License: MIT Imports: 4 Imported by: 0

README

Constellix DNS module for Caddy

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

Caddy module name

dns.providers.constellix

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": "constellix",
				"api_key": "CONSTELLIX_API_KEY",
				"secret_key": "CONSTELLIX_SECRET_KEY"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns constellix ...
}
# one site
tls {
	dns constellix ...
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider

type Provider struct{ *libdnstemplate.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

TODO: This is just an example. Update accordingly. UnmarshalCaddyfile sets up the DNS provider from Caddyfile tokens. Syntax:

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL