Go to file
2023-10-26 11:54:39 +02:00
source Merge branch 'master' of gs-gitlab:tools/inwx 2023-10-26 11:53:21 +02:00
tools [add] tools:build 2023-10-26 11:54:39 +02:00
.gitignore [mod] rewrite to python; no third party dependencies 2020-05-04 22:06:03 +02:00
makefile [mod] rewrite to python; no third party dependencies 2020-05-04 22:06:03 +02:00
readme.md Merge branch 'master' of gs-gitlab:tools/inwx 2023-10-26 11:53:21 +02:00

Description

A simple CLI client for the API of INWX

Usage

Credentials

For most API calls it is necessary to provide login information. There are two ways to do this:

Via command line arguments

  • --username for specifying the username of the account
  • --password for specifying the username of the account

Via configuration file

  • the location of a configuration file can be specified via --conf
  • the default location is ~/.inwx-conf.json
  • a minial configuration file for specifying the credentials would look as follows:
{
    "account": {
        "username": "___",
        "password": "___"
    }
}

Commands

info

  • synopsis: inwx info
  • description: for listing the records of a domain

list

  • synopsis: inwx list <domain>
  • description: for listing the records of a domain

save

  • synopsis: inwx save <domain> <name> <type> <content>
  • 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