Mercurial > p > roundup > code

comparison doc/installation.txt @ 3304:ae7ddb3eb091 maint-0.8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
merge from HEAD
author Richard Jones <richard@users.sourceforge.net>
date Mon, 02 May 2005 00:45:14 +0000
parents 62b1a54107e6
children f2ba6b549680
comparison
equal deleted inserted replaced
3300:053bd6ab58e8 3304:ae7ddb3eb091
154 The "support" part of the tracker name can be anything you want - it 154 The "support" part of the tracker name can be anything you want - it
155 is going to be used as the directory that the tracker information 155 is going to be used as the directory that the tracker information
156 will be stored in. 156 will be stored in.
157 157
158 You will now be directed to edit the tracker configuration and 158 You will now be directed to edit the tracker configuration and
159 initial schema. At a minimum, you must set ``MAILHOST``, 159 initial schema. At a minimum, you must set "main :: admin_email"
160 ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. The 160 (that's the "admin_email" option in the "main" section) "mail ::
161 configuration file uses Python syntax, so almost every value must be 161 host", "tracker :: web" and "mail :: domain". If you get stuck,
162 ``'quoted'`` using single or double quotes. If you get stuck, and get 162 and get configuration file errors, then see the `tracker
163 configuration file errors, then see the `tracker configuration`_ section 163 configuration`_ section of the `customisation documentation`_.
164 of the `customisation documentation`_.
165 164
166 If you just want to get set up to test things quickly (and follow 165 If you just want to get set up to test things quickly (and follow
167 the instructions in step 3 below), you can even just set the 166 the instructions in step 3 below), you can even just set the
168 TRACKER_WEB variable to:: 167 "tracker :: web" variable to::
169 168
170 TRACKER_WEB = 'http://localhost:8080/support/' 169 web = http://localhost:8080/support/
171 170
172 The URL *must* end in a '/', or your web interface *will not work*. 171 The URL *must* end in a '/', or your web interface *will not work*.
173 See `Customising Roundup`_ for details on configuration and schema 172 See `Customising Roundup`_ for details on configuration and schema
174 changes. You may change any of the configuration after 173 changes. You may change any of the configuration after
175 you've initialised the tracker - it's just better to have valid values 174 you've initialised the tracker - it's just better to have valid values
189 Once this is done, the tracker has been created. 188 Once this is done, the tracker has been created.
190 189
191 2. At this point, your tracker is set up, but doesn't have a nice user 190 2. At this point, your tracker is set up, but doesn't have a nice user
192 interface. To set that up, we need to `configure a web interface`_ and 191 interface. To set that up, we need to `configure a web interface`_ and
193 optionally `configure an email interface`_. If you want to try your 192 optionally `configure an email interface`_. If you want to try your
194 new tracker out, assuming ``TRACKER_WEB`` is set to 193 new tracker out, assuming "tracker :: web" is set to
195 ``'http://localhost:8080/support/'``, run:: 194 ``'http://localhost:8080/support/'``, run::
196 195
197 roundup-server support=/opt/roundup/trackers/support 196 roundup-server support=/opt/roundup/trackers/support
198 197
199 then direct your web browser at: 198 then direct your web browser at:
304 303
305 Copy the ``cgi-bin/roundup.cgi`` file to your web server's ``cgi-bin`` 304 Copy the ``cgi-bin/roundup.cgi`` file to your web server's ``cgi-bin``
306 directory. You will need to configure it to tell it where your tracker home 305 directory. You will need to configure it to tell it where your tracker home
307 is. You can do this either: 306 is. You can do this either:
308 307
309 through an environment variable 308 Through an environment variable
310 set the variable TRACKER_HOMES to be a colon (":") separated list of 309 Set the variable TRACKER_HOMES to be a colon (":") separated list of
311 name=home pairs (if you're using apache, the SetEnv directive can do this) 310 name=home pairs (if you're using apache, the SetEnv directive can do this)
312 directly in the ``roundup.cgi`` file itself 311
313 add your instance to the TRACKER_HOMES variable as ``'name': 'home'`` 312 Directly in the ``roundup.cgi`` file itself
313 Add your instance to the TRACKER_HOMES variable as ``'name': 'home'``
314 314
315 The "name" part of the configuration will appear in the URL and identifies the 315 The "name" part of the configuration will appear in the URL and identifies the
316 tracker (so you may have more than one tracker per cgi-bin script). Make sure 316 tracker (so you may have more than one tracker per cgi-bin script). Make sure
317 there are no spaces or other illegal characters in it (to be safe, stick to 317 there are no spaces or other illegal characters in it (to be safe, stick to
318 letters and numbers). The "name" forms part of the URL that appears in the 318 letters and numbers). The "name" forms part of the URL that appears in the
319 tracker config TRACKER_WEB variable, so make sure they match. The "home" 319 tracker config "tracker :: web" variable, so make sure they match. The "home"
320 part of the configuration is the tracker home directory. 320 part of the configuration is the tracker home directory.
321 321
322 If you're using Apache, you can use an additional trick to hide the 322 If you're using Apache, you can use an additional trick to hide the
323 ``.cgi`` extension of the cgi script. Place the ``roundup.cgi`` script 323 ``.cgi`` extension of the cgi script. Place the ``roundup.cgi`` script
324 wherever you want it to be, renamed it to just ``roundup``, and add a 324 wherever you want it to be, renamed it to just ``roundup``, and add a
Roundup Issue Tracker: http://roundup-tracker.org/