Code

renamed the text files so that they're recognised as text files on windows
[roundup.git] / INSTALL.TXT
1                                     Roundup
2                                     =======
5 Installation
6 ===============
7 These instructions work on redhat 6.2 and mandrake 8.0 - with the caveat
8 that these systems don't come with python 2.0 or newer installed, so you'll
9 have to upgrade python before this stuff will work.
11 Roundup is configurable using a localconfig.py file in the instance home.
12 It may have the following variable declarations:
13   
14   MAILHOST - The SMTP mail host that roundup will use to send mail
15   MAIL_DOMAIN - The domain name used for email addresses
17 Any further configuration should be possible by editing the instance home's
18 __init__.py directly.
20 The email addresses used by the system by default are:
22   issue_tracker@MAIL_DOMAIN  - submissions of issues
23   roundup-admin@MAIL_DOMAIN  - roundup's internal use (problems, etc)
26 Prerequisites
27 -----------------
28 Either:
29  . Python 2.0 with pydoc installed. See http://www.lfw.org/ for pydoc.
30 or
31  . Python 2.1
33 Both need the anydbm or bsddb module.
37 Initial Setup
38 =============
40 Instance
41 --------
42 Try "./roundup-admin init" :)
45 Mail
46 ----
47 Set up a mail alias called "issue_tracker" as:
48   "|/usr/bin/python /home/httpd/html/roundup/roundup-mailgw <instance_home>"
50 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh
51 so sendmail will accept the pipe command. In that case, symlink
52 /etc/smrsh/python to /usr/bin/python and change the command to:
53   "|python /home/httpd/html/roundup/roundup-mailgw <instance_home>"
56 Web Interface
57 -------------
58 This software will work through apache or stand-alone.
60 Stand-alone:
61  1. Edit roundup-server at the top - ROUNDUP_INSTANCE_HOMES needs to know
62     about your instance.
63  2. "./roundup-server [hostname port]"   (hostname may be "")
64  3. Load up the page "/" using the port number you set.
66 Apache:
67  1. Make sure roundup.cgi is executable. Edit it at the top -
68     ROUNDUP_INSTANCE_HOMES needs to know about your instance.
69  2. Edit your /etc/httpd/conf/httpd.conf and make sure that the
70     /home/httpd/html/roundup/roundup.cgi script will be treated as a CGI
71     script.
72  3. Add the following to your /etc/httpd/conf/httpd.conf:
73 ------8<------- snip here ------8<-------
74 RewriteEngine on
75 RewriteCond %{HTTP:Authorization} ^(.*)
76 RewriteRule ^/roundup/roundup.cgi(.*) /home/httpd/html/roundup/roundup.cgi$1 [e=HTTP_CGI_AUTHORIZATION:%1,t=application/x-httpd-cgi,l]
77 ------8<------- snip here ------8<-------
78    note: the RewriteRule must be on one line - no breaks
79  4. Re-start your apache to re-load the config
80  5. Load up the page "/roundup/roundup.cgi/"