ovh

README

OVH module for Caddy

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

Caddy module name

dns.providers.ovh

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": "ovh",
        "endpoint": "{env.OVH_ENDPOINT}",
        "application_key": "{env.OVH_APPLICATION_KEY}",
        "application_secret": "{env.OVH_APPLICATION_SECRET}",
        "consumer_key": "{env.OVH_CONSUMER_KEY}",
      }
    }
  }
}

or with the Caddyfile:

tls {
  dns ovh {
    endpoint {$OVH_ENDPOINT}
    application_key {$OVH_APPLICATION_KEY}
    application_secret {$OVH_APPLICATION_SECRET}
    consumer_key {$OVH_CONSUMER_KEY}
  }
}

You can replace {$*} or {env.*} with the actual values 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.

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{ *ovh.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(ctx caddy.Context) error

Provision implements the Provisioner interface to initialize the OVH client

func (*Provider) UnmarshalCaddyfile

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

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

ovh {
    endpoint <string>
    application_key <string>
    application_secret <string>
    consumer_key <string>
}