From 469cc107731c24f566855b8ee413cea1a61fc57b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Fra=C3=9F?= Date: Mon, 29 May 2023 12:17:06 +0200 Subject: [PATCH] [mod] readme --- readme.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index c20578f..2e8bdbb 100644 --- a/readme.md +++ b/readme.md @@ -22,16 +22,22 @@ For most API calls it is necessary to provide login information. There are two w - the default location is `~/.inwx-conf.json` - a minial configuration file for specifying the credentials would look as follows: - { - "account": { - "username": "___", - "password": "___" - } - } + { + "account": { + "username": "___", + "password": "___" + } + } ## Commands +### `list` + +- synopsis: `inwx info` +- description: for listing the records of a domain + + ### `list` - synopsis: `inwx list ` @@ -44,3 +50,9 @@ For most API calls it is necessary to provide login information. There are two w - description: for creating or updating a records of a domain - example: `inwx save example.org dat TXT 'foo bar'` + +### `certbot-hook` + +- synopsis: `inwx certbot-hook` +- description: for executing the DNS certbot challenge; will read the environment variables `CERTBOT_DOMAIN` and `CERTBOT_VALIDATION` to store a `TXT` record +