annotate INSTALL.TXT @ 54:b68bcb176d1a

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

Roundup Issue Tracker: http://roundup-tracker.org/