From 026672dd9adeb1223cbeab20aaa19b0b952f4789 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexander=20K=C3=A4b?= <alexander.kaeb@h-da.de>
Date: Mon, 4 Mar 2024 13:52:38 +0100
Subject: [PATCH] other: add better example in readme
---
README.md | 23 +++++++++++++++++++++--
1 file changed, 21 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 7aa8b73..20c5614 100644
--- a/README.md
+++ b/README.md
@@ -49,10 +49,29 @@ roles:
version: main
```
+#### Example using DNS challenge with designate provider
```yaml
- hosts: all
- roles:
- - hdacloud.certbot
+ tasks:
+ - name: Obtain certificate
+ ansible.builtin.import_role:
+ name: hdacloud.certs
+ vars:
+ cert_fqdns:
+ - "{{ my_fqdn }}"
+ admin_email: "admin@example.org"
+ dns_challenge: true
+ lego_version: "4.11.0"
+ lego_dns_provider: "designate"
+ dns_provider_auth_env_variables:
+ OS_AUTH_URL: "https://h-da.cloud:13000"
+ OS_REGION_NAME: "eu-central"
+ OS_AUTH_TYP: "v3applicationcredential"
+ OS_APPLICATION_CREDENTIAL_ID: "{{ os_application_credential_id }}"
+ OS_APPLICATION_CREDENTIAL_SECRET: "{{ os_application_credential_secret }}"
+ renewal_hook: |
+ #!/usr/bin/env bash
+ systemctl restart httpd
```
### Info when using DNS challenge
--
GitLab