[tor-commits] [fallback-scripts/master] doc: update usage instructions in whitelist and script

[teor at torproject.org]

commit 3605278515c80d9931068370a02758ab1a74b2b5
Author: teor <teor at torproject.org>
Date:   Sun Jun 23 22:57:44 2019 +1000

    doc: update usage instructions in whitelist and script
    
    Part of 29100.
---
 fallback.whitelist    | 25 +++++++++++++++++++------
 updateFallbackDirs.py | 13 ++++++++++---
 2 files changed, 29 insertions(+), 9 deletions(-)

diff --git a/fallback.whitelist b/fallback.whitelist
index fac5473..4e6964d 100644
--- a/fallback.whitelist
+++ b/fallback.whitelist
@@ -10,14 +10,27 @@
 #
 # The latest relay details from Onionoo are included in the generated list.
 #
-# To check the hard-coded fallback list (for testing), use:
-# $ updateFallbackDirs.py check_existing
+# If a relay operator wants their relay to be a FallbackDir:
 #
-# If a relay operator wants their relay to be a FallbackDir,
-# enter the following information here:
+# Bulk Remove:
+# Put a list of fingerprints to remove, update, or add in remove.txt
+# $ grep -v -e "#" -e "^$" remove.txt | tr "\n" "|" > remove_g.txt
+# $ echo -n dummy >> remove_g.txt
+# $ mv fallback.whitelist fallback.whitelist.old
+# $ grep -E -v `cat remove_g.txt` fallback.whitelist.old > fallback.whitelist
+#
+# Bulk Add:
+# Put a list of fingerprints to update or add in add.txt
+# $ grep -v -e "#" -e "^$" add.txt | tr "\n" " " > add_g.txt
+# $ ./generateFallbackDirLine.py `cat add_g.txt` >> fallback.whitelist
+# Then check the added lines for errors.
+#
+# Quick Update:
+# $ generateFallbackDirLine.py fingerprint ...
+# Then paste the results into this file.
+#
+# Manually, Using This Format:
 # <IPv4>:<DirPort> orport=<ORPort> id=<ID> ( ipv6=[<IPv6>]:<IPv6 ORPort> )?
-# or use:
-# scripts/maint/generateFallbackDirLine.py fingerprint ...
 
 # https://lists.torproject.org/pipermail/tor-relays/2015-December/008362.html
 # https://trac.torproject.org/projects/tor/ticket/22321#comment:22
diff --git a/updateFallbackDirs.py b/updateFallbackDirs.py
index 930de67..6019025 100755
--- a/updateFallbackDirs.py
+++ b/updateFallbackDirs.py
@@ -3,11 +3,18 @@
 # Usage:
 #
 # Regenerate the list:
-# ./updateFallbackDirs.py > ../tor/src/app/config/fallback_dirs.inc 2> fallback_dirs.log
+# $ FB_MODE=""
+# $ FB_DATE=`date -u "+%Y-%m-%d-%H-%M-%S"`
+# $ FB_COUNTRY=ZZ
+# $ FB_COMMIT=`git rev-parse --short=16 HEAD`
+# $ ./updateFallbackDirs.py $FB_MODE \
+#     > fallback_dirs_"$FB_DATE"_"$FB_COUNTRY"_"$FB_COMMIT".inc \
+#     2> fallback_dirs_"$FB_DATE"_"$FB_COUNTRY"_"$FB_COMMIT".log
+# $ cp fallback_dirs_*.inc ../tor/src/app/config/fallback_dirs.inc
 #
 # Check the existing list:
-# ./updateFallbackDirs.py check_existing > fallback_dirs.inc.ok 2> fallback_dirs.log
-# mv fallback_dirs.inc.ok ../tor/src/app/config/fallback_dirs.inc
+# $ FB_MODE="check_existing"
+# Then use the commands above.
 #
 # This script should be run from a stable, reliable network connection,
 # with no other network activity (and not over tor).