hyperone.toml 1.7 KB

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