Mercurial > p > roundup > code

comparison doc/installation.txt @ 3303:520eef0e0e91

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix installation docs referring to old-style configuration variables
author Richard Jones <richard@users.sourceforge.net>
date Mon, 02 May 2005 00:43:37 +0000
parents 8f7dc283bfa5
children e996f3584772
comparison
equal deleted inserted replaced
3301:25b68c7998eb 3303:520eef0e0e91
176 The "support" part of the tracker name can be anything you want - it 176 The "support" part of the tracker name can be anything you want - it
177 is going to be used as the directory that the tracker information 177 is going to be used as the directory that the tracker information
178 will be stored in. 178 will be stored in.
179 179
180 You will now be directed to edit the tracker configuration and 180 You will now be directed to edit the tracker configuration and
181 initial schema. At a minimum, you must set ``MAILHOST``, 181 initial schema. At a minimum, you must set "main :: admin_email"
182 ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. The 182 (that's the "admin_email" option in the "main" section) "mail ::
183 configuration file uses Python syntax, so almost every value must be 183 host", "tracker :: web" and "mail :: domain". If you get stuck,
184 ``'quoted'`` using single or double quotes. If you get stuck, and get 184 and get configuration file errors, then see the `tracker
185 configuration file errors, then see the `tracker configuration`_ section 185 configuration`_ section of the `customisation documentation`_.
186 of the `customisation documentation`_.
187 186
188 If you just want to get set up to test things quickly (and follow 187 If you just want to get set up to test things quickly (and follow
189 the instructions in step 3 below), you can even just set the 188 the instructions in step 3 below), you can even just set the
190 TRACKER_WEB variable to:: 189 "tracker :: web" variable to::
191 190
192 TRACKER_WEB = 'http://localhost:8080/support/' 191 web = http://localhost:8080/support/
193 192
194 The URL *must* end in a '/', or your web interface *will not work*. 193 The URL *must* end in a '/', or your web interface *will not work*.
195 See `Customising Roundup`_ for details on configuration and schema 194 See `Customising Roundup`_ for details on configuration and schema
196 changes. You may change any of the configuration after 195 changes. You may change any of the configuration after
197 you've initialised the tracker - it's just better to have valid values 196 you've initialised the tracker - it's just better to have valid values
211 Once this is done, the tracker has been created. 210 Once this is done, the tracker has been created.
212 211
213 2. At this point, your tracker is set up, but doesn't have a nice user 212 2. At this point, your tracker is set up, but doesn't have a nice user
214 interface. To set that up, we need to `configure a web interface`_ and 213 interface. To set that up, we need to `configure a web interface`_ and
215 optionally `configure an email interface`_. If you want to try your 214 optionally `configure an email interface`_. If you want to try your
216 new tracker out, assuming ``TRACKER_WEB`` is set to 215 new tracker out, assuming "tracker :: web" is set to
217 ``'http://localhost:8080/support/'``, run:: 216 ``'http://localhost:8080/support/'``, run::
218 217
219 roundup-server support=/opt/roundup/trackers/support 218 roundup-server support=/opt/roundup/trackers/support
220 219
221 then direct your web browser at: 220 then direct your web browser at:
326 325
327 Copy the ``cgi-bin/roundup.cgi`` file to your web server's ``cgi-bin`` 326 Copy the ``cgi-bin/roundup.cgi`` file to your web server's ``cgi-bin``
328 directory. You will need to configure it to tell it where your tracker home 327 directory. You will need to configure it to tell it where your tracker home
329 is. You can do this either: 328 is. You can do this either:
330 329
331 through an environment variable 330 Through an environment variable
332 set the variable TRACKER_HOMES to be a colon (":") separated list of 331 Set the variable TRACKER_HOMES to be a colon (":") separated list of
333 name=home pairs (if you're using apache, the SetEnv directive can do this) 332 name=home pairs (if you're using apache, the SetEnv directive can do this)
334 directly in the ``roundup.cgi`` file itself 333
335 add your instance to the TRACKER_HOMES variable as ``'name': 'home'`` 334 Directly in the ``roundup.cgi`` file itself
335 Add your instance to the TRACKER_HOMES variable as ``'name': 'home'``
336 336
337 The "name" part of the configuration will appear in the URL and identifies the 337 The "name" part of the configuration will appear in the URL and identifies the
338 tracker (so you may have more than one tracker per cgi-bin script). Make sure 338 tracker (so you may have more than one tracker per cgi-bin script). Make sure
339 there are no spaces or other illegal characters in it (to be safe, stick to 339 there are no spaces or other illegal characters in it (to be safe, stick to
340 letters and numbers). The "name" forms part of the URL that appears in the 340 letters and numbers). The "name" forms part of the URL that appears in the
341 tracker config TRACKER_WEB variable, so make sure they match. The "home" 341 tracker config "tracker :: web" variable, so make sure they match. The "home"
342 part of the configuration is the tracker home directory. 342 part of the configuration is the tracker home directory.
343 343
344 If you're using Apache, you can use an additional trick to hide the 344 If you're using Apache, you can use an additional trick to hide the
345 ``.cgi`` extension of the cgi script. Place the ``roundup.cgi`` script 345 ``.cgi`` extension of the cgi script. Place the ``roundup.cgi`` script
346 wherever you want it to be, renamed it to just ``roundup``, and add a 346 wherever you want it to be, renamed it to just ``roundup``, and add a
Roundup Issue Tracker: http://roundup-tracker.org/