dnspod

package module
v0.0.4 Latest Latest
Warning

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

Go to latest
Published: Feb 8, 2022 License: MIT Imports: 3 Imported by: 2

README

DNSPOD module for Caddy

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

Caddy module name

dns.providers.dnspod

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": "dnspod",
        "auth_token": "{env.DNSPOD_TOKEN}"
      }
    }
  }
}

or with the Caddyfile:

tls {
  dns dnspod {env.DNSPOD_TOKEN}
}

You can replace {env.DNSPOD_TOKEN} with the actual auth token, which format is "APP_ID,APP_TOKEN", if you prefer to put it directly in your config instead of an environment variable.

Authenticating

See the associated README in the libdns package for important information about credentials.

NOTE: If migrating from Caddy v1, you will need to change from using a DNSPOD API Key to a scoped API Token. Please see link above for more information.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider

type Provider struct{ *dnspod.Provider }

Provider wraps the provider implementation as a Caddy module.

func (Provider) CaddyModule

func (Provider) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Provider) Provision added in v0.0.3

func (p *Provider) Provision(ctx caddy.Context) error

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

func (*Provider) UnmarshalCaddyfile

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

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

dnspod [<api_token>] {
    api_token <api_token>
}

Jump to

Keyboard shortcuts

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