v4.00 README.md

README.md

@@ -1,93 +1,31 @@
 # wicens.sh
     WICENS - WAN IP Change Email Notification Script.
 
-This script when configured will send an Email (1-4) at variable intervals
-X(second/minute/hour/day) to your Email(s) notifying you when your WAN IP
-has changed.
+This script when configured will send an Email 
+to your Email(s) notifying you when your WAN IP
+has changed.  Optional Firmware update and reboot
+Email notifications.
 
 Supports GMail, Hotmail, Outlook, ISP based Email
 
-Supports AMTM Email config import
+Supports amtm Email config import
 
 SMTP Email send formats available:
 * sendmail - StartTLS v1.1 higher (eg. GMail port 587)
 * sendmail - StartTLS v1 only
-* curl     - SSL (eg GMail port 465)
+* curl     - SSL (eg GMail port 465/amtm)
 * sendmail - SMTP plain auth (no encryption)
 * sendmail - ISP based (no password reqd, generally port 25)
 
-IMPORTANT - If using GMail, you must use 2 factor authentication and setup
-an assigned App password in GMail for this script to use.
-
-IMPORTANT - Your Email address(es) are stored as plain text within this
-script.  Your Email password is encrypted and saved to router storage.
-If you dont practice good security habits around your router ssh access,
-this script might not be for you.
-
-Script compares IP in NVRAM to saved IP with wancall connected events and
-cron, cron is also a watchdog and monitors for failed Email attempts.
-Should NVRAM IP be unavailable for whatever reason script will use
-firmware built in getrealip.sh to retrieve your WAN IP using Google STUN
-server.
-
-Script will display a notification if an update is available.
-
-All cron/wan-event entries are automatically created with this script
-
-NTP sync must occur to update router date/time for proper script function
-
-### Technical ###
-
-Supports being used as an Email forwarder for other scripts, in your
-script call /jffs/scripts/wicens.sh send {your email.txt path here}
-ie. /jffs/scripts/wicens.sh send /tmp/email.txt
-Your email.txt should contain a Subject: Date: From: fields as headers
-
-In your script when generating email.txt use
-* echo "Subject: My Email notification" >> /tmp/email.txt
-* echo "Date: $(/bin/date -R)" >> /tmp/email.txt
-* echo "From: Myscript" >> /tmp/email.txt
-* echo "" >> / tmp/email.txt
-* echo "Your Email text body here" >> /tmp/email.txt
-
-Ensure there is 1 line space between header info and text body.
-
-Should Email sending fail with either WAN IP change or forwarder the
-script will retry 4 more times with cron (1/10min) in 6 hour intervals.
-If FW update or script update Emails fail 5 times it will give up trying.
-Script generates a lock file in /tmp called wicens.lock to prevent
-duplicate runs as well as another file in /tmp called wicenssendmail.lock
-when sending Email notifications. Script will automatically remove (with
-cron) stale lock files if original starting process no longer exists or
-lock files are over age limit.
-
-Sendmail/Curl output for Emails is saved to /tmp/wicenssendmail.log for
-debugging if needed.  This file can be viewed by running this script and
-select option L|l
-
-Sendmail doesnt always return an error code on a misconfiguration so false
-send success can occur.  If script says Email has sent but no Email received
-use option L|l from the Main Menu to read sendmail output for errors
-
-The script does not update its saved WAN IP until the script has completed
-sending all notifications and adds to the Email message of success or
-failure in updating it, so in the event of message failure it should run
-again with next cron run and attempt to send again.
-
-Using option 4 you can call your own script either immediately upon WAN IP
-change detection, or wait until all Email messages have been sent and
-script has successfully updated. Script will be put in background as to not
-block this script
-
-Every Sunday the script will log the number of calls from wan-event.
+See 'about' section within wicens.sh for more details
 
 To download, copy/paste in an ssh terminal
 
 `curl --retry 3 "https://raw.githubusercontent.com/maverickcdn/wicens/master/wicens.sh" -o "/jffs/scripts/wicens.sh" && chmod a+rx "/jffs/scripts/wicens.sh"`
 
 Run with 'sh /jffs/scripts/wicens.sh'
 
-After first run, you should be able to run by simply typing wicens
+After first run and new terminal session you should be able to run by simply typing wicens
 
 Thank you for using this script.