VinylDNS :: Let’s Encrypt client and ACME library written in Go.
Author: Lego Team
Description: Configuration for VinylDNS.
Date: 2019-03-03T16:39:46+01:00

# VinylDNS

Configuration for VinylDNS.

- Code: `vinyldns`
- Since: v4.4.0

Here is an example bash command using the VinylDNS provider:

    VINYLDNS_ACCESS_KEY=xxxxxx \
    VINYLDNS_SECRET_KEY=yyyyy \
    VINYLDNS_HOST=https://api.vinyldns.example.org:9443 \
    lego --email you@example.com --dns vinyldns -d '*.example.com' -d example.com run

## Credentials

Environment Variable Name | Description
--- | ---
`VINYLDNS_ACCESS_KEY` | The VinylDNS API key
`VINYLDNS_HOST` | The VinylDNS API URL
`VINYLDNS_SECRET_KEY` | The VinylDNS API Secret key

The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information here.

## Additional Configuration

Environment Variable Name | Description
--- | ---
`VINYLDNS_POLLING_INTERVAL` | Time between DNS propagation check in seconds (Default: 4)
`VINYLDNS_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation in seconds (Default: 120)
`VINYLDNS_TTL` | The TTL of the TXT record used for the DNS challenge in seconds (Default: 30)

The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information here.

The vinyldns integration makes use of dotted hostnames to ease permission management. Users are required to have DELETE ACL level or zone admin permissions on the VinylDNS zone containing the target host.

## More information

- API documentation
- Go client