Add README

This commit is contained in:
Michael Porter 2018-03-15 17:44:18 +00:00
parent cf1d0b5433
commit c561277d5a

26
readme.md Normal file
View File

@ -0,0 +1,26 @@
# Certbot plugin for authentication using Gandi LiveDNS
This is a plugin for Certbot https://certbot.eff.org/ that uses the Gandi
LiveDNS API to allow Gandi https://www.gandi.net/
customers to prove control of a domain name.
1. Obtain a Gandi API token (see https://doc.livedns.gandi.net/)
2. Install the plugin:
```
pip install 'git+https://gitlab.com/cspublic/certbot-plugin-gandi.git'
```
3. Create a `gandi.ini` config file with the following contents:
```
certbot_plugin_gandi:dns_api_key=APIKEY
```
Replace `APIKEY` with your Gandi API key and ensure permissions are set
to disallow access to other users.
4. Run `certbot` and direct it to use the plugin for authentication and to use
the config file created in (3):
```
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.