caddy

package module
v0.0.0-...-ab62b7a Latest Latest
Warning

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

Go to latest
Published: Dec 31, 2021 License: MIT Imports: 3 Imported by: 0

README

West.cn 西部数码 dns provider for caddy

Caddy module name

dns.providers.westcn

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": "westcn",
        "username": "{env.WESTCN_USERNAME}",
        "password": "{env.WESTCN_PASSWORD}",
        "endpoint": "{env.WESTCN_ENDPOINT}"
      }
    }
  }
}

or with the Caddyfile

tls {
	dns westcn {env.WESTCN_USERNAME} {env.WESTCN_PASSWORD}
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider

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

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

Provision 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:

westcn <username> <password> {
    username <username>
    password <password>
	   endpoint <endpoint>
}

Expansion of placeholders in the API token is left to the JSON config caddy.Provisioner (above).

Jump to

Keyboard shortcuts

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