From aabb4ac644a20754cfb77417af1330f3ebab1700 Mon Sep 17 00:00:00 2001 From: Julian Lobbes Date: Sat, 3 Sep 2022 02:33:45 +0200 Subject: [PATCH] docs: update README - domains are registered with Ionos automatically when present in `config.yml` --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8906368..48848be 100644 --- a/README.md +++ b/README.md @@ -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."