Mercurial > p > roundup > code

annotate INSTALL.TXT @ 89:b6b30ba53986

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed some of the exceptions so they're the right type. Removed the str()-ification of node ids so we don't mask oopsy errors any more.
author Richard Jones <richard@users.sourceforge.net>
date Fri, 27 Jul 2001 06:25:35 +0000
parents 1592c0d5fcd2
children
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 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
5 ===============
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 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
7 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
8 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
9
83
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
10
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
11 Prerequisites
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
12 -------------
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
13 Either:
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
14 . Python 2.0 with pydoc installed. See http://www.lfw.org/ for pydoc.
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
15 or
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
16 . Python 2.1
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
17
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
18 You will need either the anydbm or bsddb module.
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
19
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
20
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
21 Testing the Software
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
22 --------------------
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
23
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
24 Run "python -c 'import tests;tests.go()'" and make sure there's no errors.
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
25 If there are errors, please let us know!
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
26
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
27
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
28 Installing the Software
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
29 -----------------------
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
30
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
31 1. "./setup.py install"
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
32 2. At present, the programs aren't installed, so you will need to copy:
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
33 roundup-admin
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
34 roundup-mailgw
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
35 roundup-server
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
36 to /usr/local/bin if you wish to have them installed.
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
37
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
38
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
39
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
40 Initial Setup
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
41 =============
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
42
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
43 Instance
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
44 --------
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
45 Try "./roundup-admin init" :)
1592c0d5fcd2 Updated for new installation procedure
Richard Jones <richard@users.sourceforge.net>
parents: 59
diff changeset
46
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
47 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
48 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
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 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
51 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
52
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 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
54 __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
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 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
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 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
59 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
60
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
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 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
63 ----
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 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
65 "|/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
66
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 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
68 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
69 /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
70 "|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
71
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
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 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
74 -------------
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 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
76
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 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
78 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
79 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
80 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
81 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
82
a117296dd59c renamed the text files so that they're recognised as text files on windows
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
83 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
84 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
85 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
86 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
87 /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
88 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
89 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
90 ------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
91 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
92 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
93 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
94 ------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
95 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
96 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
97 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
98
a117296dd59c renamed the text files so that they're recognised as text files on windows
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
99
Roundup Issue Tracker: http://roundup-tracker.org/