diff --git a/README.md b/README.md index af22f1be73890339c9aae93d1e04ad33cfbdc8df..e6751ebe679d15ecf12edf4670d49fbb3d56d9fa 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,62 @@ # quovadis -REST API to assist with ACME challenges \ No newline at end of file +REST API to assist with ACME challenges + +## API + +### Documentation + +GET / + +### Register User + +POST /register + +Params: +* UCC username + +Will email to your UCC email address an API key to use with the service + +### Update API key + +POST /update-api-key + +Params: +* UCC username +* Old API key +* New API key + +Will update API key + +Will email to your UCC email address noting that the API key has been updated + +### Update Challenge + +POST /update-challenge + +Params: + +* UCC username +* API key +* Challenge Handle +* Challenge TXT + +Will update the DNS TXT record at + +<ucc username>-<challenge handle>.quovadis.ucc.asn.au + +to the contents of Challenge TXT + + +## Use + +This is intended to be used with the certbot hook scripts included alongside this code + +register-apikey.sh + +certbot-hook-quovadis.sh + + +## Author + +Mark Tearle <mtearle@ucc.asn.au> diff --git a/scripts/certbot-hook-quovadis.sh b/scripts/certbot-hook-quovadis.sh new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/scripts/register-apikey.sh b/scripts/register-apikey.sh new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391