1 Name = "HyperOne"
2 Description = ''''''
3 URL = "https://www.hyperone.com"
4 Code = "hyperone"
5 Since = "v3.9.0"
6 7 Example = '''
8 lego --dns hyperone -d '*.example.com' -d example.com run
9 '''
10 11 Additional = '''
12 ## Description
13 14 Default configuration does not require any additional environment variables,
15 just a passport file in `~/.h1/passport.json` location.
16 17 ### Generating passport file using H1 CLI
18 19 To use this application you have to generate passport file for `sa`:
20 21 ```
22 h1 iam project sa credential generate --name my-passport --project <project ID> --sa <sa ID> --passport-output-file ~/.h1/passport.json
23 ```
24 25 ### Required permissions
26 27 The application requires following permissions:
28 - `dns/zone/list`
29 - `dns/zone.recordset/list`
30 - `dns/zone.recordset/create`
31 - `dns/zone.recordset/delete`
32 - `dns/zone.record/create`
33 - `dns/zone.record/list`
34 - `dns/zone.record/delete`
35 36 All required permissions are available via platform role `tool.lego`.
37 '''
38 39 [Configuration]
40 [Configuration.Additional]
41 HYPERONE_PASSPORT_LOCATION = "Allows to pass custom passport file location (default ~/.h1/passport.json)"
42 HYPERONE_API_URL = "Allows to pass custom API Endpoint to be used in the challenge (default https://api.hyperone.com/v2)"
43 HYPERONE_LOCATION_ID = "Specifies location (region) to be used in API calls. (default pl-waw-1)"
44 HYPERONE_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)"
45 HYPERONE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 2)"
46 HYPERONE_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 60)"
47 HYPERONE_HTTP_TIMEOUT = "API request timeout in seconds (Default: 30)"
48 49 [Links]
50 API = "https://api.hyperone.com/v2/docs"
51