From 30e77c9722c43304d2423f95a2e07c8d85906ab8 Mon Sep 17 00:00:00 2001 From: Eduard Veit Date: Thu, 22 Apr 2021 22:07:12 +0200 Subject: [PATCH] :memo: document loop mode and dig as requirement --- CHANGELOG.md | 2 ++ README.md | 12 ++++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2eaed41..f903f9a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,6 +35,8 @@ ### Documentation +* :memo: document loop mode and dig as requirement. [Eduard Veit] + * :memo: update example of .env in README.md. [Eduard Veit] * :memo: add CHANGELOG.md. [Eduard Veit] diff --git a/README.md b/README.md index 8563bf2..0a3ef9e 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,8 @@ The following update methods are currently implemented: ## 📦 Requirements -* `curl` - The minimum requirement for running DynDNS2 operations +* `curl` - The minimum requirement for all API requests. +* `dig` - You can get it by installing `dnsutils` (debian/ubuntu/ArchLinux), `bind-utils` (CentOS/RHEL), `bind-tools` (Alpine) also essential if you are using other APIs: @@ -96,7 +97,14 @@ dynb --ip-mode dualstack --update-method dyndns --provider inwx --domain dyndns. ``` ## ⏰ Cron -To automatically call the script you can use cron. + +To automatically call the script you can use either crontab or the script can also run in a loop mode. + +### loop mode + +Just use the parameter `--interval 60` or the environment variable `DYNB_INTERVAL=60` so the script will check every 60 seconds if it needs to do an update. + +### crontab execute :point_down: ```