infomaniak

package module
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Jun 1, 2024 License: MIT Imports: 3 Imported by: 0

README

infomaniak module for Caddy

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

Caddy module name

dns.providers.infomaniak

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

or with the Caddyfile:

# globally
{
	acme_dns infomaniak {env.INFOMANIAK_API_TOKEN}
}
# one site
tls {
	dns infomaniak {env.INFOMANIAK_API_TOKEN}
}

You can replace {env.INFOMANIAK_API_TOKEN} with the actual auth token if you prefer to put it directly in your config instead of an environment variable.

Authenticating

Refer to the README of the libdns package for information on how to get your infomaniak API token.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider

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

infomaniak [<api_token>] {
    api_token <api_token>
}

Jump to

Keyboard shortcuts

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