inwx

package module
v0.4.0 Latest Latest
Warning

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

Go to latest
Published: May 2, 2025 License: MIT Imports: 3 Imported by: 0

README

INWX module for Caddy

Go Reference

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

Caddy module name

dns.providers.inwx

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": "inwx",
				"username": "INWX_USERNAME",
				"password": "INWX_PASSWORD",
				"shared_secret": "INWX_SHARED_SECRET",
				"endpoint_url": "INWX_ENDPOINT_URL"
			}
		}
	}
}

or with the Caddyfile:

# globally
{
	acme_dns inwx {
		username <username>
		password <password>
		shared_secret <shared_secret>
		endpoint_url <endpoint_url>
	}
}
# one site
tls {
	dns inwx {
		username <username>
		password <password>
		shared_secret <shared_secret>
		endpoint_url <endpoint_url>
	}
}

If you don’t provide an endpoint_url the URL of the production environment (https://api.domrobot.com/jsonrpc/) is used by default. If you want to use the test environment, set endpoint_url to https://api.ote.domrobot.com/jsonrpc/.

For more information on the configuration, see libdns/inwx.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider

type Provider struct{ *libdnsinwx.Provider }

Provider lets Caddy read and manipulate DNS records hosted by INWX.

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

Before using the provider config, resolve placeholders. Implements caddy.Provisioner.

func (*Provider) UnmarshalCaddyfile

func (p *Provider) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile sets up the DNS provider from Caddyfile tokens. Syntax:

inwx {
    username <username>
    password <password>
    shared_secret <shared_secret>
    endpoint_url <endpoint_url>
}

Jump to

Keyboard shortcuts

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