[tor-commits] [gettor/master] Document scripts and service files

[hiro at torproject.org]

commit fb3155de156e178da005c1da3ac7a9867e69a086
Author: hiro <hiro at torproject.org>
Date:   Thu Oct 31 16:06:57 2019 +0100

    Document scripts and service files
---
 bin/gettor_check        | 7 +++++++
 scripts/add_links_to_db | 3 +++
 scripts/create_db       | 8 ++++++++
 scripts/export_stats    | 3 +++
 scripts/gettor          | 4 ++++
 scripts/process_email   | 4 ++++
 scripts/update_files    | 3 +++
 7 files changed, 32 insertions(+)

diff --git a/bin/gettor_check b/bin/gettor_check
index bf8775e..813a436 100755
--- a/bin/gettor_check
+++ b/bin/gettor_check
@@ -9,6 +9,13 @@
 #
 # :license: This is Free Software. See LICENSE for license information.
 
+################################################################################
+#                                                                              #
+# This file is used to check if GetTor is working and sending links.           #
+# It sends an email to gmail and writes to a status file.                      #
+#                                                                              #
+################################################################################
+
 python3 /home/gettor/gettor/scripts/check_service $1
 
 #store exit status
diff --git a/scripts/add_links_to_db b/scripts/add_links_to_db
index a2b67f6..70cad19 100755
--- a/scripts/add_links_to_db
+++ b/scripts/add_links_to_db
@@ -7,6 +7,9 @@
 #           see also AUTHORS file
 #
 # :license: This is Free Software. See LICENSE for license information.
+#
+# Add links to Tor Browser bundles to GetTor.
+#
 
 import os
 import sys
diff --git a/scripts/create_db b/scripts/create_db
index ed4ee34..361e7fd 100755
--- a/scripts/create_db
+++ b/scripts/create_db
@@ -7,6 +7,14 @@
 #           see also AUTHORS file
 #
 # :license: This is Free Software. See LICENSE for license information.
+#
+# Creates gettor.db sqlite database.
+# run as: $ python3 scripts/create_db -n -c -o -f gettor.db
+# -n --new: create new database file
+# -c --clear: clear database
+# -o --overwrite: overwrite existing Database
+#
+
 
 import os
 import sys
diff --git a/scripts/export_stats b/scripts/export_stats
index 6a195ec..86fe673 100755
--- a/scripts/export_stats
+++ b/scripts/export_stats
@@ -8,6 +8,9 @@
 # :copyright:   (c) 2008-2019, The Tor Project, Inc.
 #
 # :license: This is Free Software. See LICENSE for license information.
+#
+# Exports db dump into csv
+#
 
 cd ~/gettor
 mkdir -p csv
diff --git a/scripts/gettor b/scripts/gettor
index 4b12161..49c89e6 100644
--- a/scripts/gettor
+++ b/scripts/gettor
@@ -9,6 +9,10 @@ the Tor Browser.
 :copyright: (c) 2008-2014, The Tor Project, Inc.
             (c) 2014, all entities within the AUTHORS file
 :license: see included LICENSE for information
+
+This file starts GetTor as a twistd app. This is the fila that is called by
+gettor_service.
+
 """
 
 from __future__ import print_function
diff --git a/scripts/process_email b/scripts/process_email
index 26ca60e..a5da6eb 100755
--- a/scripts/process_email
+++ b/scripts/process_email
@@ -7,6 +7,10 @@
 #           see also AUTHORS file
 #
 # :license: This is Free Software. See LICENSE for license information.
+#
+# When a mail hits postfix this is the script that will process it.
+# This is configured in the .forward file within the gettor home.
+#
 
 import sys
 import os
diff --git a/scripts/update_files b/scripts/update_files
index fa41120..f2629f6 100755
--- a/scripts/update_files
+++ b/scripts/update_files
@@ -8,6 +8,9 @@
 # :copyright:   (c) 2008-2019, The Tor Project, Inc.
 #
 # :license: This is Free Software. See LICENSE for license information.
+#
+# Updates all the files in all the endpoints.
+#
 
 cd ~/releases
 git checkout master