[or-cvs] r18695: {projects} Update TODO, add a few items to the README and document the (projects/gettor)

Thu Feb 26 14:33:31 UTC 2009

Author: ioerror
Date: 2009-02-26 09:33:31 -0500 (Thu, 26 Feb 2009)
New Revision: 18695

Added:
   projects/gettor/README.USER-HOWTO
Modified:
   projects/gettor/README
   projects/gettor/TODO
Log:
Update TODO, add a few items to the README and document the user interface with a sample run.


Modified: projects/gettor/README
===================================================================

--- projects/gettor/README	2009-02-25 20:51:37 UTC (rev 18694)
+++ projects/gettor/README	2009-02-26 14:33:31 UTC (rev 18695)
@@ -168,3 +168,10 @@
 our users, due to other properties of each mail provider like their
 privacy policies.
 
+VALIDATION OF REQUESTED FILES
+-----------------------------
+
+When a user submits a successful request, GetTor will respond with an email
+that has one attachment. This attachment is a zip file with a .z file
+extension. The compressed file currently consists of two files: the requested
+tool and a gpg signature from the packager of the respective file.

Added: projects/gettor/README.USER-HOWTO
===================================================================
--- projects/gettor/README.USER-HOWTO	                        (rev 0)
+++ projects/gettor/README.USER-HOWTO	2009-02-26 14:33:31 UTC (rev 18695)
@@ -0,0 +1,86 @@
+This is a document that explains how a user may request Tor or Tor related
+software via email with the GetTor program.
+
+FINDING GETTOR
+--------------
+
+It is assumed that a user has a method of finding a valid GetTor email robot.
+Currently the best known GetTor email is gettor @ torproject.org and it should
+be the most current stable GetTor robot as it is operated by the Tor Project.
+
+
+REQUIREMENTS FOR USING GETTOR
+-----------------------------
+
+Users communicate with the GetTor robot by sending messages via email. The
+messages are currently English keywords. The user must use an email provider
+that signs their email with DKIM. A user will be alerted if their email
+provider is unsupported.
+
+USING GETTOR
+------------
+
+Currently, users have a limited set of options. It is best to send an email
+with a message body (the subject line can be blank) that consists of only the
+word 'help' to receive instructions. This will send the most current set of
+choices. An example reply to a request for help follows:
+
+   Hello, This is the "gettor" robot.
+
+   I am sorry, but your request was not understood. Please select one of the
+   following package names:
+
+       panther-bundle
+       source-bundle
+       windows-bundle
+       tiger-bundle
+
+   Please send me another email. It only needs a single package name anywhere
+   in the body of your email.
+
+An example, it is possible to fetch the most current Windows bundle. A user may
+send a request with only the word 'windows-bundle' in the body of the email. An
+example reply would look something like the following:
+
+   Hello! This is the "gettor" robot.
+
+   Here's your requested software as a zip file. Please unzip the
+   package and verify the signature.
+
+   Hint: If your computer has GnuPG installed, use the gpg
+   commandline tool as follows after unpacking the zip file:
+
+      gpg --verify <packagename>.asc <packagename>
+
+   The output should look somewhat like this:
+
+      gpg: Good signature from "Roger Dingledine <arma at mit.edu>"
+
+   If you're not familiar with commandline tools, try looking for
+   a graphical user interface for GnuPG on this website:
+
+      http://www.gnupg.org/related_software/frontends.html
+
+   Have fun.
+
+The email should also include an attachment with the name 'windows-bundle.z'
+that can be downloaded by the user. The user must now unpack the zip file and
+if they wish, they may verify that the file is from the Tor Project.
+
+UNPACKING AND VERIFYING THE REQUESTED FILES
+-------------------------------------------
+
+A user should have software for decompressing .zip files. It will contain at
+least two files, the requested bundle and its digital signature. Before a user
+installs the bundle, they should verify the signature.
+
+Users should follow the most current instructions for signature verification
+as detailed by the Tor Project website:
+	https://www.torproject.org/verifying-signatures.html
+
+INSTALLING THE REQUESTED FILES
+------------------------------
+
+After verifying that the file is valid, a user should simply run the program.
+If a user requested the source code to Tor, we assume that they're able to
+follow the build instructions contained within the source itself.

Modified: projects/gettor/TODO
===================================================================
--- projects/gettor/TODO	2009-02-25 20:51:37 UTC (rev 18694)
+++ projects/gettor/TODO	2009-02-26 14:33:31 UTC (rev 18695)
@@ -8,5 +8,5 @@
 - Enhance README file
 - Split (at least) tiger bundle into several smaller archives to avoid ~20MB
 - Add more translations
+    - Freeze messages for translation
     - Put po files into pootle for translation
-    - Freeze messages for translation

