Mercurial > p > roundup > code

annotate INSTALL.txt @ 410:3a192fe4e709

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Typo fix
author Jürgen Hermann <jhermann@users.sourceforge.net>
date Sun, 25 Nov 2001 10:11:14 +0000
parents 745f9cacfba0
children a28a80b714f9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 Roundup
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 =======
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 Installation
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 ===============
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 These instructions work on redhat 6.2 and mandrake 8.0 - with the caveat
9cf5229397fc name changes to make distutils happy
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
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 have to upgrade python before this stuff will work.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 Prerequisites
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 -------------
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 Either:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 . Python 2.0 with pydoc installed. See http://www.lfw.org/ for pydoc.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 or
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 . Python 2.1
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 You will need either the anydbm or bsddb module.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 Testing the Software
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 --------------------
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23
102
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
24 Run "python -c 'import test;test.go()'" and make sure there's no errors.
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 If there are errors, please let us know!
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28 Installing the Software
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 -----------------------
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30
101
f55b8be00de5 more notes for installation
Richard Jones <richard@users.sourceforge.net>
parents: 94
diff changeset
31 1. Run:
f55b8be00de5 more notes for installation
Richard Jones <richard@users.sourceforge.net>
parents: 94
diff changeset
32
f55b8be00de5 more notes for installation
Richard Jones <richard@users.sourceforge.net>
parents: 94
diff changeset
33 python setup.py install
f55b8be00de5 more notes for installation
Richard Jones <richard@users.sourceforge.net>
parents: 94
diff changeset
34
102
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
35 If you would prefer the scripts installed in somewhere other than
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
36 /usr/local/bin, add "--install-scripts=<dir>" to the command:
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
37
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
38 python setup.py install --install-scripts=<dir>
101
f55b8be00de5 more notes for installation
Richard Jones <richard@users.sourceforge.net>
parents: 94
diff changeset
39
102
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
40 The command:
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
41
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
42 python setup.py install --help
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
43
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
44 gives all the options available for installation.
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 Initial Setup
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 =============
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50
102
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
51 The following instructions assume that you have installed roundup. If you
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
52 haven't, you may still proceed - just preface all commands with "./"
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
53 ie. "./roundup-admin init".
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
54
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
55
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56 Instance
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 --------
102
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
58 Run "roundup-admin init". This initialises a roundup instance.
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60 Roundup is configurable using a localconfig.py file in the instance home.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61 It may have the following variable declarations:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63 MAILHOST - The SMTP mail host that roundup will use to send mail
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64 MAIL_DOMAIN - The domain name used for email addresses
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
66 Any further configuration should be possible by editing the instance home's
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
67 __init__.py directly.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
68
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69 The email addresses used by the system by default are:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
70
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71 issue_tracker@MAIL_DOMAIN - submissions of issues
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
72 roundup-admin@MAIL_DOMAIN - roundup's internal use (problems, etc)
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74
236
8827f5931ea8 Fixed CGI client change messages...
Richard Jones <richard@users.sourceforge.net>
parents: 219
diff changeset
75 Note:
8827f5931ea8 Fixed CGI client change messages...
Richard Jones <richard@users.sourceforge.net>
parents: 219
diff changeset
76 We run the instance as group "issue_tracker" and add the mail and web user
8827f5931ea8 Fixed CGI client change messages...
Richard Jones <richard@users.sourceforge.net>
parents: 219
diff changeset
77 ("mail" and "apache" on our RedHat 7.1 system) to that group, as well as
8827f5931ea8 Fixed CGI client change messages...
Richard Jones <richard@users.sourceforge.net>
parents: 219
diff changeset
78 any admin people.
8827f5931ea8 Fixed CGI client change messages...
Richard Jones <richard@users.sourceforge.net>
parents: 219
diff changeset
79
8827f5931ea8 Fixed CGI client change messages...
Richard Jones <richard@users.sourceforge.net>
parents: 219
diff changeset
80
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81 Mail
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
82 ----
370
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
83
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
84 Setup 1: As a mail alias pipe process
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
85 - - - - - - - - - - - - - - - - - - -
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
86 Set up a mail alias called "issue_tracker" as:
216
dbb35b638e88 further clarification for gettnig started
Richard Jones <richard@users.sourceforge.net>
parents: 209
diff changeset
87 "|/usr/bin/python /usr/local/bin/roundup-mailgw <instance_home>"
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
89 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90 so sendmail will accept the pipe command. In that case, symlink
217
b02a69130c91 more install note changes
Richard Jones <richard@users.sourceforge.net>
parents: 216
diff changeset
91 /etc/smrsh/roundup-mailgw to /usr/local/bin/roundup-mailgw and change the
b02a69130c91 more install note changes
Richard Jones <richard@users.sourceforge.net>
parents: 216
diff changeset
92 command to:
b02a69130c91 more install note changes
Richard Jones <richard@users.sourceforge.net>
parents: 216
diff changeset
93 "|roundup-mailgw <instance_home>"
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
94
219
2482585afdbb included some instructions on how to test mailgw
Richard Jones <richard@users.sourceforge.net>
parents: 217
diff changeset
95 To test the mail gateway on unix systems, try:
2482585afdbb included some instructions on how to test mailgw
Richard Jones <richard@users.sourceforge.net>
parents: 217
diff changeset
96
2482585afdbb included some instructions on how to test mailgw
Richard Jones <richard@users.sourceforge.net>
parents: 217
diff changeset
97 echo test |mail -s '[issue] test' issue_tracker@your.domain
2482585afdbb included some instructions on how to test mailgw
Richard Jones <richard@users.sourceforge.net>
parents: 217
diff changeset
98
2482585afdbb included some instructions on how to test mailgw
Richard Jones <richard@users.sourceforge.net>
parents: 217
diff changeset
99
370
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
100 Setup 2: As a regular cron job
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
101 - - - - - - - - - - - - - - -
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
102 Set the roundup-mailgw up to run every 10 minutes or so. For example:
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
103 10 * * * * /usr/local/bin/roundup-mailgw <instance_home> <mail_spool_file>
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
104
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
105 Where the mail_spool_file argument is the location of the roundup
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
106 submission user's mail spool. On most systems, the spool for a user
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
107 "issue_tracker" will be "/var/mail/issue_tracker".
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
108
745f9cacfba0 Info on setting up a local spool handling mail gateway.
Richard Jones <richard@users.sourceforge.net>
parents: 361
diff changeset
109
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
110
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
111 Web Interface
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
112 -------------
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
113 This software will work through apache or stand-alone.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
115 Stand-alone:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
116 1. Edit roundup-server at the top - ROUNDUP_INSTANCE_HOMES needs to know
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
117 about your instance.
102
0b250446cf8b Fixed some problems with installation.
Richard Jones <richard@users.sourceforge.net>
parents: 101
diff changeset
118 2. "roundup-server [hostname port]" (hostname may be "")
216
dbb35b638e88 further clarification for gettnig started
Richard Jones <richard@users.sourceforge.net>
parents: 209
diff changeset
119 3. Load up the page "/<instance name>/index" where instance name is the
dbb35b638e88 further clarification for gettnig started
Richard Jones <richard@users.sourceforge.net>
parents: 209
diff changeset
120 name you nominated in ROUNDUP_INSTANCE_HOMES.
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
121
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
122 Apache:
328
ff35f683fc9d Fixed manifest template
Richard Jones <richard@users.sourceforge.net>
parents: 236
diff changeset
123 1. The CGI script is found in the cgi-bin directory of the roundup
ff35f683fc9d Fixed manifest template
Richard Jones <richard@users.sourceforge.net>
parents: 236
diff changeset
124 distribution.
ff35f683fc9d Fixed manifest template
Richard Jones <richard@users.sourceforge.net>
parents: 236
diff changeset
125 2. Make sure roundup.cgi is executable. Edit it at the top -
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
126 ROUNDUP_INSTANCE_HOMES needs to know about your instance.
328
ff35f683fc9d Fixed manifest template
Richard Jones <richard@users.sourceforge.net>
parents: 236
diff changeset
127 3. Edit your /etc/httpd/conf/httpd.conf and make sure that the
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
128 /home/httpd/html/roundup/roundup.cgi script will be treated as a CGI
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
129 script.
328
ff35f683fc9d Fixed manifest template
Richard Jones <richard@users.sourceforge.net>
parents: 236
diff changeset
130 4. Re-start your apache to re-load the config if necessary.
216
dbb35b638e88 further clarification for gettnig started
Richard Jones <richard@users.sourceforge.net>
parents: 209
diff changeset
131 5. Load up the page "/roundup/roundup.cgi/<instance name>/index" where
dbb35b638e88 further clarification for gettnig started
Richard Jones <richard@users.sourceforge.net>
parents: 209
diff changeset
132 instance name is the name you nominated in ROUNDUP_INSTANCE_HOMES.
359
3903aaaef4e1 Added samples for "external" CGI config
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 328
diff changeset
133 6. To use the CGI script unchanged, which allows much easier updates,
3903aaaef4e1 Added samples for "external" CGI config
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 328
diff changeset
134 add these directives to your "httpd.conf":
3903aaaef4e1 Added samples for "external" CGI config
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 328
diff changeset
135 SetEnv ROUNDUP_LOG "/var/log/roundup.log"
361
5a1c284dabea Changed samples to use "share/roundup" paths
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 359
diff changeset
136 SetEnv ROUNDUP_INSTANCE_HOMES "Default=/usr/local/share/roundup/instances/Default"
359
3903aaaef4e1 Added samples for "external" CGI config
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 328
diff changeset
137 SetEnv ROUNDUP_DEBUG "0"
3903aaaef4e1 Added samples for "external" CGI config
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 328
diff changeset
138 7. On Windows, write a batch file "roundup.bat" similar to the one below
3903aaaef4e1 Added samples for "external" CGI config
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 328
diff changeset
139 and place it into your cgi-bin directory:
3903aaaef4e1 Added samples for "external" CGI config
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 328
diff changeset
140 @echo off
361
5a1c284dabea Changed samples to use "share/roundup" paths
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 359
diff changeset
141 set ROUNDUP_LOG=c:\Python21\share\roundup\cgi.log
5a1c284dabea Changed samples to use "share/roundup" paths
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 359
diff changeset
142 set ROUNDUP_INSTANCE_HOMES=Default=c:\Python21\share\roundup\instances\Default;
359
3903aaaef4e1 Added samples for "external" CGI config
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 328
diff changeset
143 set ROUNDUP_DEBUG=0
361
5a1c284dabea Changed samples to use "share/roundup" paths
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 359
diff changeset
144 c:\Python21\python.exe c:\Python21\share\roundup\cgi-bin\roundup.cgi
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
145
Roundup Issue Tracker: http://roundup-tracker.org/