lego/docs/content/dns/zz_gen_hyperone.md at ff0377ac02dd60a600a77ae93097cb6404e2853c

2020-08-24 23:50:52 +02:00

title	date	draft	slug
HyperOne	2019-03-03T16:39:46+01:00	false	hyperone

Since:

Configuration for HyperOne.

Here is an example bash command using the HyperOne provider:

lego --dns hyperone --domains my.domain.com --email my@email.com run

Additional Configuration

Environment Variable Name	Description
`HYPERONE_API_URL`	Allows to pass custom API Endpoint to be used in the challenge (default https://api.hyperone.com/v2)
`HYPERONE_LOCATION_ID`	Specifies location (region) to be used in API calls. (default pl-waw-1)
`HYPERONE_PASSPORT_LOCATION`	Allows to pass custom passport file location (default ~/.h1/passport.json)
`HYPERONE_POLLING_INTERVAL`	Time between DNS propagation check
`HYPERONE_PROPAGATION_TIMEOUT`	Maximum waiting time for DNS propagation
`HYPERONE_TTL`	The TTL of the TXT record used for the DNS challenge

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

Default configuration does not require any additional environment variables, just a passport file in ~/.h1/passport.json location.

To use this application you have to generate passport file for sa:

h1 sa credential generate --name my-passport --sa <sa ID> --passport-output-file ~/.h1/passport.json

Depending of environment variables usage, the application requires different permissions: