[tor-commits] [bridgedb/master] Rename email check script and add information on how to run it

[phw at torproject.org]

commit ae07c0950be2ededc2c81b80137a63d85e68130d
Author: hiro <hiro at torproject.org>
Date:   Wed Jan 22 17:44:36 2020 +0100

    Rename email check script and add information on how to run it
---
 scripts/{check_status => nagios_email_check} | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/scripts/check_status b/scripts/nagios_email_check
similarity index 91%
rename from scripts/check_status
rename to scripts/nagios_email_check
index 1784e6b..767d055 100644
--- a/scripts/check_status
+++ b/scripts/nagios_email_check
@@ -3,10 +3,23 @@
 #
 # This file is part of  BridgeDB, a Tor bridge distribution system.
 #
+# This scripts send an email to bridgedb requesting a bridge and check if the
+# service reply with a valid bridge. A status file is written in path specified
+# by STATUS_FILE.
+#
+# The STATUS_FILE is read by nagios that will send an alert whenever bridgedb
+# will not send a valid email response.
+#
+# Run via crontab
+# Ex: */10 * * * * <path_to_bridgedb>/scripts/nagios_email_check $(cat <path_to_email_key/gmail.key)
+#
 # :authors: hiro <hiro at torproject.org>
 #           see also AUTHORS file
 #
 # :license: This is Free Software. See LICENSE for license information.
+#
+#
+
 
 import sys
 import smtplib