Fixed bugs:

[roundup.git] / INSTALL.txt

diff --git a/INSTALL.txt b/INSTALL.txt
index f0d4eaa8416811aff7dd802ebb80635b5c23bdeb..2b4783c9122bceec07a2c87325e09de83073b08e 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -64,7 +64,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 +80,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 +97,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
 -------------
@@ -107,20 +120,26 @@ Stand-alone:
     name you nominated in ROUNDUP_INSTANCE_HOMES.
 
 Apache:
- 1. Make sure roundup.cgi is executable. Edit it at the top -
+ 1. The CGI script is found in the cgi-bin directory of the roundup
+    distribution.
+ 2. Make sure roundup.cgi is executable. Edit it at the top -
     ROUNDUP_INSTANCE_HOMES needs to know about your instance.
- 2. Edit your /etc/httpd/conf/httpd.conf and make sure that the
+ 3. Edit your /etc/httpd/conf/httpd.conf and make sure that the
     /home/httpd/html/roundup/roundup.cgi script will be treated as a CGI
     script.
- 3. Add the following to your /etc/httpd/conf/httpd.conf:
-------8<------- snip here ------8<-------
-RewriteEngine on
-RewriteCond %{HTTP:Authorization} ^(.*)
-RewriteRule ^/roundup/roundup.cgi(.*) /home/httpd/html/roundup/roundup.cgi$1 [e=HTTP_CGI_AUTHORIZATION:%1,t=application/x-httpd-cgi,l]
-------8<------- snip here ------8<-------
-   note: the RewriteRule must be on one line - no breaks
- 4. Re-start your apache to re-load the config
+ 4. Re-start your apache to re-load the config if necessary.
  5. Load up the page "/roundup/roundup.cgi/<instance name>/index" where
     instance name is the name you nominated in ROUNDUP_INSTANCE_HOMES.
-
+ 6. To use the CGI script unchanged, which allows much easier updates,
+    add these directives to your "httpd.conf":
+        SetEnv ROUNDUP_LOG "/var/log/roundup.log"
+        SetEnv ROUNDUP_INSTANCE_HOMES "Default=/usr/local/share/roundup/instances/Default"
+        SetEnv ROUNDUP_DEBUG "0"
+ 7. On Windows, write a batch file "roundup.bat" similar to the one below
+    and place it into your cgi-bin directory:
+        @echo off
+        set ROUNDUP_LOG=c:\Python21\share\roundup\cgi.log
+        set ROUNDUP_INSTANCE_HOMES=Default=c:\Python21\share\roundup\instances\Default;
+        set ROUNDUP_DEBUG=0
+        c:\Python21\python.exe c:\Python21\share\roundup\cgi-bin\roundup.cgi