From a1fa07f3a8f97bbd7defe56f01e6bfe15f4d33f2 Mon Sep 17 00:00:00 2001 From: Matthias Kutz Date: Thu, 7 Oct 2021 18:05:53 +0200 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ce8af4..11b83aa 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,11 @@ This Docker image will allow you to use the [Hetzner DNS Service](https://www.hetzner.com/dns-console) as a Dynamic DNS Provider ([DDNS](https://en.wikipedia.org/wiki/Dynamic_DNS)). +## How does it work? + +The Go script inside this Docker Image periodically checks the DNS record with the Hetzner DNS API. It also checks the current public IP of the network, the container is running on. If the DNS record does not match the current public IP, it will update the record. Therefore your DNS records updates dynamically to the public IP. + + ## Usage @@ -33,7 +38,6 @@ docker run kutzilla/hetzner-ddns example.com my-secret-api-token A * `--restart=always` - ensure the container restarts automatically after host reboot. - ## Build Build the latest version of the Docker image with the following command: