Compare commits

...

2 commits
v1.0 ... master

Author SHA1 Message Date
58a97140df docs: fix typo 2022-09-03 02:37:37 +02:00
aabb4ac644 docs: update README
- domains are registered with Ionos automatically when present in `config.yml`
2022-09-03 02:35:11 +02:00

View file

@ -3,6 +3,12 @@
A simple script used to send dynamic DNS updates to the Ionos API.
Using this script requires you to have your domain registered with Ionos, and having obtained an [API key from them](https://developer.hosting.ionos.com/docs/getstarted).
Any subdomains you add to `config.yml` are added automatically to your Ionos account and pointed at your public IP (provided that your API Key is valid and you own the respective parent domain).
**NOTE:** Removing the domains from `config.yml` does not remove their global DNS record.
They will still be publically registered subdomains and point to whatever public IP you had when you last ran the script with the respective domain listed inside `config.yml`.
You must log in to your Ionos account and remove them manually to de-register the domain.
### Dependencies
Python 3.6 or above.
@ -37,10 +43,6 @@ domains:
- subdomain2.example.com
```
**NOTE:** Make sure you have manually added each subdomain you are listing in your Ionos account.
The script currently does not handle adding subdomains for you.
Attempting to update the DNS entry for an unregistered domain will cause the API call to fail.
You may optionally set a descriptive string which is sent along with the update:
```yaml
description: "Dynamic DNS update."