certbot_plugin_gandi/readme.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2018-03-15 18:44:18 +01:00
# Certbot plugin for authentication using Gandi LiveDNS
2018-03-15 18:53:04 +01:00
This is a plugin for [Certbot](https://certbot.eff.org/) that uses the Gandi
LiveDNS API to allow [Gandi](https://www.gandi.net/)
2018-03-15 18:44:18 +01:00
customers to prove control of a domain name.
2018-03-15 18:53:04 +01:00
1. Obtain a Gandi API token (see [Gandi LiveDNS API](https://doc.livedns.gandi.net/))
2019-02-24 20:43:17 +01:00
2018-03-15 18:44:18 +01:00
2. Install the plugin:
2019-02-24 20:43:17 +01:00
```shell
pip install 'git+https://derdritte.net/gitea/markus/certbot_plugin_gandi.git'
2018-03-15 18:44:18 +01:00
```
2018-03-15 18:53:04 +01:00
2018-03-15 18:44:18 +01:00
3. Create a `gandi.ini` config file with the following contents:
2019-02-24 20:43:17 +01:00
```ini
2018-03-15 18:44:18 +01:00
certbot_plugin_gandi:dns_api_key=APIKEY
```
2019-02-24 20:43:17 +01:00
2018-03-15 18:44:18 +01:00
Replace `APIKEY` with your Gandi API key and ensure permissions are set
to disallow access to other users.
2018-03-15 18:53:04 +01:00
2018-03-15 18:44:18 +01:00
4. Run `certbot` and direct it to use the plugin for authentication and to use
the config file created in (3):
2019-02-24 20:43:17 +01:00
```shell
2018-03-15 18:53:04 +01:00
certbot certonly -a certbot-plugin-gandi:dns --certbot-plugin-gandi:dns-credentials gandi.ini -d domain.com
2018-03-15 18:44:18 +01:00
```
2019-02-24 20:43:17 +01:00
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.