Add a page to describe OVH configuration
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful

This commit is contained in:
nemunaire 2024-07-15 11:58:25 +02:00
parent 0ca65a23ab
commit 5df5a046a5
4 changed files with 66 additions and 2 deletions

View File

@ -154,7 +154,7 @@ Some registrars require third-party applications to identify themselves in addit
#### OVH #### OVH
Please refer to this documentation in order to generate application credentials: <https://docs.ovh.com/gb/en/api/api-rights-delegation/#application-registration>. Please refer to [this documentation]({{% relref "ovh" %}}) to generate the identifiers.
`ovh-application-key` `ovh-application-key`
: Application key for OVH API. : Application key for OVH API.

View File

@ -153,7 +153,7 @@ Certain bureau d'enregistrement nécessitent que les applications tierces s'iden
#### OVH #### OVH
Veuillez vous référer à cette documentation afin de générer les identifiants: <https://docs.ovh.com/gb/en/api/api-rights-delegation/#application-registration>. Veuillez vous référer à [cette documentation]({{% relref "ovh" %}}) afin de générer les identifiants.
`ovh-application-key` `ovh-application-key`
: Application key pour l'API d'OVH : Application key pour l'API d'OVH

32
content/deploy/ovh.en.md Normal file
View File

@ -0,0 +1,32 @@
---
data: 2024-07-15T11:33:09+02:00
title: OVH API configuration
weight: 50
---
In order to manage domains hosted by OVH, an additional configuration step is required.
Authentication to the OVH API works in 2 stages:
1. First, you need to register an ***application*** (e.g. *happyDomain*). An application has an identifier and a secret that must be entered as a happyDomain parameter.
2. For each OVH account you wish to manage, the happyDomain interface redirects you to the OVH page for creating the *Consumer key*.
The *application* must be created from an existing OVH account, regardless of whether it has domains or not; it is a matter of identifying the person responsible for implementing the designated application.
Access to account data, and in particular to the domains they manage, is via the *Consumer key*.
For more information, see this page: <https://docs.ovh.com/gb/en/api/api-rights-delegation/#application-registration>
## Register your happyDomain instance with OVH
1. Go to <https://api.ovh.com/createApp/>.
2. Fill in the form with a name and description that reflects the name and use of your application, e.g. *happyDomain*.
Once the form has been validated, you'll get a key and a secret.
This information must be specified in the happyDomain configuration:
`ovh-application-key`
: Application key pour l'API d'OVH
`ovh-application-secret`
: Clef secrète pour l'API d'OVH

32
content/deploy/ovh.fr.md Normal file
View File

@ -0,0 +1,32 @@
---
data: 2024-07-15T11:33:09+02:00
title: Configuration pour l'API OVH
weight: 50
---
Afin de pouvoir gérer des domaines hébergés par OVH, il est nécessaire de passer par une étape de configuration supplémentaire.
En effet, le principe de fonctionnement de l'authentification à l'API d'OVH se fait en 2 étapes :
1. Tout d'abord il faut enregistrer une ***application*** (par exemple *happyDomain*). Une application dispose d'un identifiant et d'un secret qu'il convient de renseigner en tant que paramètre d'happyDomain.
2. Pour chaque compte OVH que l'on souhaite gérer, l'interface d'happyDomain redirige vers la page d'OVH permettant de créer la *Consumer key*.
L'*application* doit être créée à partir d'un compte OVH existant, peu importe qu'il dispose de domaines ou non, il s'agit d'identifier la personne responsable de la mise en œuvre de l'application désignée.
L'accès aux données d'un compte, notamment aux domaines qu'ils gèrent, se fait au travers de la *Consumer key*.
Pour plus d'information, voir cette page : <https://docs.ovh.com/gb/en/api/api-rights-delegation/#application-registration>
## Enregistrer votre instance d'happyDomain auprès d'OVH
1. Rendez-vous sur la page <https://api.ovh.com/createApp/>.
2. Remplissez le formulaire avec un nom et une description qui refléte le nom et l'usage de votre application, par exemple *happyDomain*.
Une fois le formulaire validé, vous obtiendrez une clef et un secret.
Ces informations sont à indiqué dans la configuration d'happyDomain :
`ovh-application-key`
: Application key pour l'API d'OVH
`ovh-application-secret`
: Clef secrète pour l'API d'OVH