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 tests;tests.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. "./setup.py install"
  32 2. At present, the programs aren't installed, so you will need to copy:
  33       roundup-admin
  34       roundup-mailgw
  35       roundup-server
  36    to /usr/local/bin if you wish to have them installed.
  37
  38
  39
  40 Initial Setup
  41 =============
  42
  43 Instance
  44 --------
  45 Try "./roundup-admin init" :)
  46
  47 Roundup is configurable using a localconfig.py file in the instance home.
  48 It may have the following variable declarations:
  49
  50   MAILHOST - The SMTP mail host that roundup will use to send mail
  51   MAIL_DOMAIN - The domain name used for email addresses
  52
  53 Any further configuration should be possible by editing the instance home's
  54 __init__.py directly.
  55
  56 The email addresses used by the system by default are:
  57
  58   issue_tracker@MAIL_DOMAIN  - submissions of issues
  59   roundup-admin@MAIL_DOMAIN  - roundup's internal use (problems, etc)
  60
  61
  62 Mail
  63 ----
  64 Set up a mail alias called "issue_tracker" as:
  65   "|/usr/bin/python /home/httpd/html/roundup/roundup-mailgw <instance_home>"
  66
  67 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh
  68 so sendmail will accept the pipe command. In that case, symlink
  69 /etc/smrsh/python to /usr/bin/python and change the command to:
  70   "|python /home/httpd/html/roundup/roundup-mailgw <instance_home>"
  71
  72
  73 Web Interface
  74 -------------
  75 This software will work through apache or stand-alone.
  76
  77 Stand-alone:
  78  1. Edit roundup-server at the top - ROUNDUP_INSTANCE_HOMES needs to know
  79     about your instance.
  80  2. "./roundup-server [hostname port]"   (hostname may be "")
  81  3. Load up the page "/" using the port number you set.
  82
  83 Apache:
  84  1. Make sure roundup.cgi is executable. Edit it at the top -
  85     ROUNDUP_INSTANCE_HOMES needs to know about your instance.
  86  2. Edit your /etc/httpd/conf/httpd.conf and make sure that the
  87     /home/httpd/html/roundup/roundup.cgi script will be treated as a CGI
  88     script.
  89  3. Add the following to your /etc/httpd/conf/httpd.conf:
  90 ------8<------- snip here ------8<-------
  91 RewriteEngine on
  92 RewriteCond %{HTTP:Authorization} ^(.*)
  93 RewriteRule ^/roundup/roundup.cgi(.*) /home/httpd/html/roundup/roundup.cgi$1 [e=HTTP_CGI_AUTHORIZATION:%1,t=application/x-httpd-cgi,l]
  94 ------8<------- snip here ------8<-------
  95    note: the RewriteRule must be on one line - no breaks
  96  4. Re-start your apache to re-load the config
  97  5. Load up the page "/roundup/roundup.cgi/"
  98
  99