From e065671adb119a9cd23f94d746fb1e35f80429e3 Mon Sep 17 00:00:00 2001 From: Ghislain Bourgeois Date: Tue, 2 May 2023 15:36:05 +0200 Subject: [PATCH] Document the required custom API --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 6d0775f..c593bb9 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,11 @@ using the HTTP Request plugin for DNS-01 challenge. This charm is a provider of the [`tls-certificates-interface`](https://github.com/canonical/tls-certificates-interface), charms that require Let's Encrypt certificates need to implement the requirer side. +This operator targets a custom implementation of an API defined in +[`go-acme lego documentation`](https://go-acme.github.io/lego/dns/httpreq/). +This custom API needs be implemented for you particular use case and its URL +provided to as a configuration to this operator. + ## Usage Create a YAML configuration file with the following fields: