allinkl

README

all-inkl module for Caddy

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

Caddy module name

dns.providers.allinkl

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": "allinkl",
				"kas_username": "YOUR_KAS_USERNAME",
				"kas_password": "YOUR_KAS_PASSWORD"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns allinkl {
		kas_username {env.KAS_USERNAME}
		kas_password {env.KAS_PASSWORD}
	}
}

# one site
tls {
  dns allinkl {
    kas_username {env.KAS_USERNAME}
    kas_password {env.KAS_PASSWORD}
  }
}

Docker Example

1. Install Docker and Docker Compose, then run:

wget -O - https://get.docker.com | bash

1. Navigate into the test-docker directory:

cd all-inkl/test-docker

1. Rename the .env.example file to .env and add your ALL-INKL KAS credentials.

2. Rename Caddyfile_Sample to Caddyfile, then edit the Caddyfile in the caddy directory to configure your desired domains and settings.

3. Build and start the Docker containers using Docker Compose:

docker compose up --build -d

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

allinkl [<username> <password>] {
    kas_username <username>
    kas_password <password>
}