Mercurial > p > roundup > code
annotate doc/installation.txt @ 5548:fea11d05110e
Avoid errors from selecting "no selection" on multilink (issue2550722).
As discussed in issue 2550722 there are various cases where selecting
"no selection" on a multilink can result in inappropriate errors from
Roundup:
* If selecting "no selection" produces a null edit (a value was set in
the multilink in an edit with an error, then removed again, along
with all other changes, in the next form submission), so the page is
rendered from the form contents including the "-<id>" value for "no
selection" for the multilink.
* If creating an item with a nonempty value for a multilink has an
error, and the resubmission changes that multilink to "no selection"
(and this in turn has subcases, according to whether the creation
then succeeds or fails on the resubmission, which need fixes in
different places in the Roundup code).
All of these cases have in common that it is expected and OK to have a
"-<id>" value for a submission for a multilink when <id> is not set in
that multilink in the database (because the original attempt to set
<id> in that multilink had an error), so the hyperdb.py logic to give
an error in that case is thus removed. In the subcase of the second
case where the resubmission with "no selection" has an error, the
templating code tries to produce a menu entry for the "-<id>"
multilink value, which also results in an error, hence the
templating.py change to ignore such values in the list for a
multilink.
| author | Joseph Myers <jsm@polyomino.org.uk> |
|---|---|
| date | Thu, 27 Sep 2018 11:33:01 +0000 |
| parents | df3f553fa414 |
| children | 0df5f9eeefd4 |
| 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 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
5 .. contents:: |
| 2409 | 6 :depth: 2 |
|
4890
609edf9de0a5
docs: Remove one nesting level from ToC on subpages
anatoly techtonik <techtonik@gmail.com>
parents:
4792
diff
changeset
|
7 :local: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
8 |
|
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 Overview |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
11 ======== |
|
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 Broken out separately, there are several conceptual pieces to a |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
14 Roundup installation: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
15 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
16 Roundup trackers |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
17 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
|
18 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
|
19 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
|
20 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
|
21 `choosing your template`_. |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
22 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
23 Roundup support code |
|
3297
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
24 Installed into your Python install's lib directory. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
25 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
26 Roundup scripts |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
27 These include the email gateway, the roundup |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
28 HTTP server, the roundup administration command-line interface, etc. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
29 |
|
1218
4c9882cb16a3
more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
1170
diff
changeset
|
30 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
31 Prerequisites |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
32 ============= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
33 |
|
5526
df3f553fa414
Update documentation for Python 3 support (issue 2550968, issue 2550980).
Joseph Myers <jsm@polyomino.org.uk>
parents:
5510
diff
changeset
|
34 Roundup requires Python 2.7 or 3.4 or newer with a functioning |
|
4226
d0a3ac73b4c1
clarify python version
Richard Jones <richard@users.sourceforge.net>
parents:
4036
diff
changeset
|
35 anydbm 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
|
36 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
|
37 of python as these contain many fixes to serious bugs. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
38 |
|
3421
0d9406d14186
MySQL now creates String columns using the TEXT column type
Richard Jones <richard@users.sourceforge.net>
parents:
3417
diff
changeset
|
39 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
|
40 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
|
41 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
|
42 |
|
5140
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
43 If you are using the Roundup Windows installer on a 64 bit system and |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
44 you get the error message:: |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
45 |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
46 "No Python installation found in the registry" |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
47 |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
48 you need to install a 32 bit version of python. The 64 bit versions |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
49 use a different registry key that the installer doesn't detect. See: |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
50 http://issues.roundup-tracker.org/issue2550718 for details. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
51 |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
52 Optional Components |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
53 =================== |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
54 |
|
3297
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
55 You may optionally install and use: |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
56 |
|
3623
bef78d81b79c
added optional prerequisite: pytz
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3571
diff
changeset
|
57 Timezone Definitions |
|
3731
e6ef9abfe403
fix pytz requirement version and download URL for latest package
Richard Jones <richard@users.sourceforge.net>
parents:
3730
diff
changeset
|
58 Full timezone support requires pytz_ module (version 2005i or later) |
|
3730
8e3b881060b4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3729
diff
changeset
|
59 which brings the `Olson tz database`_ into Python. If pytz_ is not |
|
8e3b881060b4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3729
diff
changeset
|
60 installed, timezones may be specified as numeric hour offsets only. |
|
5140
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
61 This is optional but strongly suggested. |
|
5321
4566360871dc
Raises python requirement to 2.7.
Bernhard Reiter <bernhard@intevation.de>
parents:
5300
diff
changeset
|
62 |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
63 An RDBMS |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
64 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
|
65 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
|
66 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
|
67 |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
68 Xapian full-text indexer |
|
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
69 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
|
70 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
|
71 anticipating a large number of issues (> 5000). |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
72 |
|
3297
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
73 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
|
74 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
|
75 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
|
76 |
|
4378
477f2a47cbca
- Indexer Xapian, made Xapian 1.2 compatible.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4355
diff
changeset
|
77 Roundup requires Xapian 1.0.0 or newer. |
|
3485
8d55b5db6365
xapian works, if you poke it enough
Richard Jones <richard@users.sourceforge.net>
parents:
3447
diff
changeset
|
78 |
|
5108
67fad01d2009
issue2550653: xapian search, stemming is not working
John Rouillard <rouilj@ieee.org>
parents:
5096
diff
changeset
|
79 Note that capitalization is not preserved by the Xapian search. |
|
67fad01d2009
issue2550653: xapian search, stemming is not working
John Rouillard <rouilj@ieee.org>
parents:
5096
diff
changeset
|
80 This is required to make the porter stemmer work so that searching |
|
67fad01d2009
issue2550653: xapian search, stemming is not working
John Rouillard <rouilj@ieee.org>
parents:
5096
diff
changeset
|
81 for silent also returns documents with the word silently. Note that |
|
67fad01d2009
issue2550653: xapian search, stemming is not working
John Rouillard <rouilj@ieee.org>
parents:
5096
diff
changeset
|
82 the current stemming implementation is designed for English. |
|
67fad01d2009
issue2550653: xapian search, stemming is not working
John Rouillard <rouilj@ieee.org>
parents:
5096
diff
changeset
|
83 |
|
5096
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
84 Whoosh full-text indexer |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
85 The Whoosh_ full-text indexer is also supported and will be used by |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
86 default if it is available (and Xapian is not installed). This is |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
87 recommended if you are anticipating a large number of issues (> 5000). |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
88 |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
89 You may install Whoosh at any time, even after a tracker has been |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
90 installed and used. You will need to run the "roundup-admin reindex" |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
91 command if the tracker has existing data. |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
92 |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
93 Roundup was tested with Whoosh 2.5.7, but earlier versions in the |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
94 2.0 series may work. Whoosh is a pure python indexer so it is slower |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
95 than Xapian, but should be useful for moderately sized trackers. |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
96 It uses the StandardAnalyzer which is suited for Western languages. |
|
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
97 |
|
3885
d4163100f4f3
add pyopenssl to optional components
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3830
diff
changeset
|
98 pyopenssl |
|
d4163100f4f3
add pyopenssl to optional components
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3830
diff
changeset
|
99 If pyopenssl_ is installed the roundup-server can be configured |
|
d4163100f4f3
add pyopenssl to optional components
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3830
diff
changeset
|
100 to serve trackers over SSL. If you are going to serve roundup via |
|
d4163100f4f3
add pyopenssl to optional components
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3830
diff
changeset
|
101 proxy through a server with SSL support (e.g. apache) then this is |
|
d4163100f4f3
add pyopenssl to optional components
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3830
diff
changeset
|
102 unnecessary. |
|
d4163100f4f3
add pyopenssl to optional components
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3830
diff
changeset
|
103 |
|
5494
b7fa56ced601
use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents:
5486
diff
changeset
|
104 gpg |
|
b7fa56ced601
use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents:
5486
diff
changeset
|
105 If gpg_ is installed you can configure the mail gateway to perform |
|
3922
586679a314f7
role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3885
diff
changeset
|
106 verification or decryption of incoming OpenPGP MIME messages. When |
|
586679a314f7
role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3885
diff
changeset
|
107 configured, you can require email to be cryptographically signed |
|
586679a314f7
role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3885
diff
changeset
|
108 before roundup will allow it to make modifications to issues. |
|
586679a314f7
role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3885
diff
changeset
|
109 |
|
5013
c1443d96ac94
jinja2: optional requirement added to installation.txt and link to wiki page.
Bernhard Reiter <bernhard@intevation.de>
parents:
4949
diff
changeset
|
110 jinja2 |
|
c1443d96ac94
jinja2: optional requirement added to installation.txt and link to wiki page.
Bernhard Reiter <bernhard@intevation.de>
parents:
4949
diff
changeset
|
111 To use the jinja2 template (may still be experimental, check out |
|
c1443d96ac94
jinja2: optional requirement added to installation.txt and link to wiki page.
Bernhard Reiter <bernhard@intevation.de>
parents:
4949
diff
changeset
|
112 its TEMPLATE-INFO.txt file) you need |
|
c1443d96ac94
jinja2: optional requirement added to installation.txt and link to wiki page.
Bernhard Reiter <bernhard@intevation.de>
parents:
4949
diff
changeset
|
113 to have the jinja2_ template engine installed. |
|
c1443d96ac94
jinja2: optional requirement added to installation.txt and link to wiki page.
Bernhard Reiter <bernhard@intevation.de>
parents:
4949
diff
changeset
|
114 |
|
4686
4e740f02e165
Remove pywin32 installation dependency by porting portalocker.py to ctypes.
anatoly techtonik <techtonik@gmail.com>
parents:
4672
diff
changeset
|
115 Windows Service |
|
4e740f02e165
Remove pywin32 installation dependency by porting portalocker.py to ctypes.
anatoly techtonik <techtonik@gmail.com>
parents:
4672
diff
changeset
|
116 You can run Roundup as a Windows service if pywin32_ is installed. |
|
5140
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
117 Otherwise it must be started manually. |
|
4686
4e740f02e165
Remove pywin32 installation dependency by porting portalocker.py to ctypes.
anatoly techtonik <techtonik@gmail.com>
parents:
4672
diff
changeset
|
118 |
|
4378
477f2a47cbca
- Indexer Xapian, made Xapian 1.2 compatible.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4355
diff
changeset
|
119 .. _Xapian: http://xapian.org/ |
|
5096
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
120 .. _Whoosh: https://bitbucket.org/mchaput/whoosh/wiki/Home |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5321
diff
changeset
|
121 .. _pytz: https://pypi.org/project/pytz/ |
| 5367 | 122 .. _Olson tz database: https://www.iana.org/time-zones |
|
3885
d4163100f4f3
add pyopenssl to optional components
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3830
diff
changeset
|
123 .. _pyopenssl: http://pyopenssl.sourceforge.net |
|
5494
b7fa56ced601
use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents:
5486
diff
changeset
|
124 .. _gpg: https://www.gnupg.org/software/gpgme/index.html |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5321
diff
changeset
|
125 .. _pywin32: https://pypi.org/project/pywin32/ |
|
5013
c1443d96ac94
jinja2: optional requirement added to installation.txt and link to wiki page.
Bernhard Reiter <bernhard@intevation.de>
parents:
4949
diff
changeset
|
126 .. _jinja2: http://jinja.pocoo.org/ |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
127 |
|
3297
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
128 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
129 Getting Roundup |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
130 =============== |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
131 |
|
2742
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
132 .. note:: |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
133 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
|
134 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
|
135 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
|
136 below and go straight to `configuring your first tracker`_. |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
137 |
|
4510
bce9aaf19a3b
Updated the url to point to www.roundup-tracker.org in two places in the docs.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4378
diff
changeset
|
138 Download the latest version from http://www.roundup-tracker.org/. |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
139 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
140 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
|
141 ======================== |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
142 |
|
4688
80f9a1fbc0cc
doc: Remove WinZip tutorial and mention demo.py becoming 'roundup-demo'
anatoly techtonik <techtonik@gmail.com>
parents:
4686
diff
changeset
|
143 If you just want to give Roundup a whirl Right Now, then simply unpack |
|
80f9a1fbc0cc
doc: Remove WinZip tutorial and mention demo.py becoming 'roundup-demo'
anatoly techtonik <techtonik@gmail.com>
parents:
4686
diff
changeset
|
144 and run ``demo.py`` (it will be available as ``roundup-demo`` script |
|
80f9a1fbc0cc
doc: Remove WinZip tutorial and mention demo.py becoming 'roundup-demo'
anatoly techtonik <techtonik@gmail.com>
parents:
4686
diff
changeset
|
145 after installation). |
| 2401 | 146 |
|
3571
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
147 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
|
148 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
|
149 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
|
150 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
151 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
|
152 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
|
153 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
|
154 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
|
155 |
|
3571
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
156 .. [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
|
157 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
|
158 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
|
159 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
|
160 ``[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
|
161 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
162 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
163 ============ |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
164 |
|
2991
b9a55628a78d
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
2988
diff
changeset
|
165 Set aside 15-30 minutes. There's several steps to follow in your |
| 1228 | 166 installation: |
| 1049 | 167 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
168 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
|
169 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
|
170 3. then optionally `configure a web interface`_ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
171 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
|
172 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
|
173 UNIX machine and want to restrict local access to roundup |
| 1049 | 174 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
175 For information about how Roundup installs, see the `administration |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
176 guide`_. |
|
1965
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
177 |
|
5140
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
178 The following assumes that you are using the source distribution. If |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
179 you are using the Windows installer, run it with Administrator |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5138
diff
changeset
|
180 privileges so it can correctly update the registry. |
| 1049 | 181 |
| 182 Basic Installation Steps | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
183 ------------------------ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
184 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
185 To install the Roundup support code into your Python tree and |
| 3524 | 186 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
|
187 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
|
188 for these locations, eg. being root on unix:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
189 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
190 python setup.py install |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
191 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
192 If you would like to place the Roundup scripts in a directory other |
| 3524 | 193 than ``/usr/bin``, then specify the preferred location with |
|
3949
29dfb873b32e
Small documentation cleanup
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3935
diff
changeset
|
194 ``--install-scripts``. For example, to install them in |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
195 ``/opt/roundup/bin``:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
196 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
197 python setup.py install --install-scripts=/opt/roundup/bin |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
198 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
199 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
|
200 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
|
201 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
|
202 yourself. |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1245
diff
changeset
|
203 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
204 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
205 Configuring your first tracker |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
206 ------------------------------ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
207 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
208 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
|
209 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
|
210 home": |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
211 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
212 a. (Optional) If you intend to keep your roundup trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
213 under one top level directory which does not exist yet, |
| 1228 | 214 you should create that directory now. Example:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
215 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
216 mkdir /opt/roundup/trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
217 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
218 b. Either add the Roundup script location to your ``PATH`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
219 environment variable or specify the full path to |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
220 the command in the next step. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
221 |
| 1228 | 222 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
|
223 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
|
224 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
|
225 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
|
226 below. The questions will be something like (you may have more |
| 1228 | 227 templates or backends available):: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
228 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
229 Enter tracker home: /opt/roundup/trackers/support |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
230 Templates: classic |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
231 Select template [classic]: classic |
|
2818
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
232 Back ends: anydbm, mysql, sqlite |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
233 Select backend [anydbm]: anydbm |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
234 |
|
2818
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
235 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
|
236 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
|
237 includes anydbm module only. |
|
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
238 |
|
1571
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
239 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
|
240 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
|
241 will be stored in. |
|
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
242 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
243 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
|
244 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
|
245 (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
|
246 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
|
247 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
|
248 configuration`_ section of the `customisation documentation`_. |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
249 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
250 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
|
251 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
|
252 "tracker :: web" variable to:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
253 |
|
3303
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
254 web = http://localhost:8080/support/ |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
255 |
|
1310
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
256 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
|
257 See `Customising Roundup`_ for details on configuration and schema |
| 2409 | 258 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
|
259 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
|
260 for this stuff now. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
261 |
| 1228 | 262 d. Initialise the tracker database with ``roundup-admin initialise``. |
| 263 You will need to supply an admin password at this step. You will be | |
| 264 prompted:: | |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
265 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
266 Admin Password: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
267 Confirm: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
268 |
| 2401 | 269 Note: running this command will *destroy any existing data in the |
| 4355 | 270 database*. In the case of MySQL and PostgreSQL, any existing database |
| 2401 | 271 will be dropped and re-created. |
| 272 | |
|
4792
1a0cf0345465
issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents:
4688
diff
changeset
|
273 Once this is done, the tracker has been created. See the note in |
|
1a0cf0345465
issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents:
4688
diff
changeset
|
274 the user_guide on how to initialise a tracker without being |
|
1a0cf0345465
issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents:
4688
diff
changeset
|
275 prompted for the password or exposing the password on the command |
|
1a0cf0345465
issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents:
4688
diff
changeset
|
276 line. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
277 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
278 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
|
279 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
|
280 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
|
281 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
|
282 ``'http://localhost:8080/support/'``, run:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
283 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
284 roundup-server support=/opt/roundup/trackers/support |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
285 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
286 then direct your web browser at: |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
287 |
|
1845
3c6dd167a744
Fix typo in server address [SF#822967].
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1839
diff
changeset
|
288 http://localhost:8080/support/ |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
289 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
290 and you should see the tracker interface. |
| 1049 | 291 |
|
5138
c54720396f40
issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents:
5108
diff
changeset
|
292 To run your tracker on some interface other than 127.0.0.1 and port |
|
c54720396f40
issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents:
5108
diff
changeset
|
293 8080 (make sure you change the "tracker :: web" changes to match) use:: |
| 1049 | 294 |
|
5138
c54720396f40
issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents:
5108
diff
changeset
|
295 roundup-server -p 1080 -n 0.0.0.0 support=/opt/roundup/trackers/support |
|
c54720396f40
issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents:
5108
diff
changeset
|
296 |
|
c54720396f40
issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents:
5108
diff
changeset
|
297 to run the server at port 1080 and bind to all ip addresses on your system. |
|
c54720396f40
issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents:
5108
diff
changeset
|
298 Then direct your web browser to ``http://your_host_name:1080/support``. |
|
5321
4566360871dc
Raises python requirement to 2.7.
Bernhard Reiter <bernhard@intevation.de>
parents:
5300
diff
changeset
|
299 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
300 Choosing Your Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
301 ---------------------- |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
302 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
303 Classic Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
304 ~~~~~~~~~~~~~~~~ |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
305 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
306 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
|
307 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
|
308 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
|
309 |
|
1227
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
310 Minimal Template |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
311 ~~~~~~~~~~~~~~~~ |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
312 |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
313 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
|
314 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
|
315 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
|
316 create your tracker on. |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
317 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
318 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
319 Choosing Your Backend |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
320 --------------------- |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
321 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
322 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
|
323 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
|
324 |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
325 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
326 Name Speed Users Support |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
327 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
328 anydbm Slowest Few Always available |
|
3729
60d3865b3cb6
grammar R us
Richard Jones <richard@users.sourceforge.net>
parents:
3728
diff
changeset
|
329 sqlite Fastest(*) Few May need install (PySQLite_) |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
330 postgresql Fast Many Needs install/admin (psycopg_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
331 mysql Fast Many Needs install/admin (MySQLdb_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
332 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
333 |
|
3728
b476fef16ccc
fixed support for pysqlite2 (version 2.1.0 is the minimum version supported)
Richard Jones <richard@users.sourceforge.net>
parents:
3722
diff
changeset
|
334 **sqlite** |
|
3935
1dab48842cbd
Throwing up hands in resignation and finally deleting the metakit backend.
Richard Jones <richard@users.sourceforge.net>
parents:
3922
diff
changeset
|
335 This uses the embedded database engine PySQLite_ to provide a very fast |
|
1dab48842cbd
Throwing up hands in resignation and finally deleting the metakit backend.
Richard Jones <richard@users.sourceforge.net>
parents:
3922
diff
changeset
|
336 backend. This is not suitable for trackers which will have many |
|
1dab48842cbd
Throwing up hands in resignation and finally deleting the metakit backend.
Richard Jones <richard@users.sourceforge.net>
parents:
3922
diff
changeset
|
337 simultaneous users, but requires much less installation and maintenance |
|
1dab48842cbd
Throwing up hands in resignation and finally deleting the metakit backend.
Richard Jones <richard@users.sourceforge.net>
parents:
3922
diff
changeset
|
338 effort than more scalable postgresql and mysql backends. |
|
3728
b476fef16ccc
fixed support for pysqlite2 (version 2.1.0 is the minimum version supported)
Richard Jones <richard@users.sourceforge.net>
parents:
3722
diff
changeset
|
339 |
|
b476fef16ccc
fixed support for pysqlite2 (version 2.1.0 is the minimum version supported)
Richard Jones <richard@users.sourceforge.net>
parents:
3722
diff
changeset
|
340 SQLite is supported via PySQLite versions 1.1.7, 2.1.0 and sqlite3 (the last |
|
b476fef16ccc
fixed support for pysqlite2 (version 2.1.0 is the minimum version supported)
Richard Jones <richard@users.sourceforge.net>
parents:
3722
diff
changeset
|
341 being bundled with Python 2.5+) |
|
3794
f5ddd1639a15
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
342 |
|
f5ddd1639a15
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
343 Installed SQLite should be the latest version available (3.3.8 is known |
|
f5ddd1639a15
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
344 to work, 3.1.3 is known to have problems). |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
345 **postgresql** |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
346 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
|
347 additional installation steps and requirements. You must also configure |
|
3666
8304a1c1cc98
encourage use of latest psycopg
Richard Jones <richard@users.sourceforge.net>
parents:
3647
diff
changeset
|
348 the ``rdbms`` section of your tracker's ``config.ini``. It is recommended |
|
8304a1c1cc98
encourage use of latest psycopg
Richard Jones <richard@users.sourceforge.net>
parents:
3647
diff
changeset
|
349 that you use at least version 1.1.21 of psycopg. |
|
1507
3481507d6098
Advertising mysql
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1317
diff
changeset
|
350 **mysql** |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
351 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
|
352 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
|
353 section of your tracker's ``config.ini`` |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
354 |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
355 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
|
356 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
|
357 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
|
358 guide`_. |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
359 |
| 2401 | 360 Regardless of which backend you choose, Roundup will attempt to initialise |
| 361 a new database for you when you run the roundup-admin "initialise" command. | |
| 362 In the case of MySQL and PostgreSQL you will need to have the appropriate | |
| 363 privileges to create databases. | |
| 364 | |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
365 |
| 1228 | 366 Configure a Web Interface |
| 367 ------------------------- | |
| 368 | |
|
5486
a5edd6adff14
Change count of number of ways to run roundup to "multiple".
John Rouillard <rouilj@ieee.org>
parents:
5367
diff
changeset
|
369 There are multiple web interfaces to choose from: |
| 1228 | 370 |
| 371 1. `web server cgi-bin`_ | |
|
4324
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
372 2. `cgi-bin for limited-access hosting`_ |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
373 3. `stand-alone web server`_ |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
374 4. `Zope product - ZRoundup`_ |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
375 5. `Apache HTTP Server with mod_python`_ |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
376 6. `WSGI handler`_ |
| 1228 | 377 |
| 378 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
|
379 - 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
|
380 configure your system in some way - see `platform-specific notes`_. |
| 1228 | 381 |
| 382 | |
| 383 Web Server cgi-bin | |
| 384 ~~~~~~~~~~~~~~~~~~ | |
| 385 | |
| 386 A benefit of using the cgi-bin approach is that it's the easiest way to | |
| 387 restrict access to your tracker to only use HTTPS. Access will be slower | |
| 388 than through the `stand-alone web server`_ though. | |
| 389 | |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
390 If your Python isn't installed as "python" then you'll need to edit |
|
1748
0f2678eeeac6
cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents:
1747
diff
changeset
|
391 the ``roundup.cgi`` script to fix the first line. |
|
0f2678eeeac6
cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents:
1747
diff
changeset
|
392 |
|
1540
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
393 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
|
394 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
|
395 |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
396 adsutil.vbs set w3svc/AllowPathInfoForScriptMappings TRUE |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
397 |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
398 The ``adsutil.vbs`` file can be found in either ``c:\inetpub\adminscripts`` |
|
1540
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
399 or ``c:\winnt\system32\inetsrv\adminsamples\`` or |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
400 ``c:\winnt\system32\inetsrv\adminscripts\`` depending on your installation. |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
401 |
|
2988
f4023f1cc1d6
apply IE caching "fix" to automatically serve up all pages expired
Richard Jones <richard@users.sourceforge.net>
parents:
2979
diff
changeset
|
402 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
|
403 |
|
f4023f1cc1d6
apply IE caching "fix" to automatically serve up all pages expired
Richard Jones <richard@users.sourceforge.net>
parents:
2979
diff
changeset
|
404 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
|
405 |
|
3736
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
406 Copy the ``frontends/roundup.cgi`` file to your web server's ``cgi-bin`` |
| 1228 | 407 directory. You will need to configure it to tell it where your tracker home |
| 408 is. You can do this either: | |
| 409 | |
|
3303
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
410 Through an environment variable |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
411 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
|
412 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
|
413 |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
414 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
|
415 Add your instance to the TRACKER_HOMES variable as ``'name': 'home'`` |
| 1228 | 416 |
| 417 The "name" part of the configuration will appear in the URL and identifies the | |
| 418 tracker (so you may have more than one tracker per cgi-bin script). Make sure | |
| 419 there are no spaces or other illegal characters in it (to be safe, stick to | |
| 420 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
|
421 tracker config "tracker :: web" variable, so make sure they match. The "home" |
| 1228 | 422 part of the configuration is the tracker home directory. |
| 423 | |
|
2665
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
424 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
|
425 ``.cgi`` extension of the cgi script. Place the ``roundup.cgi`` script |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
426 wherever you want it to be, rename it to just ``roundup``, and add a |
|
2665
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
427 couple lines to your Apache configuration:: |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
428 |
|
2665
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
429 <Location /path/to/roundup> |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
430 SetHandler cgi-script |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
431 </Location> |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
432 |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
433 |
|
4324
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
434 CGI-bin for Limited-Access Hosting |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
435 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
436 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
437 If you are running in a shared-hosting environment or otherwise don't have |
|
4656
bce631d8f24d
issue2550738: Fixes for various documentation typos, thanks Nathan Russell
John Kristensen <john@jerrykan.com>
parents:
4510
diff
changeset
|
438 permission to edit the system web server's configuration, but can create a |
|
4324
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
439 ``.htaccess`` file then you may be able to use this approach. |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
440 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
441 1. Install flup_ |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
442 2. Create a script ``roundup_stub`` in your server's ``cgi-bin`` directory |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
443 containing:: |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
444 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
445 #!/usr/bin/env python |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
446 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
447 # if necessary modify the Python path to include the place you |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
448 # installed Roundup |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
449 #import sys |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
450 #sys.path.append('...') |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
451 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
452 # cgitb is needed for debugging in browser only |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
453 #import cgitb |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
454 #cgitb.enable() |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
455 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
456 # obtain the WSGI request dispatcher |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
457 from roundup.cgi.wsgi_handler import RequestDispatcher |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
458 tracker_home = '/path/to/tracker/home' |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
459 app = RequestDispatcher(tracker_home) |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
460 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
461 from flup.server.cgi import WSGIServer |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
462 WSGIServer(app).run() |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
463 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
464 3. Modify or created the ``.htaccess`` file in the desired (sub-)domain |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
465 directory to contain:: |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
466 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
467 RewriteEngine On |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
468 RewriteBase / |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
469 RewriteRule ^(.*)$ /cgi-bin/roundup_stub/$1 [L] |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
470 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
471 Now loading the (sub-)domain in a browser should load the tracker web |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
472 interface. If you get a "500" error then enable the "cgitb" lines in the |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
473 stub to get some debugging information. |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
474 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
475 |
| 1228 | 476 Stand-alone Web Server |
| 477 ~~~~~~~~~~~~~~~~~~~~~~ | |
| 478 | |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
479 This approach will give you faster response than cgi-bin. You may |
| 1228 | 480 investigate using ProxyPass or similar configuration in apache to have your |
| 481 tracker accessed through the same URL as other systems. | |
| 482 | |
| 483 The stand-alone web server is started with the command ``roundup-server``. It | |
| 484 has several options - display them with ``roundup-server -h``. | |
| 485 | |
| 486 The tracker home configuration is similar to the cgi-bin - you may either edit | |
| 487 the script to change the TRACKER_HOMES variable or you may supply the | |
| 488 name=home values on the command-line after all the other options. | |
| 489 | |
| 490 To make the server run in the background, use the "-d" option, specifying the | |
| 491 name of a file to write the server process id (pid) to. | |
| 492 | |
| 493 | |
| 494 Zope Product - ZRoundup | |
| 495 ~~~~~~~~~~~~~~~~~~~~~~~ | |
| 496 | |
| 497 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to | |
| 498 your Products directory either in INSTANCE_HOME/Products or the Zope | |
| 499 code tree lib/python/Products. | |
| 500 | |
| 501 When you next (re)start up Zope, you will be able to add a ZRoundup object | |
| 502 that interfaces to your new tracker. | |
| 503 | |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
504 Apache HTTP Server with mod_python |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
505 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
506 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
507 `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
|
508 within the server. Running Roundup this way is much faster than all |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
509 above options and, like `web server cgi-bin`_, allows you to use HTTPS |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
510 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
|
511 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
512 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
|
513 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
|
514 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
515 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
|
516 (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
|
517 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
|
518 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
|
519 is located in ``/usr/lib/apache2/build/``):: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
520 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
521 LD_PRELOAD=/lib/libpthread.so.0 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
522 export LD_PRELOAD |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
523 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
524 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
|
525 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
526 LD_PRELOAD=/usr/lib/libc_r.so |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
527 export LD_PRELOAD |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
528 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
529 Next, you have to add Roundup trackers configuration to apache config. |
|
4249
87b3e905ae2e
fixed typos in the installation instructions
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4226
diff
changeset
|
530 Roundup apache interface uses the following options specified with |
|
87b3e905ae2e
fixed typos in the installation instructions
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4226
diff
changeset
|
531 ``PythonOption`` directives: |
|
2559
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
532 |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
533 TrackerHome: |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
534 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
|
535 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
|
536 |
|
4249
87b3e905ae2e
fixed typos in the installation instructions
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4226
diff
changeset
|
537 TrackerLanguage: |
|
2559
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
538 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
|
539 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
|
540 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
|
541 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
|
542 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
|
543 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
|
544 |
|
2945
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
545 TrackerDebug: |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
546 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
|
547 ``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
|
548 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
|
549 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
|
550 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
|
551 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
|
552 |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
553 TrackerTiming: |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
554 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
|
555 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
|
556 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
|
557 ``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
|
558 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
|
559 timing display is disabled. |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
560 |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
561 In the following example we have two trackers set up in |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
562 ``/var/db/roundup/support`` and ``/var/db/roundup/devel`` and accessed |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
563 as ``https://my.host/roundup/support/`` and ``https://my.host/roundup/devel/`` |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
564 respectively (provided Apache has been set up for SSL of course). |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
565 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
|
566 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
|
567 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
|
568 interface (default). |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
569 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
570 Static files from ``html`` directory are served by apache itself - this |
|
4249
87b3e905ae2e
fixed typos in the installation instructions
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4226
diff
changeset
|
571 is quicker and generally more robust than doing that from python. |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
572 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
|
573 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
|
574 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
575 Example mod_python configuration:: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
576 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
577 ################################################# |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
578 # Roundup Issue tracker |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
579 ################################################# |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
580 # enable Python optimizations (like 'python -O') |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
581 PythonOptimize On |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
582 # let apache handle static files from 'html' directories |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
583 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
|
584 # everything else is handled by roundup web UI |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
585 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
|
586 # roundup requires a slash after tracker name - add it if missing |
|
3965
248c3a7bc94d
seems like a reasonable patch
Richard Jones <richard@users.sourceforge.net>
parents:
3949
diff
changeset
|
587 RedirectMatch permanent ^/roundup/([^/]+)$ /roundup/$1/ |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
588 # common settings for all roundup trackers |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
589 <Directory /var/db/roundup/*> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
590 Order allow,deny |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
591 Allow from all |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
592 AllowOverride None |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
593 Options None |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
594 AddHandler python-program .py |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
595 PythonHandler roundup.cgi.apache |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
596 # 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
|
597 # (note that *some* tracebacks will be displayed anyway) |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
598 #PythonDebug On |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
599 </Directory> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
600 # 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
|
601 <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
|
602 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
|
603 PythonOption TrackerLanguage ru |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
604 </Directory> |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
605 <Directory /var/db/roundup/devel> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
606 PythonOption TrackerHome /var/db/roundup/devel |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
607 </Directory> |
|
3965
248c3a7bc94d
seems like a reasonable patch
Richard Jones <richard@users.sourceforge.net>
parents:
3949
diff
changeset
|
608 |
| 3814 | 609 Notice that the ``/var/db/roundup`` path shown above refers to the directory |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
610 in which the tracker homes are stored. The actual value will thus depend on |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
611 your system. |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
612 |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
613 On Windows the corresponding lines will look similar to these:: |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
614 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
615 AliasMatch /roundup/(.+)/@@file/(.*) C:/DATA/roundup/$1/html/$2 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
616 AliasMatch /roundup/([^/]+)/(?!@@file/)(.*) C:/DATA/roundup/$1/dummy.py/$2 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
617 <Directory C:/DATA/roundup/*> |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
618 <Directory C:/DATA/roundup/support> |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
619 <Directory C:/DATA/roundup/devel> |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
620 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
621 In this example the directory hosting all of the tracker homes is |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
622 ``C:\DATA\roundup``. (Notice that you must use forward slashes in paths |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
623 inside the httpd.conf file!) |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
624 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
625 The URL for accessing these trackers then become: |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
626 `http://<roundupserver>/roundup/support/`` and |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
627 ``http://<roundupserver>/roundup/devel/`` |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
628 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
629 Note that in order to use https connections you must set up Apache for secure |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
630 serving with SSL. |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
631 |
|
3736
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
632 WSGI Handler |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
633 ~~~~~~~~~~~~ |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
634 |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
635 The WSGI handler is quite simple. The following sample code shows how |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
636 to use it:: |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
637 |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
638 from wsgiref.simple_server import make_server |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
639 |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
640 # obtain the WSGI request dispatcher |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
641 from roundup.cgi.wsgi_handler import RequestDispatcher |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
642 tracker_home = 'demo' |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
643 app = RequestDispatcher(tracker_home) |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
644 |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
645 httpd = make_server('', 8917, app) |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
646 httpd.serve_forever() |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
647 |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
648 To test the above you should create a demo tracker with ``python demo.py``. |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
649 Edit the ``config.ini`` to change the web URL to "http://localhost:8917/". |
|
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
650 |
| 1228 | 651 |
| 652 Configure an Email Interface | |
| 653 ---------------------------- | |
| 654 | |
| 655 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
|
656 "``nosyreaction.py``" module from your tracker "``detectors``" directory. |
| 1228 | 657 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
658 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
|
659 |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
660 There are five supported ways to get emailed issues into the |
| 1228 | 661 Roundup tracker. You should pick ONE of the following, all |
| 662 of which will continue my example setup from above: | |
| 663 | |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
664 As a mail alias pipe process |
| 1228 | 665 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 666 | |
| 667 Set up a mail alias called "issue_tracker" as (include the quote marks): | |
| 3524 | 668 "``|/usr/bin/python /usr/bin/roundup-mailgw <tracker_home>``" |
| 669 (substitute ``/usr/bin`` for wherever roundup-mailgw is installed). | |
| 1228 | 670 |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
671 In some installations (e.g. RedHat Linux and Fedora Core) you'll need to |
|
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
672 set up smrsh so sendmail will accept the pipe command. In that case, |
|
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
673 symlink ``/etc/smrsh/roundup-mailgw`` to "``/usr/bin/roundup-mailgw``" |
|
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
674 and change the command to:: |
| 1228 | 675 |
| 676 |roundup-mailgw /opt/roundup/trackers/support | |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
677 |
| 1228 | 678 To test the mail gateway on unix systems, try:: |
| 679 | |
| 680 echo test |mail -s '[issue] test' support@YOUR_DOMAIN_HERE | |
| 681 | |
|
3722
41feeed84caa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3666
diff
changeset
|
682 Be careful that some mail systems (postfix for example) will impost a |
|
41feeed84caa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3666
diff
changeset
|
683 limits on processes they spawn. In particular postfix can set a file size |
|
41feeed84caa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3666
diff
changeset
|
684 limit. *This can cause your Roundup database to become corrupted.* |
|
41feeed84caa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3666
diff
changeset
|
685 |
|
41feeed84caa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3666
diff
changeset
|
686 |
|
3447
83e358352e6e
minor correction to recent addition by Faheem Mitha
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3446
diff
changeset
|
687 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
|
688 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
689 |
|
3446
2325b221bf47
link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3444
diff
changeset
|
690 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
|
691 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
|
692 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
|
693 included, since Exim3 is considered obsolete. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
694 |
|
3446
2325b221bf47
link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3444
diff
changeset
|
695 .. _Exim 4: http://www.exim.org/ |
|
2325b221bf47
link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3444
diff
changeset
|
696 |
|
3444
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
697 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
|
698 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
|
699 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
|
700 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
701 * 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
|
702 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
|
703 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
|
704 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
|
705 user ``roundup``. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
706 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
707 * 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
|
708 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
|
709 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
|
710 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
|
711 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
|
712 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
|
713 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
714 The matching is done in the line:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
715 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
716 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
|
717 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
718 The following configuration has been tested on Debian Sarge with |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
719 Exim4. |
|
3444
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
720 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
721 .. note:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
722 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
|
723 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
|
724 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
|
725 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
|
726 ``/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
|
727 system with Exim4 installed. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
728 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
729 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
|
730 README.Debian in |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
731 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
|
732 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
|
733 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
734 This config makes a few assumptions: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
735 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
736 * 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
|
737 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
|
738 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
|
739 ``/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
|
740 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
741 * 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
|
742 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
|
743 user, in this case, 'roundup'. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
744 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
745 * That if the ``schema.py`` file exists, then the tracker is ready for |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
746 use. Another option is to use the ``config.ini`` file (this changed |
|
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
747 in 0.8 from ``config.py``). |
|
3444
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
748 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
749 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
|
750 section of the Exim4 config:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
751 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
752 # Home dir for your Roundup installation |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
753 ROUNDUP_HOME=/var/lib/roundup/trackers |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
754 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
755 # User and group for Roundup. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
756 ROUNDUP_USER=roundup |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
757 ROUNDUP_GROUP=roundup |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
758 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
759 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
|
760 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
|
761 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
762 roundup_router: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
763 driver = accept |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
764 # 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
|
765 # 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
|
766 # to be present too. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
767 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
|
768 transport = roundup_transport |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
769 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
770 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
|
771 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
|
772 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
773 roundup_transport: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
774 driver = pipe |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
775 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
|
776 current_directory = ROUNDUP_HOME |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
777 home_directory = ROUNDUP_HOME |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
778 user = ROUNDUP_USER |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
779 group = ROUNDUP_GROUP |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
780 |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
781 As a regular job using a mailbox source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
782 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 783 |
|
3405
292fbed108ca
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3335
diff
changeset
|
784 Set ``roundup-mailgw`` up to run every 10 minutes or so. For example |
| 3524 | 785 (substitute ``/usr/bin`` for wherever roundup-mailgw is installed):: |
| 1228 | 786 |
| 3524 | 787 0,10,20,30,40,50 * * * * /usr/bin/roundup-mailgw /opt/roundup/trackers/support mailbox <mail_spool_file> |
| 1228 | 788 |
| 789 Where the ``mail_spool_file`` argument is the location of the roundup submission | |
| 790 user's mail spool. On most systems, the spool for a user "issue_tracker" | |
| 791 will be "``/var/mail/issue_tracker``". | |
| 792 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
793 As a regular job using a POP source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
794 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 795 |
|
3405
292fbed108ca
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3335
diff
changeset
|
796 To retrieve from a POP mailbox, use a *cron* entry similar to the mailbox |
| 3524 | 797 one (substitute ``/usr/bin`` for wherever roundup-mailgw is |
|
3405
292fbed108ca
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3335
diff
changeset
|
798 installed):: |
| 1228 | 799 |
| 3524 | 800 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
|
801 |
| 1228 | 802 where pop_spec is "``username:password@server``" that specifies the roundup |
| 803 submission user's POP account name, password and server. | |
| 804 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
805 On windows, you would set up the command using the windows scheduler. |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
806 |
|
2211
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
807 As a regular job using an IMAP source |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
808 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
809 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
810 To retrieve from an IMAP mailbox, use a *cron* entry similar to the |
| 3524 | 811 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
|
812 installed):: |
|
2211
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
813 |
| 3524 | 814 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
|
815 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
816 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
|
817 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
|
818 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
|
819 "``imap username:password@server mailbox``". |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
820 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
821 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
|
822 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
|
823 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
824 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
|
825 windows scheduler. |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
826 |
| 1228 | 827 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
828 UNIX Environment Steps |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
829 ---------------------- |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
830 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
831 Each tracker ideally should have its own UNIX group, so create |
| 1049 | 832 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if |
| 833 you're using NIS). To continue with my examples so far, I would | |
| 834 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
|
835 group does not have to be the same as the tracker name. To this |
| 1049 | 836 '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
|
837 working with this Roundup tracker. In addition to 'real' users, |
| 1049 | 838 the Roundup email gateway will need to have permissions to this |
| 839 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
|
840 group (typically "mail" or "daemon"). The UNIX group might then |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
841 look like:: |
| 1049 | 842 |
| 843 support:*:1002:jblaine,samh,geezer,mail | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
844 |
| 1049 | 845 If you intend to use the web interface (as most people do), you |
| 846 should also add the username your web server runs as to the group. | |
| 847 My group now looks like this:: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
848 |
| 1049 | 849 support:*:1002:jblaine,samh,geezer,mail,apache |
| 850 | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
851 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
|
852 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
|
853 by the group. |
|
344bad728d10
more tweakage of help display and style issues
Richard Jones <richard@users.sourceforge.net>
parents:
1049
diff
changeset
|
854 |
|
2594
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
855 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
|
856 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
|
857 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
|
858 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
|
859 in ``rdbms`` -> ``user`` and ``password`` in ``config.ini``. |
|
2594
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
860 |
| 1049 | 861 An alternative to the above is to create a new user who has the sole |
| 862 responsibility of running roundup. This user: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
863 |
| 1049 | 864 1. runs the CGI interface daemon |
| 865 2. runs regular polls for email | |
| 866 3. runs regular checks (using cron) to ensure the daemon is up | |
| 867 4. optionally has no login password so that nobody but the "root" user | |
| 868 may actually login and play with the roundup setup. | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
869 |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
870 If you're using a Linux system (e.g. Fedora Core) with SELinux enabled, |
|
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
871 you will need to ensure that the db directory has a context that |
|
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
872 permits the web server to modify and create files. If you're using the |
|
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
873 mysql or postgresql backend you may also need to update your policy to |
|
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
874 allow the web server to access the database socket. |
|
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
875 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
876 |
|
3830
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
877 Public Tracker Considerations |
|
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
878 ----------------------------- |
|
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
879 |
|
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
880 If you run a public tracker, you will eventually have to think about |
|
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
881 dealing with spam entered through both the web and mail interfaces. |
|
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
882 |
|
5300
d8ed32b297e2
Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents:
5140
diff
changeset
|
883 See the section on `Preventing SPAM`_ in the |
|
d8ed32b297e2
Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents:
5140
diff
changeset
|
884 `customisation documentation`_ that has a simple detector |
|
d8ed32b297e2
Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents:
5140
diff
changeset
|
885 that will block lot of spam attempts. |
|
3830
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
886 |
|
2069
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
887 |
| 1228 | 888 Maintenance |
| 889 =========== | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
890 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
891 Read the separate `administration guide`_ for information about how to |
| 1228 | 892 perform common maintenance tasks with Roundup. |
| 1049 | 893 |
|
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
|
894 |
|
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
|
895 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
|
896 ========= |
|
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
|
897 |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
898 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
|
899 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
|
900 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
|
901 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
902 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
903 Further Reading |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
904 =============== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
905 |
|
3528
762d65fefea5
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3524
diff
changeset
|
906 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
|
907 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
|
908 like implementation details, you should read `Customising Roundup`_. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
909 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
910 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
911 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
|
912 ========================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
913 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
914 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
|
915 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
|
916 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
|
917 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
918 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
|
919 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
|
920 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
|
921 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
|
922 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
|
923 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
|
924 "issue" class, but with different properties. See the customisation |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
925 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
|
926 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
927 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
928 Platform-Specific Notes |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
929 ======================= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
930 |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
931 Windows command-line tools |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
932 -------------------------- |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
933 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
934 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
|
935 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
|
936 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
937 On Windows 2000 and later: |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
938 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
939 1) Press the "Start" button. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
940 2) Choose "Settings" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
941 3) Choose "Control Panel" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
942 4) Choose "System" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
943 5) Choose "Advanced" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
944 6) Choose "Environmental Variables" |
|
1746
9c1da921cd35
minor rest tweak
Richard Jones <richard@users.sourceforge.net>
parents:
1688
diff
changeset
|
945 7) Add: "<dir>\Scripts" to the "Path" environmental variable. |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
946 |
| 1747 | 947 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
|
948 of your Python installation. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
949 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
950 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
|
951 Panel" is directly accessible from "Start". |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
952 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
953 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
|
954 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
955 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
956 Windows Server |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
957 -------------- |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
958 |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
959 To have the Roundup web server start up when your machine boots up, there |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
960 are two different methods, the scheduler and installing the service. |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
961 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
962 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
963 1. Using the Windows scheduler |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
964 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
965 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
966 Set up the following in Scheduled Tasks (note, the following is for a |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
967 cygwin setup): |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
968 |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
969 **Run** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
970 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
971 ``c:\cygwin\bin\bash.exe -c "roundup-server TheProject=/opt/roundup/trackers/support"`` |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
972 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
973 **Start In** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
974 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
975 ``C:\cygwin\opt\roundup\bin`` |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
976 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
977 **Schedule** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
978 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
979 At System Startup |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
980 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
981 To have the Roundup mail gateway run periodically to poll a POP email address, |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
982 set up the following in Scheduled Tasks: |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
983 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
984 **Run** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
985 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
986 ``c:\cygwin\bin\bash.exe -c "roundup-mailgw /opt/roundup/trackers/support pop roundup:roundup@mail-server"`` |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
987 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
988 **Start In** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
989 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
990 ``C:\cygwin\opt\roundup\bin`` |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
991 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
992 **Schedule** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
993 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
994 Every 10 minutes from 5:00AM for 24 hours every day |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
995 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
996 Stop the task if it runs for 8 minutes |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
997 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
998 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
999 2. Installing the roundup server as a Windows service |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1000 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1001 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1002 This is more Windows oriented and will make the Roundup server run as |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1003 soon as the PC starts up without any need for a login or such. It will |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1004 also be available in the normal Windows Administrative Tools. |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1005 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1006 For this you need first to create a service ini file containing the |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1007 relevant settings. |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1576
diff
changeset
|
1008 |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1009 1. It is created if you execute the following command from within the |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1010 scripts directory (notice the use of backslashes):: |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1011 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1012 roundup-server -S -C <trackersdir>\server.ini -n <servername> -p 8080 -l <trackersdir>\trackerlog.log software=<trackersdir>\Software |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1013 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1014 where the item ``<trackersdir>`` is replaced with the physical directory |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1015 that hosts all of your trackers. The ``<servername>`` item is the name |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1016 of your roundup server PC, such as w2003srv or similar. |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1017 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1018 2. Next open the now created file ``C:\DATA\roundup\server.ini`` file |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1019 (if your ``<trackersdir>`` is ``C:\DATA\roundup``). |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1020 Check the entries for correctness, especially this one:: |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1021 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1022 [trackers] |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1023 software = C:\DATA\Roundup\Software |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1024 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1025 (this is an example where the tracker is named software and its home is |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1026 ``C:\DATA\Roundup\Software``) |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1027 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1028 3. Next give the commands that actually installs and starts the service:: |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1029 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1030 roundup-server -C C:\DATA\Roundup\server.ini -c install |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1031 roundup-server -c start |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1032 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1033 4. Finally open the AdministrativeTools/Services applet and locate the |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1034 Roundup service entry. Open its properties and change it to start |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1035 automatically instead of manually. |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1036 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1037 If you are using Apache as the webserver you might want to use it with |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1038 mod_python instead to serve out Roundup. In that case see the mod_python |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1039 instructions above for details. |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
1040 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
1041 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1042 Sendmail smrsh |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1043 -------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1044 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1045 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
|
1046 smrsh that roundup-mailgw is a valid/trusted mail handler |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1047 before it will work. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1048 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1049 This is usually done via the following 2 steps: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1050 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1051 1. make a symlink in ``/etc/smrsh`` called ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1052 which points to the full path of your actual ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1053 script. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1054 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
1055 2. change your alias to ``"|roundup-mailgw <tracker_home>"`` |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1056 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1057 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1058 Linux |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1059 ----- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1060 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
1061 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
|
1062 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1063 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1064 Solaris |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1065 ------- |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1066 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1067 You'll need to build Python. |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1068 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
1069 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
|
1070 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1071 |
|
2972
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1072 Problems? Testing your Python... |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1073 ================================ |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1074 |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1075 .. note:: |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1076 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
|
1077 - users of the Windows installer, other binary distributions or |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1078 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
|
1079 |
|
4317
15834821b8c7
- fix explicit python version description...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4315
diff
changeset
|
1080 Remember to have a database user 'rounduptest' prepared (with |
|
15834821b8c7
- fix explicit python version description...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4315
diff
changeset
|
1081 password 'rounduptest'). This user |
|
4315
cfb01b2bc730
Fix documentation on user required to run the tests, fixes issue2550618.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4249
diff
changeset
|
1082 must have at least the rights to create and drop databases. |
|
cfb01b2bc730
Fix documentation on user required to run the tests, fixes issue2550618.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4249
diff
changeset
|
1083 Documentation: details on `adding MySQL users`_, |
|
cfb01b2bc730
Fix documentation on user required to run the tests, fixes issue2550618.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4249
diff
changeset
|
1084 for PostgreSQL you want to call the ``createuser`` command with the |
|
cfb01b2bc730
Fix documentation on user required to run the tests, fixes issue2550618.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4249
diff
changeset
|
1085 ``-d`` option to allow database creation. |
|
cfb01b2bc730
Fix documentation on user required to run the tests, fixes issue2550618.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4249
diff
changeset
|
1086 |
|
2972
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1087 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
|
1088 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
|
1089 please let us know! |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1090 |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1091 If the above fails, you may be using the wrong version of python. Try |
|
5321
4566360871dc
Raises python requirement to 2.7.
Bernhard Reiter <bernhard@intevation.de>
parents:
5300
diff
changeset
|
1092 ``python2 run_tests.py`` or ``python2.7 run_tests.py``. |
|
4566360871dc
Raises python requirement to 2.7.
Bernhard Reiter <bernhard@intevation.de>
parents:
5300
diff
changeset
|
1093 If that works, you will need to substitute ``python2`` or ``python2.7`` |
|
4317
15834821b8c7
- fix explicit python version description...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4315
diff
changeset
|
1094 for ``python`` in all further commands you use in relation to Roundup -- |
|
15834821b8c7
- fix explicit python version description...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4315
diff
changeset
|
1095 from installation and scripts. |
|
2972
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1096 |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1097 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1098 .. _`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
|
1099 .. _`user guide`: user_guide.html |
|
4949
c3a90535f7a7
Backed out changeset 4a3a35192ad1
John Rouillard <rouilj@ieee.org>
parents:
4948
diff
changeset
|
1100 .. _`roundup specification`: spec.html |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
1101 .. _`tracker configuration`: customizing.html#tracker-configuration |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
1102 .. _`customisation documentation`: customizing.html |
|
5300
d8ed32b297e2
Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents:
5140
diff
changeset
|
1103 .. _`preventing spam`: customizing.html#preventing-spam |
|
2161
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
1104 .. _`Adding a new field to the classic schema`: |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
1105 customizing.html#adding-a-new-field-to-the-classic-schema |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
1106 .. _`Tracking different types of issues`: |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
1107 customizing.html#tracking-different-types-of-issues |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1108 .. _`customising roundup`: customizing.html |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
1109 .. _`upgrading document`: upgrading.html |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
1110 .. _`administration guide`: admin_guide.html |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1111 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1112 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1113 .. _External hyperlink targets: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1114 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1115 .. _apache: http://httpd.apache.org/ |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5321
diff
changeset
|
1116 .. _flup: https://pypi.org/project/flup/ |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1117 .. _mod_python: http://www.modpython.org/ |
|
5510
e2978ed3b550
update link to new mysqlclient module and recommend update in upgrading.txt
Christof Meerwald <cmeerw@cmeerw.org>
parents:
5494
diff
changeset
|
1118 .. _MySQLdb: https://pypi.org/project/mysqlclient/ |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1119 .. _Psycopg: http://initd.org/software/initd/psycopg |
|
3335
e996f3584772
fix PySQLite site URL
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3303
diff
changeset
|
1120 .. _pysqlite: http://pysqlite.org/ |
|
4315
cfb01b2bc730
Fix documentation on user required to run the tests, fixes issue2550618.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4249
diff
changeset
|
1121 .. _`adding MySQL users`: |
|
cfb01b2bc730
Fix documentation on user required to run the tests, fixes issue2550618.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4249
diff
changeset
|
1122 http://dev.mysql.com/doc/refman/5.1/en/adding-users.html |
