| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879 |
- Name = "OVH"
- Description = ''''''
- URL = "https://www.ovh.com/"
- Code = "ovh"
- Since = "v0.4.0"
- Example = '''
- # Application Key authentication:
- OVH_APPLICATION_KEY=1234567898765432 \
- OVH_APPLICATION_SECRET=b9841238feb177a84330febba8a832089 \
- OVH_CONSUMER_KEY=256vfsd347245sdfg \
- OVH_ENDPOINT=ovh-eu \
- lego --email you@example.com --dns ovh --domains my.example.org run
- # Or OAuth2:
- OVH_CLIENT_ID=yyy \
- OVH_CLIENT_SECRET=xxx \
- OVH_ENDPOINT=ovh-eu \
- lego --email you@example.com --dns ovh --domains my.example.org run
- '''
- Additional = '''
- ## Application Key and Secret
- Application key and secret can be created by following the [OVH guide](https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/).
- When requesting the consumer key, the following configuration can be used to define access rights:
- ```json
- {
- "accessRules": [
- {
- "method": "POST",
- "path": "/domain/zone/*"
- },
- {
- "method": "DELETE",
- "path": "/domain/zone/*"
- }
- ]
- }
- ```
- ## OAuth2 Client Credentials
- Another method for authentication is by using OAuth2 client credentials.
- An IAM policy and service account can be created by following the [OVH guide](https://help.ovhcloud.com/csm/en-manage-service-account?id=kb_article_view&sysparm_article=KB0059343).
- Following IAM policies need to be authorized for the affected domain:
- * dnsZone:apiovh:record/create
- * dnsZone:apiovh:record/delete
- * dnsZone:apiovh:refresh
- ## Important Note
- Both authentication methods cannot be used at the same time.
- '''
- [Configuration]
- [Configuration.Credentials]
- OVH_ENDPOINT = "Endpoint URL (ovh-eu or ovh-ca)"
- OVH_APPLICATION_KEY = "Application key (Application Key authentication)"
- OVH_APPLICATION_SECRET = "Application secret (Application Key authentication)"
- OVH_CONSUMER_KEY = "Consumer key (Application Key authentication)"
- OVH_CLIENT_ID = "Client ID (OAuth2)"
- OVH_CLIENT_SECRET = "Client secret (OAuth2)"
- [Configuration.Additional]
- OVH_POLLING_INTERVAL = "Time between DNS propagation check"
- OVH_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
- OVH_TTL = "The TTL of the TXT record used for the DNS challenge"
- OVH_HTTP_TIMEOUT = "API request timeout"
- [Links]
- API = "https://eu.api.ovh.com/"
- GoClient = "https://github.com/ovh/go-ovh"
|
