vercel

README

Vercel module for Caddy

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

Caddy module name

dns.providers.vercel

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": "vercel",
        "api_token": "YOUR_VERCEL_AUTH_API_TOKEN"
      }
    }
  }
}

or with the Caddyfile:

your.domain.com {
  respond "Hello World"	# replace with whatever config you need...
  tls {
    dns vercel {env.YOUR_HETZNER_AUTH_API_TOKEN}
  }
}

You can replace {env.YOUR_VERCEL_AUTH_API_TOKEN} with the actual auth token if you prefer to put it directly in your config instead of an environment variable.

Authenticating

See the associated README in the fairhat/libdns-vercel 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{ *vercel.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

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:

vercel [<api_token>] {
    api_token <api_token>
}