Document scripts and service files

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

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

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

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

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

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

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