From e949e527f632927f806d3c0340bc5319d681106a Mon Sep 17 00:00:00 2001
From: Christian Hesse <mail@eworm.de>
Date: Fri, 27 Mar 2020 21:44:36 +0100
Subject: add doc/daily-psk.md

---
 daily-psk.capsman  |  1 +
 daily-psk.local    |  1 +
 daily-psk.template |  1 +
 doc/daily-psk.md   | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 59 insertions(+)
 create mode 100644 doc/daily-psk.md

diff --git a/daily-psk.capsman b/daily-psk.capsman
index 59b867e..623ef0c 100644
--- a/daily-psk.capsman
+++ b/daily-psk.capsman
@@ -4,6 +4,7 @@
 #                         Michael Gisbers <michael@gisbers.de>
 #
 # update daily PSK (pre shared key)
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/daily-psk.md
 #
 # !! Do not edit this file, it is generated from template!
 
diff --git a/daily-psk.local b/daily-psk.local
index 3915618..6245ebe 100644
--- a/daily-psk.local
+++ b/daily-psk.local
@@ -4,6 +4,7 @@
 #                         Michael Gisbers <michael@gisbers.de>
 #
 # update daily PSK (pre shared key)
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/daily-psk.md
 #
 # !! Do not edit this file, it is generated from template!
 
diff --git a/daily-psk.template b/daily-psk.template
index cab65f2..3181b1a 100644
--- a/daily-psk.template
+++ b/daily-psk.template
@@ -4,6 +4,7 @@
 #                         Michael Gisbers <michael@gisbers.de>
 #
 # update daily PSK (pre shared key)
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/daily-psk.md
 #
 # !! This is just a template! Replace '%PATH%' with 'caps-man'
 # !! or 'interface wireless'!
diff --git a/doc/daily-psk.md b/doc/daily-psk.md
new file mode 100644
index 0000000..e6d7aae
--- /dev/null
+++ b/doc/daily-psk.md
@@ -0,0 +1,56 @@
+Use wireless network with daily psk
+===================================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+This script is supposed to provide a wifi network which changes the
+passphrase to a pseudo-random string daily.
+
+Requirements and installation
+-----------------------------
+
+Just install this script and [global-wait](global-wait.md).
+
+Depending on whether you use CAPsMAN (`/ caps-man`) or local wireless
+interface (`/ interface wireless`) you need to install a different script.
+
+For CAPsMAN:
+
+    $ScriptInstallUpdate daily-psk.capsman,global-wait;
+
+For local interface:
+
+    $ScriptInstallUpdate daily-psk.local,global-wait;
+
+And add schedulers to run the script:
+
+    / system scheduler add interval=1d name=daily-psk-nightly on-event="/ system script run daily-psk.local;" start-date=may/23/2018 start-time=03:00:00;
+    / system scheduler add name=daily-psk-startup on-event=":global WaitTimeSync; / system script { run global-wait; \$WaitTimeSync; run daily-psk.local; }" start-time=startup;
+
+These will update the passphrase on boot and nightly at 3:00.
+
+Configuration
+-------------
+
+The configuration goes to `global-config-overlay`, these are the parameters:
+
+* `DailyPskMatchComment`: pattern to match the wireless access list comment
+* `DailyPskSecrets`: an array with pseudo random strings
+
+Then add an access list entry:
+
+    / interface wireless access-list add comment="Daily PSK" interface=wl-daily private-pre-shared-key="ToBeChangedDaily";
+
+Also notification settings are required for e-mail and telegram.
+
+See also
+--------
+
+* [Wait for configuration und functions](global-wait.md)
+
+---
+[◀ Go back to main README](../README.md)  
+[▲ Go back to top](#top)
-- 
cgit v1.2.3-70-g09d2