From cf2b34f79a7428f76d65af96c217f9eb38e4e331 Mon Sep 17 00:00:00 2001 From: redxef Date: Fri, 24 Jun 2022 16:30:17 +0200 Subject: [PATCH] Add readme.md. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee6769a --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Certbot for OVH + +Run it and never care about your certificates again. + +To run it provide the following environment variables: + +- `CERTBOT_OVH_LE_EMAIL`: Your email address +- `CERTBOT_OVH_AGREE_TOS`: You need to agree to the terms of service, "yes" values: `1`, `y`, `t` +- `CERTBOT_OVH_DOMAINS`: Comma separated list of domain names for the certificate, example: `yourdomain.tld,*.yourdomain.tld` + +Additionally the OVH API secrets must be configured. To do +so mount a file `/etc/certbot-ovh.ini` into the docker container. +See [certbot-ovh.ini.tmpl](certbot-ovh.ini.tmpl) for example contents. + +## Example + +A simple example can be found at [example](example/). + +## SOURCE + +[gitea.redxef.at/redxef/certbot-ovh](https://gitea.redxef.at/redxef/certbot-ovh)