Mercurial > p > roundup > code

comparison doc/installation.txt @ 2409:096063697f77

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
merge
author Richard Jones <richard@users.sourceforge.net>
date Wed, 09 Jun 2004 00:25:32 +0000
parents a405124c3847
children 706031763266
comparison
equal deleted inserted replaced
2405:1736886eefb3 2409:096063697f77
1 ================== 1 ==================
2 Installing Roundup 2 Installing Roundup
3 ================== 3 ==================
4 4
5 :Version: $Revision: 1.77 $ 5 :Version: 1.76
6 6
7 .. contents:: 7 .. contents::
8 :depth: 2
8 9
9 10
10 Overview 11 Overview
11 ======== 12 ========
12 13
47 Non-Python2.3 users may need to `install the "CSV" module`_. 48 Non-Python2.3 users may need to `install the "CSV" module`_.
48 49
49 Install the "CSV" module 50 Install the "CSV" module
50 ------------------------ 51 ------------------------
51 52
52 Note: CSV stands for Comma-Separated-Value. These files are used by all 53 .. hint::
53 manner of programs (eg. spreadsheets) to exchange data. 54 CSV stands for Comma-Separated-Value. These files are used by all
55 manner of programs (eg. spreadsheets) to exchange data.
54 56
55 The "CSV" module is required if you wish to import or export data in the 57 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. 58 tracker, or if you wish to use the online generic class editing facility.
57 59
58 If you're using a version of Python older than 2.3, then you will need to 60 If you're using a version of Python older than 2.3, then you will need to
86 folder names" check box is checked before you extract the files. 88 folder names" check box is checked before you extract the files.
87 89
88 Testing your Python 90 Testing your Python
89 ------------------- 91 -------------------
90 92
91 Note: user of the Windows installer may not run these tests. 93 .. note::
94 The Windows installer doesn't include the ``run_tests.py`` or ``demo.py``
95 scripts - you will need to download the source to use them.
92 96
93 Once you've unpacked roundup's source, run ``python run_tests.py`` in the 97 Once you've unpacked roundup's source, run ``python run_tests.py`` in the
94 source directory and make sure there are no errors. If there are errors, 98 source directory and make sure there are no errors. If there are errors,
95 please let us know! 99 please let us know!
96 100
117 121
118 122
119 Installation 123 Installation
120 ============ 124 ============
121 125
122 :Note: Some systems, such as Debian and NetBSD, already have Roundup 126 .. note::
123 installed. Try running the command "roundup-admin" with no arguments, 127 Some systems, such as Debian and NetBSD, already have Roundup
124 and if it runs you may skip the `Basic Installation Steps`_ 128 installed. Try running the command "roundup-admin" with no arguments,
125 below and go straight to `configuring your first tracker`_. 129 and if it runs you may skip the `Basic Installation Steps`_
130 below and go straight to `configuring your first tracker`_.
126 131
127 Set aside 15-30 minutes. Please make sure you're using a supported version of 132 Set aside 15-30 minutes. Please make sure you're using a supported version of
128 Python -- see `testing your python`_. There's several steps to follow in your 133 Python -- see `testing your python`_. There's several steps to follow in your
129 installation: 134 installation:
130 135
197 is going to be used as the directory that the tracker information 202 is going to be used as the directory that the tracker information
198 will be stored in. 203 will be stored in.
199 204
200 You will now be directed to edit the tracker configuration and 205 You will now be directed to edit the tracker configuration and
201 initial schema. At a minimum, you must set ``MAILHOST``, 206 initial schema. At a minimum, you must set ``MAILHOST``,
202 ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. Note that the 207 ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. The
203 configuration file uses Python syntax, so almost every value must be 208 configuration file uses Python syntax, so almost every value must be
204 ``'quoted'`` using single or double quotes. If you get stuck, and get 209 ``'quoted'`` using single or double quotes. If you get stuck, and get
205 configuration file errors, then see the `tracker configuration`_ section 210 configuration file errors, then see the `tracker configuration`_ section
206 of the `customisation documentation`_. 211 of the `customisation documentation`_.
207 212
211 216
212 TRACKER_WEB = 'http://localhost:8080/support/' 217 TRACKER_WEB = 'http://localhost:8080/support/'
213 218
214 The URL *must* end in a '/', or your web interface *will not work*. 219 The URL *must* end in a '/', or your web interface *will not work*.
215 See `Customising Roundup`_ for details on configuration and schema 220 See `Customising Roundup`_ for details on configuration and schema
216 changes. Note that you may change any of the configuration after 221 changes. You may change any of the configuration after
217 you've initialised the tracker - it's just better to have valid values 222 you've initialised the tracker - it's just better to have valid values
218 for this stuff now. 223 for this stuff now.
219 224
220 d. Initialise the tracker database with ``roundup-admin initialise``. 225 d. Initialise the tracker database with ``roundup-admin initialise``.
221 You will need to supply an admin password at this step. You will be 226 You will need to supply an admin password at this step. You will be
323 328
324 A benefit of using the cgi-bin approach is that it's the easiest way to 329 A benefit of using the cgi-bin approach is that it's the easiest way to
325 restrict access to your tracker to only use HTTPS. Access will be slower 330 restrict access to your tracker to only use HTTPS. Access will be slower
326 than through the `stand-alone web server`_ though. 331 than through the `stand-alone web server`_ though.
327 332
328 Note that if your Python isn't install as "python" then you'll need to edit 333 If your Python isn't install as "python" then you'll need to edit
329 the ``roundup.cgi`` script to fix the first line. 334 the ``roundup.cgi`` script to fix the first line.
330 335
331 If you're using IIS on a Windows platform, you'll need to run this command 336 If you're using IIS on a Windows platform, you'll need to run this command
332 for the cgi to work (it turns on the PATH_INFO cgi variable):: 337 for the cgi to work (it turns on the PATH_INFO cgi variable)::
333 338
Roundup Issue Tracker: http://roundup-tracker.org/