. mention run_tests in "Testing the Software".

[roundup.git] / INSTALL.txt

diff --git a/INSTALL.txt b/INSTALL.txt
index 32b239dab8845a46013eccb867d2a10ac704ecb7..2fbe7842350d17114954a3fbf5aa2277e970484f 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -4,16 +4,15 @@
 Installation
 ===============
 These instructions work on redhat 6.2 and mandrake 8.0 - with the caveat
-that these systems don't come with python 2.0 or newer installed, so you'll
+that these systems don't come with python 2.1.1 or newer installed, so you'll
 have to upgrade python before this stuff will work.
 
 
 Prerequisites
 -------------
-Either:
- . Python 2.0 with pydoc installed. See http://www.lfw.org/ for pydoc.
-or
- . Python 2.1
+Python 2.1.1 or newer.
+
+Note: Python 2.1.1 shipped with SuSE7.3 might miss module _weakref.
 
 You will need either the anydbm or bsddb module.
 
@@ -21,9 +20,8 @@ You will need either the anydbm or bsddb module.
 Testing the Software
 --------------------
 
-Run "python -c 'import test;test.go()'" and make sure there's no errors.
-If there are errors, please let us know!
-
+Either run "run_tests" or "python -c 'import test;test.go()'" and make sure 
+there's no errors. If there are errors, please let us know!
 
 Installing the Software
 -----------------------
@@ -64,7 +62,7 @@ It may have the following variable declarations:
   MAIL_DOMAIN - The domain name used for email addresses
 
 Any further configuration should be possible by editing the instance home's
-__init__.py directly.
+instance_config.py directly.
 
 The email addresses used by the system by default are:
 
@@ -80,13 +78,16 @@ any admin people.
 
 Mail
 ----
+
+Setup 1: As a mail alias pipe process
+- - - - - - - - - - - - - - - - - - -
 Set up a mail alias called "issue_tracker" as:
   "|/usr/bin/python /usr/local/bin/roundup-mailgw <instance_home>"
 
 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh
 so sendmail will accept the pipe command. In that case, symlink
 /etc/smrsh/roundup-mailgw to /usr/local/bin/roundup-mailgw and change the
-command to:
+command to (include the quote marks):
   "|roundup-mailgw <instance_home>"
 
 To test the mail gateway on unix systems, try:
@@ -94,6 +95,16 @@ To test the mail gateway on unix systems, try:
   echo test |mail -s '[issue] test' issue_tracker@your.domain
 
 
+Setup 2: As a regular cron job
+- - - - - - - - - - - - - - - 
+Set the roundup-mailgw up to run every 10 minutes or so. For example:
+10 * * * * /usr/local/bin/roundup-mailgw <instance_home> <mail_spool_file>
+
+Where the mail_spool_file argument is the location of the roundup
+submission user's mail spool. On most systems, the spool for a user
+"issue_tracker" will be "/var/mail/issue_tracker".
+
+
 
 Web Interface
 -------------