diff --git a/README.md b/README.md index be573fe..22814ed 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Dynamic DNS Updates with Cloudflare -![cloudflare-dynamic-dns](https://github.com/mxmlndml/cloudflare-dynamic-dns/assets/42516330/d1faa020-e730-4f53-9706-4fe9e9a7bd41) +![cloudflare-dynamic-dns](https://github.com/mxmlndml/cloudflare-dynamic-dns/assets/42516330/fc6e7c3e-eb96-4fdf-924e-cf86dab70b4b) This Docker container offers a straightforward and efficient solution for automating dynamic DNS updates using the Cloudflare DNS service. It empowers you @@ -24,11 +24,11 @@ pulling the pre-built Docker container and running it with the necessary environment variables ```sh -docker run -d -e API_KEY=123 -e ZONE_ID=023e105f4ecef8ad9ca31a8372d0c353 -e DOMAIN_NAMES=dyndns.example.com,example.com --restart=always mxmlndml/cloudflare-dynamic-dns +docker run -d -e API_KEY=123 -e ZONE_ID=023e105f4ecef8ad9ca31a8372d0c353 -e DOMAIN_NAMES=example.com,*.example.com mxmlndml/cloudflare-dynamic-dns ``` -Alternatively you can copy the `docker-compose.yml` from this repository into an -empty directory of your machine, edit the environment variables and start the +Alternatively you can copy the `docker-compose.yml` and `.env.template` from this repository into an +empty directory of your machine, rename the `.env.template` to `.env`, edit the environment variables in both files and start the container with `docker compose` ```sh @@ -52,9 +52,15 @@ breakdown of the available configuration variables: \ List of DNS A records that should store your public IP address delimited by a comma (and only a comma) +- **`RECORD_TYPES`** _defaults to `A`_ + \ + Whether A and/or AAAA records should be updated + \ + `A`: updates only A records + \ + `AAAA`: updates only AAAA records + \ + `*`: updates both A and AAAA records - **`INTERVAL`** _defaults to `5`_ \ Time interval in minutes between DNS updates -- **`LOG_LEVEL`** _defaults to `INFO`_ - \ - Logging level for the container, either `DEBUG`, `INFO`, `WARN` or `ERROR`