README
¶
Enzonix DNS provider for Caddy
dns.providers.enzonix is a Caddy module that lets you solve ACME DNS challenges using the Enzonix DNS API. The module only requires an API key to operate.
Installation
Build Caddy with the Enzonix provider:
xcaddy build --with github.com/Enzonix-LLC/dns-caddy
Configuration
JSON
{
"module": "acme",
"challenges": {
"dns": {
"provider": {
"name": "enzonix",
"api_key": "{env.ENZONIX_API_KEY}"
}
}
}
}
Caddyfile
tls {
dns enzonix {env.ENZONIX_API_KEY}
}
Optional parameters
enzonix {
api_key {env.ENZONIX_API_KEY}
endpoint https://api.enzonix.com/v1/dns
timeout 10s
}
api_key(required): API token issued by Enzonix.endpoint(optional): Override the API base URL (useful for development or regional endpoints).timeout(optional): HTTP client timeout; defaults to10s.
Authentication
Supply your Enzonix API key via the api_key field or an environment variable placeholder ({env.ENZONIX_API_KEY}).
Development
-
Install dependencies with
go mod tidy. -
Run tests:
go test ./...
License
MIT © Enzonix
Documentation
¶
Index ¶
- type Provider
- func (p *Provider) AppendRecords(ctx context.Context, zone string, recs []libdns.Record) ([]libdns.Record, error)
- func (*Provider) CaddyModule() caddy.ModuleInfo
- func (p *Provider) DeleteRecords(ctx context.Context, zone string, recs []libdns.Record) ([]libdns.Record, error)
- func (p *Provider) GetRecords(ctx context.Context, zone string) ([]libdns.Record, error)
- func (p *Provider) Provision(ctx caddy.Context) error
- func (p *Provider) SetRecords(ctx context.Context, zone string, recs []libdns.Record) ([]libdns.Record, error)
- func (p *Provider) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
- func (p *Provider) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
APIKey string `json:"api_key,omitempty"`
APIEndpoint string `json:"api_endpoint,omitempty"`
Timeout caddy.Duration `json:"timeout,omitempty"`
// contains filtered or unexported fields
}
Provider implements the libdns interfaces for Enzonix.
func (*Provider) AppendRecords ¶
func (p *Provider) AppendRecords(ctx context.Context, zone string, recs []libdns.Record) ([]libdns.Record, error)
AppendRecords adds records to the zone.
func (*Provider) CaddyModule ¶
func (*Provider) CaddyModule() caddy.ModuleInfo
CaddyModule returns the Caddy module information.
func (*Provider) DeleteRecords ¶
func (p *Provider) DeleteRecords(ctx context.Context, zone string, recs []libdns.Record) ([]libdns.Record, error)
DeleteRecords removes records from the zone.
func (*Provider) GetRecords ¶
GetRecords retrieves records for the zone.
func (*Provider) SetRecords ¶
func (p *Provider) SetRecords(ctx context.Context, zone string, recs []libdns.Record) ([]libdns.Record, error)
SetRecords replaces the existing zone records with the provided set.
func (*Provider) UnmarshalCaddyfile ¶
UnmarshalCaddyfile parses the Caddyfile tokens.
Source Files