Mercurial > p > roundup > code

comparison doc/installation.txt @ 1850:6e80f8f760a4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
*** empty log message ***
author Richard Jones <richard@users.sourceforge.net>
date Fri, 17 Oct 2003 01:53:11 +0000
parents 3c6dd167a744
children 3ffb7b56172a
comparison
equal deleted inserted replaced
1847:6889824fcdf9 1850:6e80f8f760a4
1 ================== 1 ==================
2 Installing Roundup 2 Installing Roundup
3 ================== 3 ==================
4 4
5 :Version: $Revision: 1.60 $ 5 :Version: $Revision: 1.61 $
6 6
7 .. contents:: 7 .. contents::
8 8
9 9
10 Overview 10 Overview
29 29
30 30
31 Prerequisites 31 Prerequisites
32 ============= 32 =============
33 33
34 Python 2.1.1 or newer with a functioning anydbm or bsddb module. Download the 34 Python 2.1.3 or newer with a functioning anydbm or bsddb module. Download the
35 latest version from http://www.python.org/. It is highly recommended that 35 latest version from http://www.python.org/. It is highly recommended that
36 users install the latest patch version of python - 2.1.3 or 2.2.3 - as these 36 users install the latest patch version of python - 2.1.3, 2.2.3 or 2.3.2 -
37 contain many fixes to serious bugs. Python 2.3 (currently in beta) has some 37 as these contain many fixes to serious bugs.
38 "issues", at least with the SQLite backend, and possibly with other backends
39 as well. It shouldn't be used with Roundup for now.
40 38
41 If you want to use Berkeley DB bsddb3 with Roundup, use version 3.3.0 or 39 If you want to use Berkeley DB bsddb3 with Roundup, use version 3.3.0 or
42 later. Download the latest version from http://pybsddb.sourceforge.net/. 40 later. Download the latest version from http://pybsddb.sourceforge.net/.
43 41
44 If you're on windows, you will either need to be using the ActiveState python 42 If you're on windows, you will either need to be using the ActiveState python
54 52
55 Testing your Python 53 Testing your Python
56 ------------------- 54 -------------------
57 55
58 Once you've unpacked roundup's source, run ``python ./run_tests`` in the 56 Once you've unpacked roundup's source, run ``python ./run_tests`` in the
59 source directory and make sure there are no errors. 57 source directory and make sure there are no errors. If there are errors,
60 If there are errors, please let us know! 58 please let us know!
61 59
62 If the above fails, you may be using the wrong version of python. Try 60 If the above fails, you may be using the wrong version of python. Try
63 ``python2 ./run_tests``. If that works, you will need to substitute 61 ``python2 ./run_tests``. If that works, you will need to substitute
64 ``python2`` for ``python`` in all further commands you use in relation to 62 ``python2`` for ``python`` in all further commands you use in relation to
65 Roundup -- from installation and scripts. 63 Roundup -- from installation and scripts.
80 78
81 79
82 Installation 80 Installation
83 ============ 81 ============
84 82
85 Note: some systems, such as Debian and NetBSD, already have Roundup 83 :Note: Some systems, such as Debian and NetBSD, already have Roundup
86 installed. Try running the command "roundup-admin" with no arguments, 84 installed. Try running the command "roundup-admin" with no arguments,
87 and if it runs you may skip the `Basic Installation Steps`_ 85 and if it runs you may skip the `Basic Installation Steps`_
88 below. 86 below and go straight to `configuring your first tracker`_.
89 87
90 Set aside 15-30 minutes. Please make sure you're using a supported version of 88 Set aside 15-30 minutes. Please make sure you're using a supported version of
91 Python -- see `testing your python`_. There's several steps to follow in your 89 Python -- see `testing your python`_. There's several steps to follow in your
92 installation: 90 installation:
93 91
242 There are no limitations, and it's much faster and more scaleable than the 240 There are no limitations, and it's much faster and more scaleable than the
243 dbm backends. 241 dbm backends.
244 **mysql** 242 **mysql**
245 Backend for popular RDBMS MySQL. According to benchmarks, this backend works 243 Backend for popular RDBMS MySQL. According to benchmarks, this backend works
246 much faster than any of \*dbm ones, but slightly slower than metakit and 244 much faster than any of \*dbm ones, but slightly slower than metakit and
247 sqlite. Scalability is unknown at present. Roundup requires InnoDB or BDB 245 sqlite. A good scalability is not a property of this backend for now,
248 support in MySQL. For more info on requirements and installation see 246 though. For more info on backend installation see doc/mysql.txt.
249 `additional mysql documentation`_ (doc/mysql.txt)
250 **metakit** 247 **metakit**
251 This backend is implemented over the metakit_ storage system, using Mk4Py as 248 This backend is implemented over the metakit_ storage system, using Mk4Py as
252 the interface. It scales much better than the dbm backends. 249 the interface. It scales much better than the dbm backends.
253 250
254 You should be wary of using all but the mysql backend with high-volume trackers 251 You should be wary of using all but the mysql backend with high-volume trackers
324 the script to change the TRACKER_HOMES variable or you may supply the 321 the script to change the TRACKER_HOMES variable or you may supply the
325 name=home values on the command-line after all the other options. 322 name=home values on the command-line after all the other options.
326 323
327 To make the server run in the background, use the "-d" option, specifying the 324 To make the server run in the background, use the "-d" option, specifying the
328 name of a file to write the server process id (pid) to. 325 name of a file to write the server process id (pid) to.
329
330 To run the server proxied through apache (to take advantage of SSL or other
331 apache features), use the following configuration lines::
332
333 LoadModule proxy_module libexec/apache2/mod_proxy.so
334 LoadModule proxy_connect_module libexec/apache2/mod_proxy_connect.so
335 LoadModule proxy_http_module libexec/apache2/mod_proxy_http.so
336
337 <Location /prometheus/>
338 ProxyPass http://192.168.1.2:9090/roundup/
339 AuthType Basic
340 AuthName Roundup
341 AuthUserFile /some/place/htpasswd
342 Require valid-user
343 </Location>
344
345 Changing the ProxyPass line to point to the server you're running.
346 326
347 327
348 Zope Product - ZRoundup 328 Zope Product - ZRoundup
349 ~~~~~~~~~~~~~~~~~~~~~~~ 329 ~~~~~~~~~~~~~~~~~~~~~~~
350 330
583 .. _`customising roundup`: customizing.html 563 .. _`customising roundup`: customizing.html
584 .. _`upgrading document`: upgrading.html 564 .. _`upgrading document`: upgrading.html
585 .. _`maintenance documentation`: maintenance.html 565 .. _`maintenance documentation`: maintenance.html
586 .. _sqlite: http://www.hwaci.com/sw/sqlite/ 566 .. _sqlite: http://www.hwaci.com/sw/sqlite/
587 .. _metakit: http://www.equi4.com/metakit/ 567 .. _metakit: http://www.equi4.com/metakit/
588 .. _`additional mysql documentation`: doc/mysql.html 568
589
Roundup Issue Tracker: http://roundup-tracker.org/