Mercurial > p > roundup > code

comparison doc/installation.txt @ 2407:ef226254ef46 maint-0.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
some more documentation work
author Richard Jones <richard@users.sourceforge.net>
date Wed, 09 Jun 2004 00:11:49 +0000
parents c8f426142289
children e12a610eb7f3
comparison
equal deleted inserted replaced
2406:3f66eb446aa4 2407:ef226254ef46
1 ================== 1 ==================
2 Installing Roundup 2 Installing Roundup
3 ================== 3 ==================
4 4
5 :Version: $Revision: 1.76 $ 5 :Version: 1.76
6 6
7 .. contents:: 7 .. contents::
8 8
9 9
10 Overview 10 Overview
47 Non-Python2.3 users may need to `install the "CSV" module`_. 47 Non-Python2.3 users may need to `install the "CSV" module`_.
48 48
49 Install the "CSV" module 49 Install the "CSV" module
50 ------------------------ 50 ------------------------
51 51
52 Note: CSV stands for Comma-Separated-Value. These files are used by all 52 .. hint::
53 manner of programs (eg. spreadsheets) to exchange data. 53 CSV stands for Comma-Separated-Value. These files are used by all
54 manner of programs (eg. spreadsheets) to exchange data.
54 55
55 The "CSV" module is required if you wish to import or export data in the 56 The "CSV" module is required if you wish to import or export data in the
56 tracker, or if you wish to use the online generic class editing facility. 57 tracker, or if you wish to use the online generic class editing facility.
57 58
58 If you're using a version of Python older than 2.3, then you will need to 59 If you're using a version of Python older than 2.3, then you will need to
113 114
114 115
115 Installation 116 Installation
116 ============ 117 ============
117 118
118 :Note: Some systems, such as Debian and NetBSD, already have Roundup 119 .. note::
119 installed. Try running the command "roundup-admin" with no arguments, 120 Some systems, such as Debian and NetBSD, already have Roundup
120 and if it runs you may skip the `Basic Installation Steps`_ 121 installed. Try running the command "roundup-admin" with no arguments,
121 below and go straight to `configuring your first tracker`_. 122 and if it runs you may skip the `Basic Installation Steps`_
123 below and go straight to `configuring your first tracker`_.
122 124
123 Set aside 15-30 minutes. Please make sure you're using a supported version of 125 Set aside 15-30 minutes. Please make sure you're using a supported version of
124 Python -- see `testing your python`_. There's several steps to follow in your 126 Python -- see `testing your python`_. There's several steps to follow in your
125 installation: 127 installation:
126 128
193 is going to be used as the directory that the tracker information 195 is going to be used as the directory that the tracker information
194 will be stored in. 196 will be stored in.
195 197
196 You will now be directed to edit the tracker configuration and 198 You will now be directed to edit the tracker configuration and
197 initial schema. At a minimum, you must set ``MAILHOST``, 199 initial schema. At a minimum, you must set ``MAILHOST``,
198 ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. Note that the 200 ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. The
199 configuration file uses Python syntax, so almost every value must be 201 configuration file uses Python syntax, so almost every value must be
200 ``'quoted'`` using single or double quotes. If you get stuck, and get 202 ``'quoted'`` using single or double quotes. If you get stuck, and get
201 configuration file errors, then see the `tracker configuration`_ section 203 configuration file errors, then see the `tracker configuration`_ section
202 of the `customisation documentation`_. 204 of the `customisation documentation`_.
203 205
207 209
208 TRACKER_WEB = 'http://localhost:8080/support/' 210 TRACKER_WEB = 'http://localhost:8080/support/'
209 211
210 The URL *must* end in a '/', or your web interface *will not work*. 212 The URL *must* end in a '/', or your web interface *will not work*.
211 See `Customising Roundup`_ for details on configuration and schema 213 See `Customising Roundup`_ for details on configuration and schema
212 changes. Note that you may change any of the configuration after 214 changes. You may change any of the configuration after
213 you've initialised the tracker - it's just better to have valid values 215 you've initialised the tracker - it's just better to have valid values
214 for this stuff now. 216 for this stuff now.
215 217
216 d. Initialise the tracker database with ``roundup-admin initialise``. 218 d. Initialise the tracker database with ``roundup-admin initialise``.
217 You will need to supply an admin password at this step. You will be 219 You will need to supply an admin password at this step. You will be
310 312
311 A benefit of using the cgi-bin approach is that it's the easiest way to 313 A benefit of using the cgi-bin approach is that it's the easiest way to
312 restrict access to your tracker to only use HTTPS. Access will be slower 314 restrict access to your tracker to only use HTTPS. Access will be slower
313 than through the `stand-alone web server`_ though. 315 than through the `stand-alone web server`_ though.
314 316
315 Note that if your Python isn't install as "python" then you'll need to edit 317 If your Python isn't install as "python" then you'll need to edit
316 the ``roundup.cgi`` script to fix the first line. 318 the ``roundup.cgi`` script to fix the first line.
317 319
318 If you're using IIS on a Windows platform, you'll need to run this command 320 If you're using IIS on a Windows platform, you'll need to run this command
319 for the cgi to work (it turns on the PATH_INFO cgi variable):: 321 for the cgi to work (it turns on the PATH_INFO cgi variable)::
320 322
Roundup Issue Tracker: http://roundup-tracker.org/