ionos-dynamic-dns/README.md

1.3 KiB

Ionos DNS updates

A set of scripts used to make dynamic DNS updates to the Ionos API.

Dependencies

Python libraries:

Configuration

Configuration is declared inside the file config.yml. Once modified, this file must be kept secret, else anyone visiting your domains runs the risk of being DNS-poisoned.

First, you will need to set your Ionos API keypair in the config file. Paste the respective values of your Ionos API-keypair into the file

apikey:
  prefix: <your api key prefix>
  secret: <your api key secret>

Next, add every domain you wish to send an update for to the domains list. The script will set a global DNS record for each listed domain and have it point to the local host's public IP address. The domains list should have the following format:

domains:
  - example.com
  - subdomain1.example.com
  - subdomain2.example.com

You may optionally set a descriptive string which is sent along with the update:

description: "Dynamic DNS update."

As of right now, I am actually not sure what the description is needed for, but the API requires it. The value displayed above is used by default, if you don't override it inside config.yml.