[mod] readme
This commit is contained in:
parent
c05dfa3974
commit
469cc10773
24
readme.md
24
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 <domain>`
|
||||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue