Mercurial > p > roundup > code

comparison doc/getting_started.txt @ 1096:fa7df238e2d4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
author Richard Jones <richard@users.sourceforge.net>
date Tue, 10 Sep 2002 03:01:20 +0000
parents 43ab730ee194
children
comparison
equal deleted inserted replaced
1095:711f2ecee20f 1096:fa7df238e2d4
1 =============== 1 ===============
2 Getting Started 2 Getting Started
3 =============== 3 ===============
4 4
5 :Version: $Revision: 1.6 $ 5 :Version: $Revision: 1.7 $
6 6
7 .. contents:: 7 .. contents::
8 8
9 9
10 The following instructions assume that you have installed roundup. If you 10 The following instructions assume that you have installed roundup. If you
60 60
61 MAILHOST 61 MAILHOST
62 The SMTP mail host that roundup will use to send mail 62 The SMTP mail host that roundup will use to send mail
63 MAIL_DOMAIN 63 MAIL_DOMAIN
64 The domain name used for email addresses 64 The domain name used for email addresses
65 ISSUE_TRACKER_WEB 65 TRACKER_WEB
66 The web address of the issue tracker's web interface 66 The web address of the issue tracker's web interface
67 67
68 The email addresses used by the system by default are: 68 The email addresses used by the system by default are:
69 69
70 ISSUE_TRACKER_EMAIL: ``issue_tracker@MAIL_DOMAIN`` 70 TRACKER_EMAIL: ``issue_tracker@MAIL_DOMAIN``
71 submissions of issues 71 submissions of issues
72 72
73 ADMIN_EMAIL: ``roundup-admin@MAIL_DOMAIN`` 73 ADMIN_EMAIL: ``roundup-admin@MAIL_DOMAIN``
74 roundup's internal use (problems, etc) 74 roundup's internal use (problems, etc)
75 75
134 ------------- 134 -------------
135 135
136 This software will work through apache or stand-alone. 136 This software will work through apache or stand-alone.
137 137
138 Stand-alone: 138 Stand-alone:
139 1. Edit roundup-server at the top - ``ROUNDUP_INSTANCE_HOMES`` needs to know 139 1. Edit roundup-server at the top - ``TRACKER_HOMES`` needs to know
140 about your tracker. You may also specify the values for 140 about your tracker. You may also specify the values for
141 ``ROUNDUP_INSTANCE_HOMES`` on the command-line using "name=home" pairs. 141 ``TRACKER_HOMES`` on the command-line using "name=home" pairs.
142 142
143 2. "``roundup-server [-p port] (name=tracker_home)*``" (hostname may be "") 143 2. "``roundup-server [-p port] (name=tracker_home)*``" (hostname may be "")
144 144
145 3. Load up the page "``/<tracker name>/index``" where tracker name is the name 145 3. Load up the page "``/<tracker name>/index``" where tracker name is the name
146 you nominated in ``ROUNDUP_INSTANCE_HOMES``. 146 you nominated in ``TRACKER_HOMES``.
147 147
148 Apache: 148 Apache:
149 1. The CGI script is found in the cgi-bin directory of the roundup 149 1. The CGI script is found in the cgi-bin directory of the roundup
150 distribution. 150 distribution.
151 151
152 2. Make sure roundup.cgi is executable. Edit it at the top - 152 2. Make sure roundup.cgi is executable. Edit it at the top -
153 ``ROUNDUP_INSTANCE_HOMES`` needs to know about your tracker. 153 ``TRACKER_HOMES`` needs to know about your tracker.
154 154
155 3. Edit your "``/etc/httpd/conf/httpd.conf``" and make sure that the 155 3. Edit your "``/etc/httpd/conf/httpd.conf``" and make sure that the
156 "``/home/httpd/html/roundup/roundup.cgi``" script will be treated as a CGI script. 156 "``/home/httpd/html/roundup/roundup.cgi``" script will be treated as a CGI script.
157 157
158 4. Re-start your apache to re-load the config if necessary. 158 4. Re-start your apache to re-load the config if necessary.
159 159
160 5. Load up the page "``/roundup/roundup.cgi/index/``" where tracker name is the 160 5. Load up the page "``/roundup/roundup.cgi/index/``" where tracker name is the
161 name you nominated in ``ROUNDUP_INSTANCE_HOMES``. 161 name you nominated in ``TRACKER_HOMES``.
162 162
163 6. To use the CGI script unchanged, which allows much easier updates, add 163 6. To use the CGI script unchanged, which allows much easier updates, add
164 these directives to your "httpd.conf":: 164 these directives to your "httpd.conf"::
165 165
166 SetEnv ROUNDUP_LOG "/var/log/roundup.log" 166 SetEnv ROUNDUP_LOG "/var/log/roundup.log"
167 SetEnv ROUNDUP_INSTANCE_HOMES "Default=/usr/local/share/roundup/trackers/Default" 167 SetEnv TRACKER_HOMES "Default=/usr/local/share/roundup/trackers/Default"
168 SetEnv ROUNDUP_DEBUG "0" 168 SetEnv ROUNDUP_DEBUG "0"
169 169
170 7. On Windows, write a batch file "roundup.bat" similar to the one below and 170 7. On Windows, write a batch file "roundup.bat" similar to the one below and
171 place it into your cgi-bin directory:: 171 place it into your cgi-bin directory::
172 172
173 @echo off 173 @echo off
174 set ROUNDUP_LOG=c:\Python21\share\roundup\cgi.log 174 set ROUNDUP_LOG=c:\Python21\share\roundup\cgi.log
175 set ROUNDUP_INSTANCE_HOMES=Default=c:\Python21\share\roundup\trackers\Default; 175 set TRACKER_HOMES=Default=c:\Python21\share\roundup\trackers\Default;
176 set ROUNDUP_DEBUG=0 176 set ROUNDUP_DEBUG=0
177 c:\Python21\python.exe c:\Python21\share\roundup\cgi-bin\roundup.cgi 177 c:\Python21\python.exe c:\Python21\share\roundup\cgi-bin\roundup.cgi
178 178
179 179
180 Users 180 Users
Roundup Issue Tracker: http://roundup-tracker.org/