INSTALL.txt

   1                                     Roundup
   2                                     =======
   3
   4 Installation
   5 ===============
   6 These instructions work on redhat 6.2 and mandrake 8.0 - with the caveat
   7 that these systems don't come with python 2.0 or newer installed, so you'll
   8 have to upgrade python before this stuff will work.
   9
  10
  11 Prerequisites
  12 -------------
  13 Either:
  14  . Python 2.0 with pydoc installed. See http://www.lfw.org/ for pydoc.
  15 or
  16  . Python 2.1
  17
  18 You will need either the anydbm or bsddb module.
  19
  20
  21 Testing the Software
  22 --------------------
  23
  24 Run "python -c 'import test;test.go()'" and make sure there's no errors.
  25 If there are errors, please let us know!
  26
  27
  28 Installing the Software
  29 -----------------------
  30
  31 1. Run:
  32
  33       python setup.py install
  34
  35    If you would prefer the scripts installed in somewhere other than
  36    /usr/local/bin, add "--install-scripts=<dir>" to the command:
  37
  38       python setup.py install --install-scripts=<dir>
  39
  40    The command:
  41
  42       python setup.py install --help
  43
  44    gives all the options available for installation.
  45
  46
  47
  48 Initial Setup
  49 =============
  50
  51 The following instructions assume that you have installed roundup. If you
  52 haven't, you may still proceed - just preface all commands with "./"
  53 ie. "./roundup-admin init".
  54
  55
  56 Instance
  57 --------
  58 Run "roundup-admin init". This initialises a roundup instance.
  59
  60 Roundup is configurable using a localconfig.py file in the instance home.
  61 It may have the following variable declarations:
  62
  63   MAILHOST - The SMTP mail host that roundup will use to send mail
  64   MAIL_DOMAIN - The domain name used for email addresses
  65
  66 Any further configuration should be possible by editing the instance home's
  67 __init__.py directly.
  68
  69 The email addresses used by the system by default are:
  70
  71   issue_tracker@MAIL_DOMAIN  - submissions of issues
  72   roundup-admin@MAIL_DOMAIN  - roundup's internal use (problems, etc)
  73
  74
  75 Mail
  76 ----
  77 Set up a mail alias called "issue_tracker" as:
  78   "|/usr/bin/python /home/httpd/html/roundup/roundup-mailgw <instance_home>"
  79
  80 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh
  81 so sendmail will accept the pipe command. In that case, symlink
  82 /etc/smrsh/python to /usr/bin/python and change the command to:
  83   "|python /home/httpd/html/roundup/roundup-mailgw <instance_home>"
  84
  85
  86 Web Interface
  87 -------------
  88 This software will work through apache or stand-alone.
  89
  90 Stand-alone:
  91  1. Edit roundup-server at the top - ROUNDUP_INSTANCE_HOMES needs to know
  92     about your instance.
  93  2. "roundup-server [hostname port]"   (hostname may be "")
  94  3. Load up the page "/<instance name>/" using the port number you set and
  95     where instance name is the name you nominated in ROUNDUP_INSTANCE_HOMES.
  96
  97 Apache:
  98  1. Make sure roundup.cgi is executable. Edit it at the top -
  99     ROUNDUP_INSTANCE_HOMES needs to know about your instance.
 100  2. Edit your /etc/httpd/conf/httpd.conf and make sure that the
 101     /home/httpd/html/roundup/roundup.cgi script will be treated as a CGI
 102     script.
 103  3. Add the following to your /etc/httpd/conf/httpd.conf:
 104 ------8<------- snip here ------8<-------
 105 RewriteEngine on
 106 RewriteCond %{HTTP:Authorization} ^(.*)
 107 RewriteRule ^/roundup/roundup.cgi(.*) /home/httpd/html/roundup/roundup.cgi$1 [e=HTTP_CGI_AUTHORIZATION:%1,t=application/x-httpd-cgi,l]
 108 ------8<------- snip here ------8<-------
 109    note: the RewriteRule must be on one line - no breaks
 110  4. Re-start your apache to re-load the config
 111  5. Load up the page "/roundup/roundup.cgi/<instance name>/" where instance
 112     name is the name you nominated in ROUNDUP_INSTANCE_HOMES.
 113
 114