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

# Hurricane Electric DNS

Configuration for Hurricane Electric DNS.

- Code: `hurricane`
- Since: v4.3.0

Here is an example bash command using the Hurricane Electric DNS provider:

    HURRICANE_TOKENS=example.org:token \
    lego --email you@example.com --dns hurricane -d '*.example.com' -d example.com run

    HURRICANE_TOKENS=my.example.org:token1,demo.example.org:token2 \
    lego --email you@example.com --dns hurricane -d my.example.org -d demo.example.org

## Credentials

Environment Variable Name | Description
--- | ---
`HURRICANE_TOKENS` | TXT record names and tokens

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
--- | ---
`HURRICANE_HTTP_TIMEOUT` | API request timeout in seconds (Default: 30)
`HURRICANE_POLLING_INTERVAL` | Time between DNS propagation check in seconds (Default: 2)
`HURRICANE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation (Default: 300)
`HURRICANE_SEQUENCE_INTERVAL` | Time between sequential requests in seconds (Default: 60)

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

Before using lego to request a certificate for a given domain or wildcard (such as `my.example.org` or `*.my.example.org`), create a TXT record named `_acme-challenge.my.example.org`, and enable dynamic updates on it. Generate a token for each URL with Hurricane Electric’s UI, and copy it down. Stick to alphanumeric tokens for greatest reliability.

To authenticate with the Hurricane Electric API, add each record name/token pair you want to update to the `HURRICANE_TOKENS` environment variable, as shown in the examples. Record names (without the `_acme-challenge.` component) and their tokens are separated with colons, while the credential pairs are concatenated into a comma-separated list, like so:

    HURRICANE_TOKENS=my.example.org:token1,demo.example.org:token2

If you are issuing both a wildcard certificate and a standard certificate for a given subdomain, you should not have repeat entries for that name, as both will use the same credential.

    HURRICANE_TOKENS=example.org:token

## More information

- API documentation