mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
Add documentation draft to configure DNS registrar API token + specific documentation for OVH and Gandi
This commit is contained in:
parent
eab5467c03
commit
4981ce8602
6 changed files with 69 additions and 0 deletions
BIN
images/registrar_api_gandi_1.png
Normal file
BIN
images/registrar_api_gandi_1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 85 KiB |
BIN
images/registrar_api_gandi_2.png
Normal file
BIN
images/registrar_api_gandi_2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 72 KiB |
BIN
images/registrar_api_ovh_1.png
Normal file
BIN
images/registrar_api_ovh_1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 96 KiB |
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
title: Obtaining an API key from Gandi
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs
|
||||
routes:
|
||||
default: '/registar_api_gandi'
|
||||
---
|
||||
|
||||
This page is meant to guide you in obtaining an API key from Gandi in order to configure Yunohost's automatic DNS configuration mecanism
|
||||
|
||||
! NB. : **DO NOT share your API tokens with anybody!** A malicious attacker obtaining your tokens could take over your domain, and possibly your server !
|
||||
|
||||
1. Go to https://account.gandi.net/
|
||||
|
||||
2. You should land on this page. Then click on 'Security'
|
||||
|
||||
![](image://registrar_api_gandi_1.png?resize=800)
|
||||
|
||||
3. In the next page, click on '(re)Generate the API key'.
|
||||
|
||||
![](image://registrar_api_gandi_2.png?resize=800)
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
title: Obtaining an API key from OVH
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs
|
||||
routes:
|
||||
default: '/registar_api_ovh'
|
||||
---
|
||||
|
||||
This page is meant to guide you in obtaining an API key from OVH in order to configure Yunohost's automatic DNS configuration mecanism
|
||||
|
||||
! NB. : **DO NOT share your API tokens with anybody!** A malicious attacker obtaining your tokens could take over your domain, and possibly your server !
|
||||
|
||||
1. Go to https://eu.api.ovh.com/createToken/
|
||||
|
||||
2. Fill the form with the required informations as shown below:
|
||||
|
||||
- Account ID or email address : This is your usual OVH login
|
||||
- Password : This is your usual OVH password
|
||||
- Script Name: for example `Yunohost Auto DNS`
|
||||
- Script description: for example `Yunohost Auto DNS`
|
||||
- Validity : `Unlimited`
|
||||
- Rights : use the `+` button to add the following lines
|
||||
- `GET` : `/domain/zone/*`
|
||||
- `POST` : `/domain/zone/*`
|
||||
- `PUT` : `/domain/zone/*`
|
||||
- `DELETE` : `/domain/zone/*`
|
||||
|
||||
![](image://registrar_api_ovh_1.png?resize=800)
|
||||
|
||||
3. You will obtain three tokens (an application key, a secret application key, and a consumer key) which should be used in Yunohost's configuration
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: Auto DNS synchronization
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs
|
||||
routes:
|
||||
default: '/autodns'
|
||||
---
|
||||
|
||||
Since version 4.3, YunoHost includes a mecanism to interface your server with your DNS registrar API, with the purpos of simplifying and automatizing DNS records registration and maintenance.
|
||||
|
||||
The procedure does require an initial configuration where you will need to generate an API key on your registrar's interface.
|
||||
|
||||
Not all registrars are supported though. So far, the community tested and validated the interface with [Gandi](https://gandi.net) and [OVH](https://ovh.com), which are recommended. The interface with other registrar may work but is still considered experimental until we gather feedback from the community.
|
||||
|
||||
TODO/FIXME : add proper screenshots of config panel procedure, etc.
|
Loading…
Reference in a new issue