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