Mercurial > p > roundup > code
annotate doc/installation.txt @ 3646:3a9a6b98c6e6
note about where to run demo.py from
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 04 Aug 2006 22:34:33 +0000 |
| parents | bef78d81b79c |
| children | d4112ddfc0bb |
| rev | line source |
|---|---|
|
688
b38f4f95bffd
More doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
686
diff
changeset
|
1 ================== |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
2 Installing Roundup |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
3 ================== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
4 |
| 2409 | 5 :Version: 1.76 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
6 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
7 .. contents:: |
| 2409 | 8 :depth: 2 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
10 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
11 Overview |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
12 ======== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
13 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
14 Broken out separately, there are several conceptual pieces to a |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
15 Roundup installation: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
16 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
17 Roundup trackers |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
18 Trackers consist of issues (be they bug reports or otherwise), tracker |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
19 configuration file(s), web HTML files etc. Roundup trackers are initialised |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
20 with a "Template" which defines the fields usable/assignable on a |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
21 per-issue basis. Descriptions of the provided templates are given in |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
22 `choosing your template`_. |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
23 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
24 Roundup support code |
|
3297
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
25 Installed into your Python install's lib directory. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
26 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
27 Roundup scripts |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
28 These include the email gateway, the roundup |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
29 HTTP server, the roundup administration command-line interface, etc. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
30 |
|
1218
4c9882cb16a3
more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
1170
diff
changeset
|
31 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
32 Prerequisites |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
33 ============= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
34 |
|
3153
fdcba2ef2673
missed in checkin
Richard Jones <richard@users.sourceforge.net>
parents:
3004
diff
changeset
|
35 Roundup requires Python 2.3 or newer with a functioning anydbm |
|
2818
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
36 module. Download the latest version from http://www.python.org/. |
|
1965
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
37 It is highly recommended that users install the latest patch version |
|
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
38 of python as these contain many fixes to serious bugs. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
39 |
|
3421
0d9406d14186
MySQL now creates String columns using the TEXT column type
Richard Jones <richard@users.sourceforge.net>
parents:
3417
diff
changeset
|
40 Some variants of Linux will need an additional "python dev" package |
|
0d9406d14186
MySQL now creates String columns using the TEXT column type
Richard Jones <richard@users.sourceforge.net>
parents:
3417
diff
changeset
|
41 installed for Roundup installation to work. Debian and derivatives, are |
|
0d9406d14186
MySQL now creates String columns using the TEXT column type
Richard Jones <richard@users.sourceforge.net>
parents:
3417
diff
changeset
|
42 known to require this. |
|
0d9406d14186
MySQL now creates String columns using the TEXT column type
Richard Jones <richard@users.sourceforge.net>
parents:
3417
diff
changeset
|
43 |
|
1300
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
44 If you're on windows, you will either need to be using the ActiveState python |
|
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
45 distribution (at http://www.activestate.com/Products/ActivePython/), or you'll |
|
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
46 have to install the win32all package separately (get it from |
|
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
47 http://starship.python.net/crew/mhammond/win32/). |
|
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
48 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
49 |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
50 Optional Components |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
51 =================== |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
52 |
|
3297
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
53 You may optionally install and use: |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
54 |
|
3623
bef78d81b79c
added optional prerequisite: pytz
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3571
diff
changeset
|
55 Timezone Definitions |
|
bef78d81b79c
added optional prerequisite: pytz
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3571
diff
changeset
|
56 Full timezone support requires pytz_ module which brings the |
|
bef78d81b79c
added optional prerequisite: pytz
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3571
diff
changeset
|
57 `Olson tz database`_ into Python. If pytz_ is not installed, |
|
bef78d81b79c
added optional prerequisite: pytz
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3571
diff
changeset
|
58 timezones may be specified as numeric hour offsets only. |
|
bef78d81b79c
added optional prerequisite: pytz
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3571
diff
changeset
|
59 |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
60 An RDBMS |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
61 Sqlite, MySQL and Postgresql are all supported by Roundup and will be |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
62 used if available. One of these is recommended if you are anticipating a |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
63 large user base (see `choosing your backend`_ below). |
|
3297
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
64 |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
65 Xapian full-text indexer |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
66 The Xapian_ full-text indexer is also supported and will be used by |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
67 default if it is available. This is strongly recommended if you are |
|
3417
07c696890f55
mailgw subject parsing has configurable levels of strictness
Richard Jones <richard@users.sourceforge.net>
parents:
3405
diff
changeset
|
68 anticipating a large number of issues (> 5000). |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
69 |
|
3297
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
70 You may install Xapian at any time, even after a tracker has been |
|
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
71 installed and used. You will need to run the "roundup-admin reindex" |
|
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
72 command if the tracker has existing data. |
|
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
73 |
|
3485
8d55b5db6365
xapian works, if you poke it enough
Richard Jones <richard@users.sourceforge.net>
parents:
3447
diff
changeset
|
74 Roundup requires Xapian *newer* than 0.9.2 - it may be necessary for |
|
8d55b5db6365
xapian works, if you poke it enough
Richard Jones <richard@users.sourceforge.net>
parents:
3447
diff
changeset
|
75 you to install a snapshot. Snapshot "0.9.2_svn6532" has been tried |
|
8d55b5db6365
xapian works, if you poke it enough
Richard Jones <richard@users.sourceforge.net>
parents:
3447
diff
changeset
|
76 successfully. |
|
8d55b5db6365
xapian works, if you poke it enough
Richard Jones <richard@users.sourceforge.net>
parents:
3447
diff
changeset
|
77 |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
78 .. _Xapian: http://www.xapian.org/ |
|
3623
bef78d81b79c
added optional prerequisite: pytz
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3571
diff
changeset
|
79 .. _pytz: http://pytz.sourceforge.net/ |
|
bef78d81b79c
added optional prerequisite: pytz
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3571
diff
changeset
|
80 .. _Olson tz database: http://www.twinsun.com/tz/tz-link.htm |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
81 |
|
3297
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
82 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
83 Getting Roundup |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
84 =============== |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
85 |
|
2742
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
86 .. note:: |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
87 Some systems, such as Debian and NetBSD, already have Roundup |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
88 installed. Try running the command "roundup-admin" with no arguments, |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
89 and if it runs you may skip the `Basic Installation Steps`_ |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
90 below and go straight to `configuring your first tracker`_. |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
91 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
92 Download the latest version from http://roundup.sf.net/. |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
93 |
|
2216
759ed26e24dd
help for winzip users
Richard Jones <richard@users.sourceforge.net>
parents:
2211
diff
changeset
|
94 If you're using WinZIP's "classic" interface, make sure the "Use |
|
759ed26e24dd
help for winzip users
Richard Jones <richard@users.sourceforge.net>
parents:
2211
diff
changeset
|
95 folder names" check box is checked before you extract the files. |
|
759ed26e24dd
help for winzip users
Richard Jones <richard@users.sourceforge.net>
parents:
2211
diff
changeset
|
96 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
97 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
98 For The Really Impatient |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
99 ======================== |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
100 |
|
3153
fdcba2ef2673
missed in checkin
Richard Jones <richard@users.sourceforge.net>
parents:
3004
diff
changeset
|
101 If you just want to give Roundup a whirl Right Now, then simply run |
|
3646
3a9a6b98c6e6
note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents:
3623
diff
changeset
|
102 ``python demo.py`` in the *source* directory (not the *installed* |
|
3a9a6b98c6e6
note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents:
3623
diff
changeset
|
103 directory). If you used the Windows installer, you should run the |
|
3153
fdcba2ef2673
missed in checkin
Richard Jones <richard@users.sourceforge.net>
parents:
3004
diff
changeset
|
104 ``roundup-demo`` program instead. Users of other binary distributions or |
|
fdcba2ef2673
missed in checkin
Richard Jones <richard@users.sourceforge.net>
parents:
3004
diff
changeset
|
105 pre-installed Roundup will need to download the source to use it. |
| 2401 | 106 |
|
3571
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
107 This will set up a simple demo tracker on your machine. [1]_ |
|
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
108 When it's done, it'll print out a URL to point your web browser at |
|
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
109 so you may start playing. Three users will be set up: |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
110 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
111 1. anonymous - the "default" user with permission to do very little |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
112 2. demo (password "demo") - a normal user who may create issues |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
113 3. admin (password "admin") - an administrative user who has complete |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
114 access to the tracker |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
115 |
|
3571
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
116 .. [1] Demo tracker is set up to be accessed by localhost browser. |
|
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
117 If you run demo on a server host, please stop the demo when |
|
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
118 it has shown startup notice, open file ``demo/config.ini`` with |
|
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
119 your editor, change host name in the ``web`` option in section |
|
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
120 ``[tracker]``, save the file, then re-run the demo program. |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
121 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
122 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
123 ============ |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
124 |
|
2991
b9a55628a78d
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
2988
diff
changeset
|
125 Set aside 15-30 minutes. There's several steps to follow in your |
| 1228 | 126 installation: |
| 1049 | 127 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
128 1. `basic installation steps`_ if Roundup is not installed on your system |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
129 2. `configuring your first tracker`_ that all installers must follow |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
130 3. then optionally `configure a web interface`_ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
131 4. and optionally `configure an email interface`_ |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
132 5. `UNIX environment steps`_ to take if you're installing on a shared |
|
1240
606522be902a
merged fix from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
133 UNIX machine and want to restrict local access to roundup |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
134 6. `additional language codecs`_ |
| 1049 | 135 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
136 For information about how Roundup installs, see the `administration |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
137 guide`_. |
|
1965
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
138 |
| 1049 | 139 |
| 140 Basic Installation Steps | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
141 ------------------------ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
142 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
143 To install the Roundup support code into your Python tree and |
| 3524 | 144 Roundup scripts into /usr/bin (substitute that path for whatever is |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
145 appropriate on your system). You need to have write permissions |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
146 for these locations, eg. being root on unix:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
147 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
148 python setup.py install |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
149 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
150 If you would like to place the Roundup scripts in a directory other |
| 3524 | 151 than ``/usr/bin``, then specify the preferred location with |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
152 ``--install-script``. For example, to install them in |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
153 ``/opt/roundup/bin``:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
154 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
155 python setup.py install --install-scripts=/opt/roundup/bin |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
156 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
157 You can also use the ``--prefix`` option to use a completely different |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
158 base directory, if you do not want to use administrator rights. If you |
|
2449
706031763266
clarification
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
159 choose to do this, you may have to change Python's search path (sys.path) |
|
706031763266
clarification
Richard Jones <richard@users.sourceforge.net>
parents:
2409
diff
changeset
|
160 yourself. |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1245
diff
changeset
|
161 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
162 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
163 Configuring your first tracker |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
164 ------------------------------ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
165 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
166 1. To create a Roundup tracker (necessary to do before you can |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
167 use the software in any real fashion), you need to set up a "tracker |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
168 home": |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
169 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
170 a. (Optional) If you intend to keep your roundup trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
171 under one top level directory which does not exist yet, |
| 1228 | 172 you should create that directory now. Example:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
173 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
174 mkdir /opt/roundup/trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
175 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
176 b. Either add the Roundup script location to your ``PATH`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
177 environment variable or specify the full path to |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
178 the command in the next step. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
179 |
| 1228 | 180 c. Install a new tracker with the command ``roundup-admin install``. |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
181 You will be asked a series of questions. Descriptions of the provided |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
182 templates can be found in `choosing your template`_ below. Descriptions |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
183 of the available backends can be found in `choosing your backend`_ |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
184 below. The questions will be something like (you may have more |
| 1228 | 185 templates or backends available):: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
186 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
187 Enter tracker home: /opt/roundup/trackers/support |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
188 Templates: classic |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
189 Select template [classic]: classic |
|
2818
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
190 Back ends: anydbm, mysql, sqlite |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
191 Select backend [anydbm]: anydbm |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
192 |
|
2818
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
193 Note: "Back ends" selection list depends on availability of |
|
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
194 third-party database modules. Standard python distribution |
|
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
195 includes anydbm module only. |
|
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
196 |
|
1571
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
197 The "support" part of the tracker name can be anything you want - it |
|
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
198 is going to be used as the directory that the tracker information |
|
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
199 will be stored in. |
|
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
200 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
201 You will now be directed to edit the tracker configuration and |
|
3303
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
202 initial schema. At a minimum, you must set "main :: admin_email" |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
203 (that's the "admin_email" option in the "main" section) "mail :: |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
204 host", "tracker :: web" and "mail :: domain". If you get stuck, |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
205 and get configuration file errors, then see the `tracker |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
206 configuration`_ section of the `customisation documentation`_. |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
207 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
208 If you just want to get set up to test things quickly (and follow |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
209 the instructions in step 3 below), you can even just set the |
|
3303
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
210 "tracker :: web" variable to:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
211 |
|
3303
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
212 web = http://localhost:8080/support/ |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
213 |
|
1310
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
214 The URL *must* end in a '/', or your web interface *will not work*. |
|
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
215 See `Customising Roundup`_ for details on configuration and schema |
| 2409 | 216 changes. You may change any of the configuration after |
|
1310
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
217 you've initialised the tracker - it's just better to have valid values |
|
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
218 for this stuff now. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
219 |
| 1228 | 220 d. Initialise the tracker database with ``roundup-admin initialise``. |
| 221 You will need to supply an admin password at this step. You will be | |
| 222 prompted:: | |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
223 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
224 Admin Password: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
225 Confirm: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
226 |
| 2401 | 227 Note: running this command will *destroy any existing data in the |
| 228 database*. In the case of MySQL and PostgreSQL, any exsting database | |
| 229 will be dropped and re-created. | |
| 230 | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
231 Once this is done, the tracker has been created. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
232 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
233 2. At this point, your tracker is set up, but doesn't have a nice user |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
234 interface. To set that up, we need to `configure a web interface`_ and |
|
1316
dd43853684d4
don't undersell the roundup-server
Richard Jones <richard@users.sourceforge.net>
parents:
1310
diff
changeset
|
235 optionally `configure an email interface`_. If you want to try your |
|
3303
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
236 new tracker out, assuming "tracker :: web" is set to |
|
1316
dd43853684d4
don't undersell the roundup-server
Richard Jones <richard@users.sourceforge.net>
parents:
1310
diff
changeset
|
237 ``'http://localhost:8080/support/'``, run:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
238 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
239 roundup-server support=/opt/roundup/trackers/support |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
240 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
241 then direct your web browser at: |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
242 |
|
1845
3c6dd167a744
Fix typo in server address [SF#822967].
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1839
diff
changeset
|
243 http://localhost:8080/support/ |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
244 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
245 and you should see the tracker interface. |
| 1049 | 246 |
| 247 | |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
248 Choosing Your Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
249 ---------------------- |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
250 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
251 Classic Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
252 ~~~~~~~~~~~~~~~~ |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
253 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
254 The classic template is the one defined in the `Roundup Specification`_. It |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
255 holds issues which have priorities and statuses. Each issue may also have a |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
256 set of messages which are disseminated to the issue's list of nosy users. |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
257 |
|
1227
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
258 Minimal Template |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
259 ~~~~~~~~~~~~~~~~ |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
260 |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
261 The minimal template has the minimum setup required for a tracker |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
262 installation. That is, it has the configuration files, defines a user database |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
263 and the basic HTML interface to that. It's a completely clean slate for you to |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
264 create your tracker on. |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
265 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
266 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
267 Choosing Your Backend |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
268 --------------------- |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
269 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
270 The actual storage of Roundup tracker information is handled by backends. |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
271 There's several to choose from, each with benefits and limitations: |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
272 |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
273 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
274 Name Speed Users Support |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
275 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
276 anydbm Slowest Few Always available |
|
2238
df0444e39bc3
more useful pysqlite link
Richard Jones <richard@users.sourceforge.net>
parents:
2216
diff
changeset
|
277 sqlite Fastest(*) Few Needs install (PySQLite_) |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
278 metakit Fastest(*) Few Needs install (metakit_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
279 postgresql Fast Many Needs install/admin (psycopg_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
280 mysql Fast Many Needs install/admin (MySQLdb_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
281 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
282 |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
283 **sqlite** and **metakit** |
|
2238
df0444e39bc3
more useful pysqlite link
Richard Jones <richard@users.sourceforge.net>
parents:
2216
diff
changeset
|
284 These use the embedded database engines PySQLite_ and metakit_ to provide |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
285 very fast backends. They are not suitable for trackers which will have |
|
2818
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
286 many simultaneous users, but require much less installation and |
|
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
287 maintenance effort than more scalable postgresql and mysql backends. |
|
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
288 If you are choosing from these two, please select sqlite. |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
289 **postgresql** |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
290 Backend for popular RDBMS PostgreSQL. You must read doc/postgresql.txt for |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2818
diff
changeset
|
291 additional installation steps and requirements. You must also configure |
|
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2818
diff
changeset
|
292 the ``rdbms`` section of your tracker's ``config.ini`` |
|
1507
3481507d6098
Advertising mysql
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1317
diff
changeset
|
293 **mysql** |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
294 Backend for popular RDBMS MySQL. You must read doc/mysql.txt for additional |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2818
diff
changeset
|
295 installation steps and requirements. You must also configure the ``rdbms`` |
|
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2818
diff
changeset
|
296 section of your tracker's ``config.ini`` |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
297 |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
298 You may defer your decision by setting your tracker up with the anydbm |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
299 backend (which is guaranteed to be available) and switching to one of the |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
300 other backends at any time using the instructions in the `administration |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
301 guide`_. |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
302 |
| 2401 | 303 Regardless of which backend you choose, Roundup will attempt to initialise |
| 304 a new database for you when you run the roundup-admin "initialise" command. | |
| 305 In the case of MySQL and PostgreSQL you will need to have the appropriate | |
| 306 privileges to create databases. | |
| 307 | |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
308 |
| 1228 | 309 Configure a Web Interface |
| 310 ------------------------- | |
| 311 | |
| 312 There are three web interfaces to choose from: | |
| 313 | |
| 314 1. `web server cgi-bin`_ | |
| 315 2. `stand-alone web server`_ | |
| 316 3. `Zope product - ZRoundup`_ | |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
317 4. `Apache HTTP Server with mod_python`_ |
| 1228 | 318 |
| 319 You may need to give the web server user permission to access the tracker home | |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
320 - see the `UNIX environment steps`_ for information. You may also need to |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
321 configure your system in some way - see `platform-specific notes`_. |
| 1228 | 322 |
| 323 | |
| 324 Web Server cgi-bin | |
| 325 ~~~~~~~~~~~~~~~~~~ | |
| 326 | |
| 327 A benefit of using the cgi-bin approach is that it's the easiest way to | |
| 328 restrict access to your tracker to only use HTTPS. Access will be slower | |
| 329 than through the `stand-alone web server`_ though. | |
| 330 | |
| 2409 | 331 If your Python isn't install as "python" then you'll need to edit |
|
1748
0f2678eeeac6
cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents:
1747
diff
changeset
|
332 the ``roundup.cgi`` script to fix the first line. |
|
0f2678eeeac6
cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents:
1747
diff
changeset
|
333 |
|
1540
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
334 If you're using IIS on a Windows platform, you'll need to run this command |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
335 for the cgi to work (it turns on the PATH_INFO cgi variable):: |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
336 |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
337 adsutil.vbs set w3svc/AllowPathInfoForScriptMappings TRUE |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
338 |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
339 The ``adsutil.vbs`` file can be found in either ``c:\inetpub\adminscripts`` |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
340 or ``c:\winnt\system32\inetsrv\adminsamples\`` or |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
341 ``c:\winnt\system32\inetsrv\adminscripts\`` depending on your installation. |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
342 |
|
2988
f4023f1cc1d6
apply IE caching "fix" to automatically serve up all pages expired
Richard Jones <richard@users.sourceforge.net>
parents:
2979
diff
changeset
|
343 More information about ISS setup may be found at: |
|
f4023f1cc1d6
apply IE caching "fix" to automatically serve up all pages expired
Richard Jones <richard@users.sourceforge.net>
parents:
2979
diff
changeset
|
344 |
|
f4023f1cc1d6
apply IE caching "fix" to automatically serve up all pages expired
Richard Jones <richard@users.sourceforge.net>
parents:
2979
diff
changeset
|
345 http://support.microsoft.com/default.aspx?scid=kb%3Ben-us%3B276494 |
|
f4023f1cc1d6
apply IE caching "fix" to automatically serve up all pages expired
Richard Jones <richard@users.sourceforge.net>
parents:
2979
diff
changeset
|
346 |
| 1228 | 347 Copy the ``cgi-bin/roundup.cgi`` file to your web server's ``cgi-bin`` |
| 348 directory. You will need to configure it to tell it where your tracker home | |
| 349 is. You can do this either: | |
| 350 | |
|
3303
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
351 Through an environment variable |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
352 Set the variable TRACKER_HOMES to be a colon (":") separated list of |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
353 name=home pairs (if you're using apache, the SetEnv directive can do this) |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
354 |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
355 Directly in the ``roundup.cgi`` file itself |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
356 Add your instance to the TRACKER_HOMES variable as ``'name': 'home'`` |
| 1228 | 357 |
| 358 The "name" part of the configuration will appear in the URL and identifies the | |
| 359 tracker (so you may have more than one tracker per cgi-bin script). Make sure | |
| 360 there are no spaces or other illegal characters in it (to be safe, stick to | |
| 361 letters and numbers). The "name" forms part of the URL that appears in the | |
|
3303
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
362 tracker config "tracker :: web" variable, so make sure they match. The "home" |
| 1228 | 363 part of the configuration is the tracker home directory. |
| 364 | |
|
2665
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
365 If you're using Apache, you can use an additional trick to hide the |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
366 ``.cgi`` extension of the cgi script. Place the ``roundup.cgi`` script |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
367 wherever you want it to be, renamed it to just ``roundup``, and add a |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
368 couple lines to your Apache configuration:: |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
369 |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
370 <Location /path/to/roundup> |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
371 SetHandler cgi-script |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
372 </Location> |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
373 |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
374 |
| 1228 | 375 Stand-alone Web Server |
| 376 ~~~~~~~~~~~~~~~~~~~~~~ | |
| 377 | |
| 378 This approach will give you the fastest of the three web interfaces. You may | |
| 379 investigate using ProxyPass or similar configuration in apache to have your | |
| 380 tracker accessed through the same URL as other systems. | |
| 381 | |
| 382 The stand-alone web server is started with the command ``roundup-server``. It | |
| 383 has several options - display them with ``roundup-server -h``. | |
| 384 | |
| 385 The tracker home configuration is similar to the cgi-bin - you may either edit | |
| 386 the script to change the TRACKER_HOMES variable or you may supply the | |
| 387 name=home values on the command-line after all the other options. | |
| 388 | |
| 389 To make the server run in the background, use the "-d" option, specifying the | |
| 390 name of a file to write the server process id (pid) to. | |
| 391 | |
| 392 | |
| 393 Zope Product - ZRoundup | |
| 394 ~~~~~~~~~~~~~~~~~~~~~~~ | |
| 395 | |
| 396 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to | |
| 397 your Products directory either in INSTANCE_HOME/Products or the Zope | |
| 398 code tree lib/python/Products. | |
| 399 | |
| 400 When you next (re)start up Zope, you will be able to add a ZRoundup object | |
| 401 that interfaces to your new tracker. | |
| 402 | |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
403 Apache HTTP Server with mod_python |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
404 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
405 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
406 `Mod_python`_ is an `Apache`_ module that embeds the Python interpreter |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
407 within the server. Running Roundup this way is much faster than all |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
408 above options and, like `web server cgi-bin`_, allows to use HTTPS |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
409 protocol. The drawback is that this setup is more complicated. |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
410 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
411 The following instructions were tested on apache 2.0 with mod_python 3.1. |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
412 If you are using older versions, your mileage may vary. |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
413 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
414 Mod_python uses OS threads. If your apache was built without threads |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
415 (quite commonly), you must load the threading library to run mod_python. |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
416 This is done by setting ``LD_PRELOAD`` to your threading library path |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
417 in apache ``envvars`` file. Example for gentoo linux (``envvars`` file |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
418 is located in ``/usr/lib/apache2/build/``):: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
419 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
420 LD_PRELOAD=/lib/libpthread.so.0 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
421 export LD_PRELOAD |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
422 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
423 Example for FreeBSD (``envvars`` is in ``/usr/local/sbin/``):: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
424 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
425 LD_PRELOAD=/usr/lib/libc_r.so |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
426 export LD_PRELOAD |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
427 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
428 Next, you have to add Roundup trackers configuration to apache config. |
|
2559
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
429 Roundup apache interface uses two options specified with ``PythonOption`` |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
430 directives: |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
431 |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
432 TrackerHome: |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
433 defines the tracker home directory - the directory that was specified |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
434 when you did ``roundup-admin init``. This option is required. |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
435 |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
436 TrackerLaguage: |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
437 defines web user interface language. mod_python applications do not |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
438 receive OS environment variables in the same way as command-line |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
439 programs, so the language cannot be selected by setting commonly |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
440 used variables like ``LANG`` or ``LC_ALL``. ``TrackerLanguage`` |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
441 value has the same syntax as values of these environment variables. |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
442 This option may be omitted. |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
443 |
|
2945
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
444 TrackerDebug: |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
445 run the tracker in debug mode. Setting this option to ``yes`` or |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
446 ``true`` has the same effect as running ``roundup-server -t debug``: |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
447 the database schema and used html templates are rebuilt for each |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
448 HTTP request. Values ``no`` or ``false`` mean that all html |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
449 templates for the tracker are compiled and the database schema is |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
450 checked once at startup. This is the default behaviour. |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
451 |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
452 TrackerTiming: |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
453 has nearly the same effect as environment variable ``CGI_SHOW_TIMING`` |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
454 for standalone roundup server. The difference is that setting this |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
455 option to ``no`` or ``false`` disables timings display. Value |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
456 ``comment`` writes request handling times in html comment, and |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
457 any other non-empty value makes timing report visible. By default, |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
458 timing display is disabled. |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
459 |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
460 In the following example we have two trackers set up in |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
461 ``/var/db/roundup/support`` and ``var/db/roundup/devel`` and accessed |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
462 as ``https://my.host/roundup/support/`` and ``https://my.host/roundup/devel/`` |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
463 respectively. Having them share same parent directory allows us to |
|
2559
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
464 reduce the number of configuration directives. Support tracker has |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
465 russian user interface. The other tracker (devel) has english user |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
466 interface (default). |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
467 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
468 Static files from ``html`` directory are served by apache itself - this |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
469 is quickier and generally more robust than doing that from python. |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
470 Everything else is aliased to dummy (non-existing) ``py`` file, |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
471 which is handled by mod_python and our roundup module. |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
472 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
473 Example mod_python configuration:: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
474 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
475 ################################################# |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
476 # Roundup Issue tracker |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
477 ################################################# |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
478 # enable Python optimizations (like 'python -O') |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
479 PythonOptimize On |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
480 # let apache handle static files from 'html' directories |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
481 AliasMatch /roundup/(.+)/@@file/(.*) /var/db/roundup/$1/html/$2 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
482 # everything else is handled by roundup web UI |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
483 AliasMatch /roundup/([^/]+)/(?!@@file/)(.*) /var/db/roundup/$1/dummy.py/$2 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
484 # roundup requires a slash after tracker name - add it if missing |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
485 RedirectMatch permanent /roundup/([^/]+)$ /roundup/$1/ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
486 # common settings for all roundup trackers |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
487 <Directory /var/db/roundup/*> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
488 Order allow,deny |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
489 Allow from all |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
490 AllowOverride None |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
491 Options None |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
492 AddHandler python-program .py |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
493 PythonHandler roundup.cgi.apache |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
494 # uncomment the following line to see tracebacks in the browser |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
495 # (note that *some* tracebacks will be displayed anyway) |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
496 #PythonDebug On |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
497 </Directory> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
498 # roundup tracker homes |
|
2559
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
499 <Directory /var/db/roundup/support> |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
500 PythonOption TrackerHome /var/db/roundup/support |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
501 PythonOption TrackerLanguage ru |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
502 </Directory> |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
503 <Directory /var/db/roundup/devel> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
504 PythonOption TrackerHome /var/db/roundup/devel |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
505 </Directory> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
506 |
| 1228 | 507 |
| 508 Configure an Email Interface | |
| 509 ---------------------------- | |
| 510 | |
| 511 If you don't want to use the email component of Roundup, then remove the | |
|
1514
c706e55896d8
minor doc bug
Richard Jones <richard@users.sourceforge.net>
parents:
1507
diff
changeset
|
512 "``nosyreaction.py``" module from your tracker "``detectors``" directory. |
| 1228 | 513 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
514 See `platform-specific notes`_ for steps that may be needed on your system. |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
515 |
| 1228 | 516 There are three supported ways to get emailed issues into the |
| 517 Roundup tracker. You should pick ONE of the following, all | |
| 518 of which will continue my example setup from above: | |
| 519 | |
| 520 As a mail alias pipe process | |
| 521 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 522 | |
| 523 Set up a mail alias called "issue_tracker" as (include the quote marks): | |
| 3524 | 524 "``|/usr/bin/python /usr/bin/roundup-mailgw <tracker_home>``" |
| 525 (substitute ``/usr/bin`` for wherever roundup-mailgw is installed). | |
| 1228 | 526 |
| 527 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh so | |
| 528 sendmail will accept the pipe command. In that case, symlink | |
| 3524 | 529 ``/etc/smrsh/roundup-mailgw`` to "``/usr/bin/roundup-mailgw``" and change |
| 1228 | 530 the command to:: |
| 531 | |
| 532 |roundup-mailgw /opt/roundup/trackers/support | |
| 533 | |
| 534 To test the mail gateway on unix systems, try:: | |
| 535 | |
| 536 echo test |mail -s '[issue] test' support@YOUR_DOMAIN_HERE | |
| 537 | |
|
3447
83e358352e6e
minor correction to recent addition by Faheem Mitha
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3446
diff
changeset
|
538 As a custom router/transport using a pipe process (Exim4 specific) |
|
3444
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
540 |
|
3446
2325b221bf47
link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3444
diff
changeset
|
541 The following configuration snippets for `Exim 4`_ configuration |
|
3444
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
542 implement a custom router & transport to accomplish mail delivery to |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
543 roundup-mailgw. A configuration for Exim3 is similar but not |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
544 included, since Exim3 is considered obsolete. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
545 |
|
3446
2325b221bf47
link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3444
diff
changeset
|
546 .. _Exim 4: http://www.exim.org/ |
|
2325b221bf47
link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3444
diff
changeset
|
547 |
|
3444
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
548 This configuration is similar to the previous section, in that it uses |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
549 a pipe process. However, there are advantages to using a custom |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
550 router/transport process, if you are using Exim. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
551 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
552 * This avoids privilege escalation, since otherwise the pipe process |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
553 will run as the mail user, typically mail. The transport can be |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
554 configured to run as the user appropriate for the task at hand. In the |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
555 transport described in this section, Exim4 runs as the unprivileged |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
556 user ``roundup``. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
557 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
558 * Separate configuration is not required for each tracker |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
559 instance. When a email arrives at the server, Exim passes it through |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
560 the defined routers. The roundup_router looks for a match with one of |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
561 the roundup directories, and if there is one it is passed to the |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
562 roundup_transport, which uses the pipe process described in the |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
563 previous section (`As a mail alias pipe process`_). |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
564 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
565 The matching is done in the line:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
566 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
567 require_files = /usr/bin/roundup-mailgw:ROUNDUP_HOME/$local_part/schema.py |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
568 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
569 The following configuration has been tested on Debian Sarge with |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
570 Exim4. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
571 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
572 .. note:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
573 Note that the Debian Exim4 packages don't allow pipes in alias files |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
574 by default, so the method described in the section `As a mail alias |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
575 pipe process`_ will not work with the default configuration. However, |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
576 the method described in this section does. See the discussion in |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
577 ``/usr/share/doc/exim4-config/README.system_aliases`` on any Debian |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
578 system with Exim4 installed. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
579 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
580 For more Debian-specific information, see suggested addition to |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
581 README.Debian in |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
582 http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=343283, which will |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
583 hopefully be merged into the Debian package eventually. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
584 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
585 This config makes a few assumptions: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
586 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
587 * That the mail address corresponding to the tracker instance has the |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
588 same name as the directory of the tracker instance, i.e. the mail |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
589 interface address corresponding to a Roundup instance called |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
590 ``/var/lib/roundup/trackers/mytracker`` is ``mytracker@your.host``. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
591 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
592 * That (at least) all the db subdirectories of all the tracker |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
593 instances (ie. ``/var/lib/roundup/trackers/*/db``) are owned by the same |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
594 user, in this case, 'roundup'. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
595 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
596 * That if the ``schema.py`` file exists, then the tracker is ready for |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
597 use. Another option is to use the ``config.ini`` file, but this recently |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
598 changed (in 0.8) from ``config.py``. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
599 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
600 Macros for Roundup router/transport. Should be placed in the macros |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
601 section of the Exim4 config:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
602 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
603 # Home dir for your Roundup installation |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
604 ROUNDUP_HOME=/var/lib/roundup/trackers |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
605 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
606 # User and group for Roundup. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
607 ROUNDUP_USER=roundup |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
608 ROUNDUP_GROUP=roundup |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
609 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
610 Custom router for Roundup. This will (probably) work if placed at the |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
611 beginning of the router section of the Exim4 config:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
612 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
613 roundup_router: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
614 driver = accept |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
615 # The config file config.ini seems like a more natural choice, but the |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
616 # file config.py was replaced by config.ini in 0.8, and schema.py needs |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
617 # to be present too. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
618 require_files = /usr/bin/roundup-mailgw:ROUNDUP_HOME/$local_part/schema.py |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
619 transport = roundup_transport |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
620 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
621 Custom transport for Roundup. This will (probably) work if placed at |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
622 the beginning of the router section of the Exim4 config:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
623 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
624 roundup_transport: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
625 driver = pipe |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
626 command = /usr/bin/python /usr/bin/roundup-mailgw ROUNDUP_HOME/$local_part/ |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
627 current_directory = ROUNDUP_HOME |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
628 home_directory = ROUNDUP_HOME |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
629 user = ROUNDUP_USER |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
630 group = ROUNDUP_GROUP |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
631 |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
632 As a regular job using a mailbox source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
633 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 634 |
|
3405
292fbed108ca
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3335
diff
changeset
|
635 Set ``roundup-mailgw`` up to run every 10 minutes or so. For example |
| 3524 | 636 (substitute ``/usr/bin`` for wherever roundup-mailgw is installed):: |
| 1228 | 637 |
| 3524 | 638 0,10,20,30,40,50 * * * * /usr/bin/roundup-mailgw /opt/roundup/trackers/support mailbox <mail_spool_file> |
| 1228 | 639 |
| 640 Where the ``mail_spool_file`` argument is the location of the roundup submission | |
| 641 user's mail spool. On most systems, the spool for a user "issue_tracker" | |
| 642 will be "``/var/mail/issue_tracker``". | |
| 643 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
644 As a regular job using a POP source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
645 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 646 |
|
3405
292fbed108ca
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3335
diff
changeset
|
647 To retrieve from a POP mailbox, use a *cron* entry similar to the mailbox |
| 3524 | 648 one (substitute ``/usr/bin`` for wherever roundup-mailgw is |
|
3405
292fbed108ca
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3335
diff
changeset
|
649 installed):: |
| 1228 | 650 |
| 3524 | 651 0,10,20,30,40,50 * * * * /usr/bin/roundup-mailgw /opt/roundup/trackers/support pop <pop_spec> |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
652 |
| 1228 | 653 where pop_spec is "``username:password@server``" that specifies the roundup |
| 654 submission user's POP account name, password and server. | |
| 655 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
656 On windows, you would set up the command using the windows scheduler. |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
657 |
|
2211
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
658 As a regular job using an IMAP source |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
659 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
660 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
661 To retrieve from an IMAP mailbox, use a *cron* entry similar to the |
| 3524 | 662 POP one (substitute ``/usr/bin`` for wherever roundup-mailgw is |
|
3405
292fbed108ca
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3335
diff
changeset
|
663 installed):: |
|
2211
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
664 |
| 3524 | 665 0,10,20,30,40,50 * * * * /usr/bin/roundup-mailgw /opt/roundup/trackers/support imap <imap_spec> |
|
2211
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
666 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
667 where imap_spec is "``username:password@server``" that specifies the roundup |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
668 submission user's IMAP account name, password and server. You may |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
669 optionally include a mailbox to use other than the default ``INBOX`` with |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
670 "``imap username:password@server mailbox``". |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
671 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
672 If you have a secure (ie. HTTPS) IMAP server then you may use ``imaps`` |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
673 in place of ``imap`` in the command to use a secure connection. |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
674 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
675 As with the POP job, on windows, you would set up the command using the |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
676 windows scheduler. |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
677 |
| 1228 | 678 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
679 UNIX Environment Steps |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
680 ---------------------- |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
681 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
682 Each tracker ideally should have its own UNIX group, so create |
| 1049 | 683 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if |
| 684 you're using NIS). To continue with my examples so far, I would | |
| 685 create the UNIX group 'support', although the name of the UNIX | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
686 group does not have to be the same as the tracker name. To this |
| 1049 | 687 'support' group I then add all of the UNIX usernames who will be |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
688 working with this Roundup tracker. In addition to 'real' users, |
| 1049 | 689 the Roundup email gateway will need to have permissions to this |
| 690 area as well, so add the user your mail service runs as to the | |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
691 group (typically "mail" or "daemon"). The UNIX group might then |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
692 look like:: |
| 1049 | 693 |
| 694 support:*:1002:jblaine,samh,geezer,mail | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
695 |
| 1049 | 696 If you intend to use the web interface (as most people do), you |
| 697 should also add the username your web server runs as to the group. | |
| 698 My group now looks like this:: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
699 |
| 1049 | 700 support:*:1002:jblaine,samh,geezer,mail,apache |
| 701 | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
702 The tracker "db" directory should be chmod'ed g+sw so that the group can |
|
1078
344bad728d10
more tweakage of help display and style issues
Richard Jones <richard@users.sourceforge.net>
parents:
1049
diff
changeset
|
703 write to the database, and any new files created in the database will be owned |
|
344bad728d10
more tweakage of help display and style issues
Richard Jones <richard@users.sourceforge.net>
parents:
1049
diff
changeset
|
704 by the group. |
|
344bad728d10
more tweakage of help display and style issues
Richard Jones <richard@users.sourceforge.net>
parents:
1049
diff
changeset
|
705 |
|
2594
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
706 If you're using the mysql or postgresql backend then you'll need to ensure |
|
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
707 that the tracker user has appropriate permissions to create/modify the |
|
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
708 database. If you're using roundup.cgi, the apache user needs permissions |
|
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
709 to modify the database. Alternatively, explicitly specify a database login |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2818
diff
changeset
|
710 in ``rdbms`` -> ``user`` and ``password`` in ``config.ini``. |
|
2594
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
711 |
| 1049 | 712 An alternative to the above is to create a new user who has the sole |
| 713 responsibility of running roundup. This user: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
714 |
| 1049 | 715 1. runs the CGI interface daemon |
| 716 2. runs regular polls for email | |
| 717 3. runs regular checks (using cron) to ensure the daemon is up | |
| 718 4. optionally has no login password so that nobody but the "root" user | |
| 719 may actually login and play with the roundup setup. | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
720 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
721 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
722 Additional Language Codecs |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
723 -------------------------- |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
724 |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
725 If you intend to send messages to Roundup that use Chinese, Japanese or |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
726 Korean encodings the you'll need to obtain CJKCodecs from |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
727 http://cjkpython.berlios.de/ |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
728 |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
729 |
|
2069
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
730 |
| 1228 | 731 Maintenance |
| 732 =========== | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
733 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
734 Read the separate `administration guide`_ for information about how to |
| 1228 | 735 perform common maintenance tasks with Roundup. |
| 1049 | 736 |
|
782
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
737 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
738 Upgrading |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
739 ========= |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
740 |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
741 Read the separate `upgrading document`_, which describes the steps needed to |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
742 upgrade existing tracker trackers for each version of Roundup that is |
|
782
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
743 released. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
744 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
745 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
746 Further Reading |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
747 =============== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
748 |
|
3528
762d65fefea5
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3524
diff
changeset
|
749 If you intend to use Roundup with anything other than the default |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
750 templates, if you would like to hack on Roundup, or if you would |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
751 like implementation details, you should read `Customising Roundup`_. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
752 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
753 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
754 Running Multiple Trackers |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
755 ========================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
756 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
757 Things to think about before you jump off the deep end and install |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
758 multiple trackers, which involve additional URLs, user databases, email |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
759 addresses, databases to back up, etc. |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
760 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
761 1. Do you want a tracker per product you sell/support? You can just add |
|
2161
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
762 a new property to your issues called Product, and filter by that. See |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
763 the customisation example `adding a new field to the classic schema`_. |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
764 2. Do you want to track internal software development issues and customer |
|
2186
3f89c8ffe4f1
version info in scripts
Richard Jones <richard@users.sourceforge.net>
parents:
2179
diff
changeset
|
765 support issues separately? You can just set up an additional "issue" |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
766 class called "cust_issues" in the same tracker, mimicing the normal |
|
2161
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
767 "issue" class, but with different properties. See the customisation |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
768 example `tracking different types of issues`_. |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
769 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
770 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
771 Platform-Specific Notes |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
772 ======================= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
773 |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
774 Windows command-line tools |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
775 -------------------------- |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
776 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
777 To make the command-line tools accessible in Windows, you need to update |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
778 the "Path" environment variable in the Registry via a dialog box. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
779 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
780 On Windows 2000 and later: |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
781 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
782 1) Press the "Start" button. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
783 2) Choose "Settings" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
784 3) Choose "Control Panel" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
785 4) Choose "System" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
786 5) Choose "Advanced" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
787 6) Choose "Environmental Variables" |
|
1746
9c1da921cd35
minor rest tweak
Richard Jones <richard@users.sourceforge.net>
parents:
1688
diff
changeset
|
788 7) Add: "<dir>\Scripts" to the "Path" environmental variable. |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
789 |
| 1747 | 790 Where <dir> in 7) is the root directory (e.g., ``C:\Python22\Scripts``) |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
791 of your Python installation. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
792 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
793 I understand that in XP, 2) above is not needed as "Control |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
794 Panel" is directly accessible from "Start". |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
795 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
796 I do not believe this is possible to do in previous versions of Windows. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
797 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
798 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
799 Windows Server |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
800 -------------- |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
801 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
802 To have the Roundup web server start up when your machine boots up, set the |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
803 following up in Scheduled Tasks (note, the following is for a cygwin setup): |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
804 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
805 Run |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
806 ``c:\cygwin\bin\bash.exe -c "roundup-server TheProject=/opt/roundup/trackers/support"`` |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
807 Start In |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
808 ``C:\cygwin\opt\roundup\bin`` |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
809 Schedule |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
810 At System Startup |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
811 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
812 To have the Roundup mail gateway run periodically to poll a POP email address, |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
813 set the following up in Scheduled Tasks: |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1576
diff
changeset
|
814 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
815 Run |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
816 ``c:\cygwin\bin\bash.exe -c "roundup-mailgw /opt/roundup/trackers/support pop roundup:roundup@mail-server"`` |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
817 Start In |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
818 ``C:\cygwin\opt\roundup\bin`` |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
819 Schedule |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
820 Every 10 minutes from 5:00AM for 24 hours every day |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
821 Stop the task if it runs for 8 minutes |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
822 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
823 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
824 Sendmail smrsh |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
825 -------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
826 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
827 If you use Sendmail's ``smrsh`` mechanism, you will need to tell |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
828 smrsh that roundup-mailgw is a valid/trusted mail handler |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
829 before it will work. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
830 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
831 This is usually done via the following 2 steps: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
832 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
833 1. make a symlink in ``/etc/smrsh`` called ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
834 which points to the full path of your actual ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
835 script. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
836 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
837 2. change your alias to ``"|roundup-mailgw <tracker_home>"`` |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
838 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
839 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
840 Linux |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
841 ----- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
842 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
843 Make sure you read the instructions under `UNIX environment steps`_. |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
844 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
845 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
846 Solaris |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
847 ------- |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
848 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
849 You'll need to build Python. |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
850 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
851 Make sure you read the instructions under `UNIX environment steps`_. |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
852 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
853 |
|
2972
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
854 Problems? Testing your Python... |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
855 ================================ |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
856 |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
857 .. note:: |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
858 The ``run_tests.py`` script is packaged in Roundup's source distribution |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
859 - users of the Windows installer, other binary distributions or |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
860 pre-installed Roundup will need to download the source to use it. |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
861 |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
862 Once you've unpacked roundup's source, run ``python run_tests.py`` in the |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
863 source directory and make sure there are no errors. If there are errors, |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
864 please let us know! |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
865 |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
866 If the above fails, you may be using the wrong version of python. Try |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
867 ``python2 run_tests.py``. If that works, you will need to substitute |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
868 ``python2`` for ``python`` in all further commands you use in relation to |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
869 Roundup -- from installation and scripts. |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
870 |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
871 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
872 ------------------------------------------------------------------------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
873 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
874 Back to `Table of Contents`_ |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
875 |
|
1287
5402a6f2a754
Added quotes around python interpreter in windows bat [SF#623963]
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
876 Next: `User Guide`_ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
877 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
878 .. _`table of contents`: index.html |
|
1287
5402a6f2a754
Added quotes around python interpreter in windows bat [SF#623963]
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
879 .. _`user guide`: user_guide.html |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
880 .. _`roundup specification`: spec.html |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
881 .. _`tracker configuration`: customizing.html#tracker-configuration |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
882 .. _`customisation documentation`: customizing.html |
|
2161
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
883 .. _`Adding a new field to the classic schema`: |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
884 customizing.html#adding-a-new-field-to-the-classic-schema |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
885 .. _`Tracking different types of issues`: |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
886 customizing.html#tracking-different-types-of-issues |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
887 .. _`customising roundup`: customizing.html |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
888 .. _`upgrading document`: upgrading.html |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
889 .. _`administration guide`: admin_guide.html |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
890 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
891 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
892 .. _External hyperlink targets: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
893 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
894 .. _apache: http://httpd.apache.org/ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
895 .. _metakit: http://www.equi4.com/metakit/ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
896 .. _mod_python: http://www.modpython.org/ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
897 .. _MySQLdb: http://sourceforge.net/projects/mysql-python |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
898 .. _Psycopg: http://initd.org/software/initd/psycopg |
|
3335
e996f3584772
fix PySQLite site URL
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3303
diff
changeset
|
899 .. _pysqlite: http://pysqlite.org/ |