Updated readme

This commit is contained in:
Markus Pawlata 2019-02-24 20:43:17 +01:00
parent 476530bd4f
commit 102263d9c3

View File

@ -5,25 +5,28 @@ LiveDNS API to allow [Gandi](https://www.gandi.net/)
customers to prove control of a domain name. customers to prove control of a domain name.
1. Obtain a Gandi API token (see [Gandi LiveDNS API](https://doc.livedns.gandi.net/)) 1. Obtain a Gandi API token (see [Gandi LiveDNS API](https://doc.livedns.gandi.net/))
2. Install the plugin: 2. Install the plugin:
```
pip install 'git+https://gitlab.com/cspublic/certbot-plugin-gandi.git' ```shell
pip install 'git+https://derdritte.net/gitea/markus/certbot_plugin_gandi.git'
``` ```
3. Create a `gandi.ini` config file with the following contents: 3. Create a `gandi.ini` config file with the following contents:
```
```ini
certbot_plugin_gandi:dns_api_key=APIKEY certbot_plugin_gandi:dns_api_key=APIKEY
``` ```
Replace `APIKEY` with your Gandi API key and ensure permissions are set Replace `APIKEY` with your Gandi API key and ensure permissions are set
to disallow access to other users. to disallow access to other users.
4. Run `certbot` and direct it to use the plugin for authentication and to use 4. Run `certbot` and direct it to use the plugin for authentication and to use
the config file created in (3): the config file created in (3):
```
```shell
certbot certonly -a certbot-plugin-gandi:dns --certbot-plugin-gandi:dns-credentials gandi.ini -d domain.com certbot certonly -a certbot-plugin-gandi:dns --certbot-plugin-gandi:dns-credentials gandi.ini -d domain.com
``` ```
Add additional options as required to specify an installation plugin etc.
Add additional options as required to specify an installation plugin etc.
It is especially recommended you use the `--certname` flag to specify a name for your new certificate.