forked from TrueCloudLab/lego
ovh: Improve provider documentation (#1057)
This commit is contained in:
parent
aad2d9ad92
commit
8f349e5a5f
2 changed files with 59 additions and 4 deletions
|
@ -18,9 +18,15 @@ Configuration for [OVH](https://www.ovh.com/).
|
||||||
|
|
||||||
- Code: `ovh`
|
- Code: `ovh`
|
||||||
|
|
||||||
{{% notice note %}}
|
Here is an example bash command using the OVH provider:
|
||||||
_Please contribute by adding a CLI example._
|
|
||||||
{{% /notice %}}
|
```bash
|
||||||
|
OVH_APPLICATION_KEY=1234567898765432 \
|
||||||
|
OVH_APPLICATION_SECRET=b9841238feb177a84330febba8a832089 \
|
||||||
|
OVH_CONSUMER_KEY=256vfsd347245sdfg \
|
||||||
|
OVH_ENDPOINT=ovh-eu \
|
||||||
|
lego --dns autodns --domains my.domain.com --email my@email.com run
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -50,6 +56,26 @@ More information [here](/lego/dns/#configuration-and-credentials).
|
||||||
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
|
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
|
||||||
More information [here](/lego/dns/#configuration-and-credentials).
|
More information [here](/lego/dns/#configuration-and-credentials).
|
||||||
|
|
||||||
|
## 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 use to define access rights:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"accessRules": [
|
||||||
|
{
|
||||||
|
"method": "POST",
|
||||||
|
"path": "/domain/zone/*"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"method": "DELETE",
|
||||||
|
"path": "/domain/zone/*"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,36 @@ URL = "https://www.ovh.com/"
|
||||||
Code = "ovh"
|
Code = "ovh"
|
||||||
Since = "v0.4.0"
|
Since = "v0.4.0"
|
||||||
|
|
||||||
Example = ''''''
|
Example = '''
|
||||||
|
OVH_APPLICATION_KEY=1234567898765432 \
|
||||||
|
OVH_APPLICATION_SECRET=b9841238feb177a84330febba8a832089 \
|
||||||
|
OVH_CONSUMER_KEY=256vfsd347245sdfg \
|
||||||
|
OVH_ENDPOINT=ovh-eu \
|
||||||
|
lego --dns autodns --domains my.domain.com --email my@email.com 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 use to define access rights:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"accessRules": [
|
||||||
|
{
|
||||||
|
"method": "POST",
|
||||||
|
"path": "/domain/zone/*"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"method": "DELETE",
|
||||||
|
"path": "/domain/zone/*"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
'''
|
||||||
|
|
||||||
[Configuration]
|
[Configuration]
|
||||||
[Configuration.Credentials]
|
[Configuration.Credentials]
|
||||||
|
|
Loading…
Reference in a new issue