From 80486565426cfa226d4707f4d224e31ce3e6e5a3 Mon Sep 17 00:00:00 2001
From: "github@kiekerjan.isdronken.nl" <github@kiekerjan.isdronken.nl>
Date: Sat, 5 Jun 2021 21:05:49 +0200
Subject: [PATCH] Document dyndns tool and add example cron job

---
 README.md               |  1 +
 tools/dyndns/cronjob.sh |  2 ++
 tools/dyndns/readme.txt | 18 ++++++++++++++++++
 3 files changed, 21 insertions(+)
 create mode 100644 tools/dyndns/cronjob.sh
 create mode 100644 tools/dyndns/readme.txt

diff --git a/README.md b/README.md
index cd4ad5f7..eb4c9554 100644
--- a/README.md
+++ b/README.md
@@ -41,6 +41,7 @@ Maintenance (personal)
 
 Fun
 * Add option to define ADMIN_IP_ADDRESS (currently only used to ignore fail2ban jails)
+* Add dynamic dns tools in the tools directory.
 
 Original mailinabox content starts here:
 
diff --git a/tools/dyndns/cronjob.sh b/tools/dyndns/cronjob.sh
new file mode 100644
index 00000000..5dcd6016
--- /dev/null
+++ b/tools/dyndns/cronjob.sh
@@ -0,0 +1,2 @@
+#!/bin/sh
+cd /opt/dyndns && ./dyndns.sh >> /var/log/dyndns.log 2>/dev/null
diff --git a/tools/dyndns/readme.txt b/tools/dyndns/readme.txt
new file mode 100644
index 00000000..47696f1b
--- /dev/null
+++ b/tools/dyndns/readme.txt
@@ -0,0 +1,18 @@
+Files:
+- dyndns.sh
+  Dynamic DNS main script. There should be no need to edit it.
+- dyndns.domain
+  Fill with the top level domain of your MIAB box.
+- dyndns.dynlist
+  Fill with subdomains for which the dynamic dns IP should be updated. One per line.
+- dyndns.totp
+  Fill with TOTP key. Can be found in the MIAB sqlite database
+- dyndns.cfg
+  Fill with admin user and password
+- cronjob.sh
+  cronjob file. Edit where needed
+
+How to use:
+ - Put dyndns.sh, dyndns.domain, dyndns.dynlist, dyndns.totp and dyndns.cfg in a folder on your target system. E.g. /opt/dyndns
+ - Put the cronjob.sh in a cron folder. E.g. /etc/cron.daily
+ - Edit the files appropriately
\ No newline at end of file