glesys

README

Glesys module for Caddy

This package contains a DNS provider module for Caddy.

It can be used to manage DNS records with Glesys.

Caddy module name

dns.providers.glesys

Config examples

Caddyfile

somehost.example.org
tls {
        issuer acme {
                email "<your email for acme notifications>"
                dns glesys {
                        project "YOUR_GLESYS_PROJECT/USER"
                        api_key "YOUR_GLESYS_API_KEY"
                }
        }
}
respond "Hello, world!"

JSON

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": "glesys",
				"project": "YOUR_GLESYS_PROJECT/USER",
				"api_key": "YOUR_GLESYS_API_KEY"
			}
		}
	}
}

Documentation

Overview

SPDX-FileCopyrightText: 2024 Peter Magnusson <me@kmpm.se> SPDX-License-Identifier: MIT

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

glesys [<project> api_key] {
    project <project/user>
    api_key <api_key>
}