Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kutzilla committed Oct 7, 2021
1 parent 134242e commit a1fa07f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit a1fa07f

Please sign in to comment.