ulinja/ionos-dynamic-dns
ulinja/ionos-dynamic-dns
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update README

Browse source 
- domains are registered with Ionos automatically when present in `config.yml`
This commit is contained in:
Julian Lobbes 2022-09-03 02:33:45 +02:00
parent 9f8df6e227
commit aabb4ac644
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -3,6 +3,10 @@
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 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 registered subdomains and point to whatever public IP you had when you last sent an update request for that subdomain.
You must log in to your Ionos account and remove them manually.
### Dependencies
Python 3.6 or above.
@ -37,10 +41,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."