Mercurial > p > roundup > code
annotate doc/installation.txt @ 5938:16eec1c41e0e
Add basic gunicorn configuration mechanism.
Works for me...
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 20 Oct 2019 21:13:29 -0400 |
| parents | 133efe1fbff7 |
| children | 459426a8c61e |
| 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 |
|
5756
e48b039b0ec0
issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents:
5610
diff
changeset
|
35 anydbm module. Download the latest version from https://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: |
|
5610
0df5f9eeefd4
Changed references to http://issues.roundup-tracker.org to https now
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
50 https://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 |
|
5878
1b57d8f3eb97
Add rudimentery experiment JSON Web Token (jwt) support
John Rouillard <rouilj@ieee.org>
parents:
5756
diff
changeset
|
115 pyjwt |
|
1b57d8f3eb97
Add rudimentery experiment JSON Web Token (jwt) support
John Rouillard <rouilj@ieee.org>
parents:
5756
diff
changeset
|
116 To use jwt tokens for login (experimental), install pyjwt. If you |
|
1b57d8f3eb97
Add rudimentery experiment JSON Web Token (jwt) support
John Rouillard <rouilj@ieee.org>
parents:
5756
diff
changeset
|
117 don't have it installed, jwt tokens are not supported. |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
118 |
|
4686
4e740f02e165
Remove pywin32 installation dependency by porting portalocker.py to ctypes.
anatoly techtonik <techtonik@gmail.com>
parents:
4672
diff
changeset
|
119 Windows Service |
|
4e740f02e165
Remove pywin32 installation dependency by porting portalocker.py to ctypes.
anatoly techtonik <techtonik@gmail.com>
parents:
4672
diff
changeset
|
120 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
|
121 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
|
122 |
|
5756
e48b039b0ec0
issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents:
5610
diff
changeset
|
123 .. _Xapian: https://xapian.org/ |
|
5096
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
5083
diff
changeset
|
124 .. _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
|
125 .. _pytz: https://pypi.org/project/pytz/ |
| 5367 | 126 .. _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
|
127 .. _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
|
128 .. _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
|
129 .. _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
|
130 .. _jinja2: http://jinja.pocoo.org/ |
|
3296
d5fa5a0b5216
some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents:
3153
diff
changeset
|
131 |
|
3297
8f7dc283bfa5
some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents:
3296
diff
changeset
|
132 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
133 Getting Roundup |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
134 =============== |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
135 |
|
2742
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
136 .. note:: |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
137 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
|
138 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
|
139 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
|
140 below and go straight to `configuring your first tracker`_. |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
141 |
|
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
|
142 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
|
143 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
144 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
|
145 ======================== |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
146 |
|
4688
80f9a1fbc0cc
doc: Remove WinZip tutorial and mention demo.py becoming 'roundup-demo'
anatoly techtonik <techtonik@gmail.com>
parents:
4686
diff
changeset
|
147 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
|
148 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
|
149 after installation). |
| 2401 | 150 |
|
3571
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
151 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
|
152 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
|
153 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
|
154 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
155 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
|
156 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
|
157 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
|
158 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
|
159 |
|
3571
f0b1c8ff4a2a
Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3528
diff
changeset
|
160 .. [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
|
161 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
|
162 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
|
163 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
|
164 ``[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
|
165 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
166 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
167 ============ |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
168 |
|
2991
b9a55628a78d
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
2988
diff
changeset
|
169 Set aside 15-30 minutes. There's several steps to follow in your |
| 1228 | 170 installation: |
| 1049 | 171 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
172 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
|
173 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
|
174 3. then optionally `configure a web interface`_ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
175 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
|
176 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
|
177 UNIX machine and want to restrict local access to roundup |
| 1049 | 178 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
179 For information about how Roundup installs, see the `administration |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
180 guide`_. |
|
1965
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
181 |
|
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
|
182 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
|
183 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
|
184 privileges so it can correctly update the registry. |
| 1049 | 185 |
| 186 Basic Installation Steps | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
187 ------------------------ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
188 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
189 To install the Roundup support code into your Python tree and |
| 3524 | 190 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
|
191 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
|
192 for these locations, eg. being root on unix:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
193 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
194 python setup.py install |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
195 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
196 If you would like to place the Roundup scripts in a directory other |
| 3524 | 197 than ``/usr/bin``, then specify the preferred location with |
|
3949
29dfb873b32e
Small documentation cleanup
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3935
diff
changeset
|
198 ``--install-scripts``. For example, to install them in |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
199 ``/opt/roundup/bin``:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
200 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
201 python setup.py install --install-scripts=/opt/roundup/bin |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
202 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
203 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
|
204 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
|
205 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
|
206 yourself. |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1245
diff
changeset
|
207 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
208 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
209 Configuring your first tracker |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
210 ------------------------------ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
211 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
212 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
|
213 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
|
214 home": |
|
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 a. (Optional) If you intend to keep your roundup trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
217 under one top level directory which does not exist yet, |
| 1228 | 218 you should create that directory now. Example:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
219 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
220 mkdir /opt/roundup/trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
221 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
222 b. Either add the Roundup script location to your ``PATH`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
223 environment variable or specify the full path to |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
224 the command in the next step. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
225 |
| 1228 | 226 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
|
227 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
|
228 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
|
229 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
|
230 below. The questions will be something like (you may have more |
| 1228 | 231 templates or backends available):: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
232 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
233 Enter tracker home: /opt/roundup/trackers/support |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
234 Templates: classic |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
235 Select template [classic]: classic |
|
2818
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
236 Back ends: anydbm, mysql, sqlite |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
237 Select backend [anydbm]: anydbm |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
238 |
|
2818
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
239 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
|
240 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
|
241 includes anydbm module only. |
|
2317e43609cb
remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2742
diff
changeset
|
242 |
|
1571
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
243 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
|
244 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
|
245 will be stored in. |
|
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
246 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
247 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
|
248 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
|
249 (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
|
250 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
|
251 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
|
252 configuration`_ section of the `customisation documentation`_. |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
253 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
254 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
|
255 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
|
256 "tracker :: web" variable to:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
257 |
|
3303
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
258 web = http://localhost:8080/support/ |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
259 |
|
1310
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
260 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
|
261 See `Customising Roundup`_ for details on configuration and schema |
| 2409 | 262 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
|
263 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
|
264 for this stuff now. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
265 |
| 1228 | 266 d. Initialise the tracker database with ``roundup-admin initialise``. |
| 267 You will need to supply an admin password at this step. You will be | |
| 268 prompted:: | |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
269 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
270 Admin Password: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
271 Confirm: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
272 |
| 2401 | 273 Note: running this command will *destroy any existing data in the |
| 4355 | 274 database*. In the case of MySQL and PostgreSQL, any existing database |
| 2401 | 275 will be dropped and re-created. |
| 276 | |
|
4792
1a0cf0345465
issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents:
4688
diff
changeset
|
277 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
|
278 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
|
279 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
|
280 line. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
281 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
282 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
|
283 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
|
284 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
|
285 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
|
286 ``'http://localhost:8080/support/'``, run:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
287 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
288 roundup-server support=/opt/roundup/trackers/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 then direct your web browser at: |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
291 |
|
1845
3c6dd167a744
Fix typo in server address [SF#822967].
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1839
diff
changeset
|
292 http://localhost:8080/support/ |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
293 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
294 and you should see the tracker interface. |
| 1049 | 295 |
|
5138
c54720396f40
issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents:
5108
diff
changeset
|
296 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
|
297 8080 (make sure you change the "tracker :: web" changes to match) use:: |
| 1049 | 298 |
|
5138
c54720396f40
issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents:
5108
diff
changeset
|
299 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
|
300 |
|
c54720396f40
issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents:
5108
diff
changeset
|
301 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
|
302 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
|
303 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
304 Choosing Your Template |
|
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 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
307 Classic Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
308 ~~~~~~~~~~~~~~~~ |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
309 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
310 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
|
311 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
|
312 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
|
313 |
|
1227
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
314 Minimal Template |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
315 ~~~~~~~~~~~~~~~~ |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
316 |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
317 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
|
318 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
|
319 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
|
320 create your tracker on. |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
321 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
322 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
323 Choosing Your Backend |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
324 --------------------- |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
325 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
326 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
|
327 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
|
328 |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
329 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
330 Name Speed Users Support |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
331 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
332 anydbm Slowest Few Always available |
|
3729
60d3865b3cb6
grammar R us
Richard Jones <richard@users.sourceforge.net>
parents:
3728
diff
changeset
|
333 sqlite Fastest(*) Few May need install (PySQLite_) |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
334 postgresql Fast Many Needs install/admin (psycopg_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
335 mysql Fast Many Needs install/admin (MySQLdb_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
336 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
337 |
|
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
|
338 **sqlite** |
|
3935
1dab48842cbd
Throwing up hands in resignation and finally deleting the metakit backend.
Richard Jones <richard@users.sourceforge.net>
parents:
3922
diff
changeset
|
339 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
|
340 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
|
341 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
|
342 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
|
343 |
|
b476fef16ccc
fixed support for pysqlite2 (version 2.1.0 is the minimum version supported)
Richard Jones <richard@users.sourceforge.net>
parents:
3722
diff
changeset
|
344 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
|
345 being bundled with Python 2.5+) |
|
3794
f5ddd1639a15
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
346 |
|
f5ddd1639a15
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3754
diff
changeset
|
347 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
|
348 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
|
349 **postgresql** |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
350 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
|
351 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
|
352 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
|
353 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
|
354 **mysql** |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
355 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
|
356 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
|
357 section of your tracker's ``config.ini`` |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
358 |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
359 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
|
360 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
|
361 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
|
362 guide`_. |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
363 |
| 2401 | 364 Regardless of which backend you choose, Roundup will attempt to initialise |
| 365 a new database for you when you run the roundup-admin "initialise" command. | |
| 366 In the case of MySQL and PostgreSQL you will need to have the appropriate | |
| 367 privileges to create databases. | |
| 368 | |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
369 |
| 1228 | 370 Configure a Web Interface |
| 371 ------------------------- | |
| 372 | |
|
5486
a5edd6adff14
Change count of number of ways to run roundup to "multiple".
John Rouillard <rouilj@ieee.org>
parents:
5367
diff
changeset
|
373 There are multiple web interfaces to choose from: |
| 1228 | 374 |
| 375 1. `web server cgi-bin`_ | |
|
4324
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
376 2. `cgi-bin for limited-access hosting`_ |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
377 3. `stand-alone web server`_ |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
378 4. `Zope product - ZRoundup`_ |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
379 5. `Apache HTTP Server with mod_wsgi`_ |
|
5891
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
380 6. `Apache HTTP Server with mod_python`_ (deprecated) |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
381 7. `WSGI Variations`_ |
| 1228 | 382 |
| 383 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
|
384 - 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
|
385 configure your system in some way - see `platform-specific notes`_. |
| 1228 | 386 |
| 387 | |
| 388 Web Server cgi-bin | |
| 389 ~~~~~~~~~~~~~~~~~~ | |
| 390 | |
| 391 A benefit of using the cgi-bin approach is that it's the easiest way to | |
| 392 restrict access to your tracker to only use HTTPS. Access will be slower | |
| 393 than through the `stand-alone web server`_ though. | |
| 394 | |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
395 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
|
396 the ``roundup.cgi`` script to fix the first line. |
|
0f2678eeeac6
cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents:
1747
diff
changeset
|
397 |
|
1540
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
398 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
|
399 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
|
400 |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
401 adsutil.vbs set w3svc/AllowPathInfoForScriptMappings TRUE |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
402 |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
403 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
|
404 or ``c:\winnt\system32\inetsrv\adminsamples\`` or |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
405 ``c:\winnt\system32\inetsrv\adminscripts\`` depending on your installation. |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
406 |
|
2988
f4023f1cc1d6
apply IE caching "fix" to automatically serve up all pages expired
Richard Jones <richard@users.sourceforge.net>
parents:
2979
diff
changeset
|
407 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
|
408 |
|
f4023f1cc1d6
apply IE caching "fix" to automatically serve up all pages expired
Richard Jones <richard@users.sourceforge.net>
parents:
2979
diff
changeset
|
409 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
|
410 |
|
3736
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
411 Copy the ``frontends/roundup.cgi`` file to your web server's ``cgi-bin`` |
| 1228 | 412 directory. You will need to configure it to tell it where your tracker home |
| 413 is. You can do this either: | |
| 414 | |
|
3303
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
415 Through an environment variable |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
416 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
|
417 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
|
418 |
|
520eef0e0e91
fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents:
3297
diff
changeset
|
419 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
|
420 Add your instance to the TRACKER_HOMES variable as ``'name': 'home'`` |
| 1228 | 421 |
| 422 The "name" part of the configuration will appear in the URL and identifies the | |
| 423 tracker (so you may have more than one tracker per cgi-bin script). Make sure | |
| 424 there are no spaces or other illegal characters in it (to be safe, stick to | |
| 425 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
|
426 tracker config "tracker :: web" variable, so make sure they match. The "home" |
| 1228 | 427 part of the configuration is the tracker home directory. |
| 428 | |
|
2665
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
429 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
|
430 ``.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
|
431 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
|
432 couple lines to your Apache configuration:: |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
433 |
|
2665
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
434 <Location /path/to/roundup> |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
435 SetHandler cgi-script |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
436 </Location> |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
437 |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
438 |
|
4324
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
439 CGI-bin for Limited-Access Hosting |
|
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 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
442 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
|
443 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
|
444 ``.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
|
445 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
446 1. Install flup_ |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
447 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
|
448 containing:: |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
449 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
450 #!/usr/bin/env python |
|
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 # 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
|
453 # installed Roundup |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
454 #import sys |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
455 #sys.path.append('...') |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
456 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
457 # 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
|
458 #import cgitb |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
459 #cgitb.enable() |
|
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 # obtain the WSGI request dispatcher |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
462 from roundup.cgi.wsgi_handler import RequestDispatcher |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
463 tracker_home = '/path/to/tracker/home' |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
464 app = RequestDispatcher(tracker_home) |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
465 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
466 from flup.server.cgi import WSGIServer |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
467 WSGIServer(app).run() |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
468 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
469 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
|
470 directory to contain:: |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
471 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
472 RewriteEngine On |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
473 RewriteBase / |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
474 RewriteRule ^(.*)$ /cgi-bin/roundup_stub/$1 [L] |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
475 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
476 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
|
477 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
|
478 stub to get some debugging information. |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
479 |
|
c70762f2be4e
flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents:
4317
diff
changeset
|
480 |
| 1228 | 481 Stand-alone Web Server |
| 482 ~~~~~~~~~~~~~~~~~~~~~~ | |
| 483 | |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
484 This approach will give you faster response than cgi-bin. You may |
| 1228 | 485 investigate using ProxyPass or similar configuration in apache to have your |
| 486 tracker accessed through the same URL as other systems. | |
| 487 | |
| 488 The stand-alone web server is started with the command ``roundup-server``. It | |
| 489 has several options - display them with ``roundup-server -h``. | |
| 490 | |
| 491 The tracker home configuration is similar to the cgi-bin - you may either edit | |
| 492 the script to change the TRACKER_HOMES variable or you may supply the | |
| 493 name=home values on the command-line after all the other options. | |
| 494 | |
| 495 To make the server run in the background, use the "-d" option, specifying the | |
| 496 name of a file to write the server process id (pid) to. | |
| 497 | |
| 498 | |
| 499 Zope Product - ZRoundup | |
| 500 ~~~~~~~~~~~~~~~~~~~~~~~ | |
| 501 | |
| 502 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to | |
| 503 your Products directory either in INSTANCE_HOME/Products or the Zope | |
| 504 code tree lib/python/Products. | |
| 505 | |
| 506 When you next (re)start up Zope, you will be able to add a ZRoundup object | |
| 507 that interfaces to your new tracker. | |
| 508 | |
|
5891
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
509 Apache HTTP Server with mod_wsgi |
|
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
510 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
511 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
512 This is a work in progress thanks to Garth Jensen. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
513 |
|
5909
d57347ae6f25
Typo fixes in installation.txt doc.
John Rouillard <rouilj@ieee.org>
parents:
5908
diff
changeset
|
514 See the main web site for `mod_wsgi`_ which include directions for |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
515 using mod_wsgi-express which is easier if you are not used to apache |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
516 configuration. Also there is the |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
517 `main mod_wsgi <https://modwsgi.readthedocs.io/en/develop/>`_ for more |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
518 detailed directions. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
519 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
520 Background |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
521 ^^^^^^^^^^ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
522 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
523 These notes were developed on a Microsoft Azure VM running Ubuntu |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
524 18.04 LTS. The instructions below assume: |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
525 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
526 - python and roundup are already installed |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
527 - roundup is running in the system python instance (e.g. no virtual |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
528 environment) |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
529 - the tracker ``mytracker`` is installed in the ``trackers`` folder of |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
530 home directory of a user called ``admin``. Thus, the absolute path to |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
531 the tracker home directory is ``/home/admin/trackers/mytracker``. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
532 - the server has a static public IP address of 11.11.11.101 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
533 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
534 Install mod-wsgi |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
535 ^^^^^^^^^^^^^^^^ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
536 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
537 You can install/build it using the python package manager pip, or |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
538 install using the OS package manager (apt). |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
539 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
540 Pip install of mod_wsgi |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
541 ''''''''''''''''''''''' |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
542 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
543 This is the tested method, and offers an easier path to get started, |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
544 but it does mean that you will need to keep up to date with any |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
545 security or other issues. If you use the packages supplied by your OS |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
546 vendor, you may get more timely updates and notifications. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
547 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
548 The mod_wsgi docs talk about two installation methods: (1) the |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
549 so-called CMMI method or (2) with pip. The pip method also provides an |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
550 admin script called ``mod_wsgi-express`` that can start up a |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
551 standalone instance of Apache directly from the command line with an |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
552 auto generated configuration. These instructions follow the pip |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
553 method. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
554 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
555 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
556 1. The `mod_wsgi`_ PyPi page lists prerequisites for various types of |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
557 systems. For Ubuntu, they are apache2 and apache2-dev. To see |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
558 installed apache packages, you can use ``dpkg -l | grep apache``. |
|
5909
d57347ae6f25
Typo fixes in installation.txt doc.
John Rouillard <rouilj@ieee.org>
parents:
5908
diff
changeset
|
559 If apache2 or apache2-dev are not installed, they install them |
|
d57347ae6f25
Typo fixes in installation.txt doc.
John Rouillard <rouilj@ieee.org>
parents:
5908
diff
changeset
|
560 with: |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
561 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
562 - ``sudo apt update`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
563 - ``sudo apt install apache2 apache2-dev`` |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
564 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
565 2. If ``pip`` is not already installed, install it with |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
566 ``sudo apt install python-pip`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
567 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
568 If you are using python 3, use ``sudo apt-install python3-pip`` and |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
569 change references to pip in the directions to pip3. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
570 3. ``sudo pip install mod_wsgi``. In my case, I got warnings about |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
571 the user not owning directories, but it said it completed |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
572 "successfully." |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
573 4. For testing, open port 8000 for TCP on the server. For an Azure VM, |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
574 this is done with Azure Portal under ``Networking`` > ``Add inbound port`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
575 rule. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
576 5. Test with ``mod_wsgi-express start-server``. This should serve |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
577 up content on localhost port 8000. You can then direct a browser on |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
578 the server itself to http://localhost:8000/ or on another machine at |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
579 the server's domain name or ip address followed by colon then 8000 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
580 (e.g. http://11.11.11.101:8000/). If successful, you should see a |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
581 Malt Whiskey image. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
582 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
583 Package manager install of mod_wsgi |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
584 ''''''''''''''''''''''''''''''''''' |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
585 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
586 On debian (which should work for Ubuntu), install apache2 with |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
587 libapache2-mod-wsgi: |
|
5891
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
588 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
589 - ``sudo apt update`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
590 - ``sudo apt install apache2 libapache2-mod-wsgi`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
591 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
592 this is the less tested method for installing mod_wsgi and may not |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
593 install mod_wsgi-express, which is used below. However there is an |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
594 example apache config included as part of `WSGI Variations`_ that can |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
595 be used to hand craft an apache config. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
596 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
597 You should make sure that the version you install is 3.5 or newer due |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
598 to security issues in older releases. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
599 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
600 Configure web interface via wsgi_handler |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
601 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
602 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
603 1. In the tracker's home directory create a ``wsgi.py`` file with the |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
604 following content (substituting ``/home/admin/trackers/mytracker`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
605 with the absolute path for your tracker's home directory): |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
606 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
607 .. code:: python |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
608 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
609 from roundup.cgi.wsgi_handler import RequestDispatcher |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
610 tracker_home = '/home/admin/trackers/mytracker' |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
611 application = RequestDispatcher(tracker_home) |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
612 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
613 To run the tracker on Port 8000 as a foreground process |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
614 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
615 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
616 1. Change the ``tracker.web`` url in ``config.ini`` to port 8000 at the |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
617 server domain name or ip address (e.g. http://11.11.11.101:8000/). |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
618 2. Open port 8000 for TCP on the server if you didn't already do so. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
619 3. ``cd`` to your tracker home directory, then run |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
620 ``mod_wsgi-express start-server wsgi.py``. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
621 4. Test by directing a browser on another machine to the url you set |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
622 ``tracker.web`` to in ``config.ini``. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
623 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
624 Run tracker as background daemon |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
625 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
626 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
627 To run the tracker on Port 80 or as a background process, you'll need |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
628 to configure a UNIX group with appropriate privileges as described in |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
629 `UNIX environment steps`_. These steps are summarized here: |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
630 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
631 1. To add a group named "mytrackergrp" run: ``sudo groupadd mytrackergrp``. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
632 2. Add the owner of the tracker home (admin in this example) run: |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
633 ``sudo usermod -a -G mytrackergrp admin`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
634 3. Add user that runs Apache (the default on Ubuntu is www-data) run: |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
635 ``sudo usermod -a -G mytrackergrp www-data`` |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
636 4. Add user mail service runs as (e.g. daemon) run: |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
637 ``sudo usermod -a -G mytrackergrp daemon`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
638 5. Change group of the database in the tracker folder run: |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
639 ``sudo chgrp -R mytrackergrp ~/trackers/mytracker``. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
640 6. Make sure group can write to the database, and any new files created |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
641 in the database will be owned by the group run: |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
642 ``sudo chmod -R g+sw ~/trackers/mytracker/db`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
643 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
644 To run mod_wsgi on PORT 80 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
645 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
646 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
647 1. Change the ``tracker.web`` url in ``config.ini`` to the server url |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
648 with no port designator. E.g. http://11.11.11.101. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
649 2. Open port 80 on the server for TCP traffic if it isn't open already. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
650 3. Stop the system instance of Apache to make sure it isn't holding on |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
651 to port 80 run: ``sudo service apache2 stop``. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
652 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
653 To run as a foreground process |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
654 '''''''''''''''''''''''''''''' |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
655 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
656 1. From the tracker home directory, run |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
657 ``sudo mod_wsgi-express start-server wsgi.py --port 80 --user admin --group mytrackergrp`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
658 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
659 To run as a background process |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
660 '''''''''''''''''''''''''''''' |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
661 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
662 1. From the tracker home directory, bash |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
663 ``sudo mod_wsgi-express setup-server wsgi.py --port=80 --user admin --group mytrackergrp --server-root=/etc/mod_wsgi-express-80`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
664 2. Then, run ``sudo /etc/mod_wsgi-express-80/apachectl start`` |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
665 3. To stop, run ``sudo /etc/mod_wsgi-express-80/apachectl stop`` |
|
5891
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
666 |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
667 Apache HTTP Server with mod_python |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
668 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
669 |
|
5891
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
670 As of roundup 2.0, mod_python support is deprecated. The apache.py |
|
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
671 file is still available, but may be limited to working for Python 2 |
|
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
672 only. Using mod_wsgi with Apache is the recommended way to deploy |
|
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
673 roundup under apache. |
|
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
674 |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
675 `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
|
676 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
|
677 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
|
678 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
|
679 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
680 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
|
681 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
|
682 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
683 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
|
684 (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
|
685 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
|
686 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
|
687 is located in ``/usr/lib/apache2/build/``):: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
688 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
689 LD_PRELOAD=/lib/libpthread.so.0 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
690 export LD_PRELOAD |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
691 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
692 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
|
693 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
694 LD_PRELOAD=/usr/lib/libc_r.so |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
695 export LD_PRELOAD |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
696 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
697 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
|
698 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
|
699 ``PythonOption`` directives: |
|
2559
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
700 |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
701 TrackerHome: |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
702 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
|
703 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
|
704 |
|
4249
87b3e905ae2e
fixed typos in the installation instructions
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4226
diff
changeset
|
705 TrackerLanguage: |
|
2559
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
706 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
|
707 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
|
708 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
|
709 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
|
710 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
|
711 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
|
712 |
|
2945
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
713 TrackerDebug: |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
714 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
|
715 ``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
|
716 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
|
717 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
|
718 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
|
719 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
|
720 |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
721 TrackerTiming: |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
722 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
|
723 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
|
724 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
|
725 ``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
|
726 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
|
727 timing display is disabled. |
|
98efa80f0f90
added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2921
diff
changeset
|
728 |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
729 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
|
730 ``/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
|
731 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
|
732 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
|
733 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
|
734 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
|
735 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
|
736 interface (default). |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
737 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
738 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
|
739 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
|
740 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
|
741 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
|
742 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
743 Example mod_python configuration:: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
744 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
745 ################################################# |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
746 # Roundup Issue tracker |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
747 ################################################# |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
748 # enable Python optimizations (like 'python -O') |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
749 PythonOptimize On |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
750 # let apache handle static files from 'html' directories |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
751 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
|
752 # everything else is handled by roundup web UI |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
753 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
|
754 # 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
|
755 RedirectMatch permanent ^/roundup/([^/]+)$ /roundup/$1/ |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
756 # common settings for all roundup trackers |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
757 <Directory /var/db/roundup/*> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
758 Order allow,deny |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
759 Allow from all |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
760 AllowOverride None |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
761 Options None |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
762 AddHandler python-program .py |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
763 PythonHandler roundup.cgi.apache |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
764 # 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
|
765 # (note that *some* tracebacks will be displayed anyway) |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
766 #PythonDebug On |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
767 </Directory> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
768 # 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
|
769 <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
|
770 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
|
771 PythonOption TrackerLanguage ru |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
772 </Directory> |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
773 <Directory /var/db/roundup/devel> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
774 PythonOption TrackerHome /var/db/roundup/devel |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
775 </Directory> |
|
3965
248c3a7bc94d
seems like a reasonable patch
Richard Jones <richard@users.sourceforge.net>
parents:
3949
diff
changeset
|
776 |
| 3814 | 777 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
|
778 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
|
779 your system. |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
780 |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
781 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
|
782 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
783 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
|
784 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
|
785 <Directory C:/DATA/roundup/*> |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
786 <Directory C:/DATA/roundup/support> |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
787 <Directory C:/DATA/roundup/devel> |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
788 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
789 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
|
790 ``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
|
791 inside the httpd.conf file!) |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
792 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
793 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
|
794 `http://<roundupserver>/roundup/support/`` and |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
795 ``http://<roundupserver>/roundup/devel/`` |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
796 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
797 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
|
798 serving with SSL. |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
799 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
800 WSGI Variations |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
801 ~~~~~~~~~~~~~~~ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
802 |
|
5938
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
803 Apache Alternate |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
804 ^^^^^^^^^^^^^^^^ |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
805 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
806 This method from Thomas Arendsen Hein goes into a bit more detail and |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
807 is designed to allow you to run multiple roundup trackers each under |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
808 their own user. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
809 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
810 The tracker instances are read-only to the tracker user and located |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
811 under /srv/roundup/. The (writable) data files are stored in the home |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
812 directory of the user running the tracker. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
813 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
814 To install roundup, download and unpack a distribution tarball and run |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
815 the following as user "roundup":: |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
816 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
817 python setup.py build_doc |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
818 python setup.py sdist --manifest-only |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
819 python setup.py install --home="/home/roundup/install" --force |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
820 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
821 Create a user roundup-foo, group roundup-foo to run the tracker. Add |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
822 the following apache config to |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
823 /etc/apache2/sites-available/roundup-foo (under debian/Ubunutu, modify |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
824 as needed): |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
825 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
826 .. code:: xml |
|
3736
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
827 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
828 ServerAdmin webmaster@example.com |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
829 ErrorLog /var/log/apache2/error.log |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
830 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
831 LogLevel notice |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
832 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
833 DocumentRoot /var/www/ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
834 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
835 <VirtualHost *:80> |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
836 CustomLog /var/log/apache2/access.log vhost_combined |
|
3736
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
837 |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
838 # allow access to roundup docs |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
839 Alias /doc/ /home/roundup/install/share/doc/roundup/html/ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
840 |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
841 # make apache serve static assets like css rather than |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
842 # having roundup serve the files |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
843 Alias /foo/@@file/ /srv/roundup/foo/html/ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
844 |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
845 # make /foo into /foo/ |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
846 RedirectMatch permanent ^/(foo)$ /$1/ |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
847 |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
848 # start a wsgi daemon process running as user roundup-foo |
|
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
849 # in group roundup-foo. This also changes directory to |
|
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
850 # ~roundup-foo before it starts roundup.wsgi. |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
851 WSGIDaemonProcess roundup-foo display-name=roundup-foo user=roundup-foo group=roundup-foo threads=25 |
|
3736
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
852 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
853 # make tracker available at /foo and tie it into the |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
854 # wsgi script below. |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
855 WSGIScriptAlias /foo /srv/roundup/foo/roundup.wsgi |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
856 <Location /foo> |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
857 WSGIProcessGroup roundup-foo |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
858 </Location> |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
859 </VirtualHost> |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
860 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
861 The directory ~roundup-foo should have: |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
862 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
863 * a ``db`` subdirectory where messages and files will be stored |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
864 * a symbolic link called ``instance`` to /srv/roundup/foo which has |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
865 been initialized using ``roundup-admin``. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
866 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
867 The `Apache HTTP Server with mod_wsgi`_ section above has a simple |
|
5910
aec362e31fcd
doc/installation.txt: fix typo
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5909
diff
changeset
|
868 WSGI handler. This is an enhanced version to be put into |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
869 ``/srv/roundup/foo/roundup.wsgi``. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
870 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
871 .. code:: python |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
872 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
873 import sys, os |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
874 sys.stdout = sys.stderr |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
875 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
876 enabled = True |
|
3736
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
877 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
878 if enabled: |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
879 # Add the directory with the roundup installation |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
880 # subdirectory to the python path. |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
881 sys.path.insert(0, '/home/roundup/install/lib/python') |
|
3736
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
882 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
883 # obtain the WSGI request dispatcher |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
884 from roundup.cgi.wsgi_handler import RequestDispatcher |
|
5911
133efe1fbff7
doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents:
5910
diff
changeset
|
885 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
886 tracker_home = os.path.join(os.getcwd(), 'instance') |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
887 application = RequestDispatcher(tracker_home) |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
888 else: |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
889 def application(environ, start_response): |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
890 status = '503 Service Unavailable' |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
891 output = 'service is down for maintenance' |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
892 response_headers = [('Content-type', 'text/plain'), |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
893 ('Content-Length', str(len(output)))] |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
894 start_response(status, response_headers) |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
895 return [output] |
|
3736
a2d22d0de0bc
WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents:
3731
diff
changeset
|
896 |
|
5908
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
897 This handler allows you to temporarily disable the tracker by setting |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
898 "enabled = False", apache will automatically detect the changed |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
899 roundup.wsgi file and reload it. |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
900 |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
901 One last change is needed. In the tracker's config.ini change the db |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
902 parameter in the [main] section to be /home/roundup-foo/db. This will |
|
c7ab00dd6502
First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents:
5891
diff
changeset
|
903 put the files and messages in the db directory for the user. |
| 1228 | 904 |
|
5938
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
905 Gunicorn Installation |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
906 ^^^^^^^^^^^^^^^^^^^^^ |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
907 |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
908 To run with gunicorn use pip to install gunicorn. This configuration |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
909 uses a front end web server like nginx, hiawatha, apache configured as |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
910 a reverse proxy. See your web server's documentation on how to set it |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
911 up as a reverse proxy. |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
912 |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
913 The file wsgi.py should be in the current directory with the |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
914 contents:: |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
915 |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
916 # if roundup is not installed on the default PYTHONPATH |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
917 # set it here with: |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
918 import sys |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
919 sys.path.append('/path/to/roundup/install/directory') |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
920 |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
921 # obtain the WSGI request dispatcher |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
922 from roundup.cgi.wsgi_handler import RequestDispatcher |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
923 tracker_home = '/path/to/tracker/install/directory' |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
924 |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
925 app = RequestDispatcher(tracker_home) |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
926 |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
927 Assuming the proxy forwards /tracker, run gunicorn as:: |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
928 |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
929 SCRIPT_NAME=/tracker gunicorn --bind 127.0.0.1:8917 --timeout=10 wsgi:app |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
930 |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
931 this runs roundup at port 8917 on the loopback interface. You should |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
932 configure the reverse proxy to talk to 127.0.0.1 at port 8917. |
|
16eec1c41e0e
Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents:
5911
diff
changeset
|
933 |
| 1228 | 934 Configure an Email Interface |
| 935 ---------------------------- | |
| 936 | |
| 937 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
|
938 "``nosyreaction.py``" module from your tracker "``detectors``" directory. |
| 1228 | 939 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
940 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
|
941 |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
942 There are five supported ways to get emailed issues into the |
| 1228 | 943 Roundup tracker. You should pick ONE of the following, all |
| 944 of which will continue my example setup from above: | |
| 945 | |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
946 As a mail alias pipe process |
| 1228 | 947 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 948 | |
| 949 Set up a mail alias called "issue_tracker" as (include the quote marks): | |
| 3524 | 950 "``|/usr/bin/python /usr/bin/roundup-mailgw <tracker_home>``" |
| 951 (substitute ``/usr/bin`` for wherever roundup-mailgw is installed). | |
| 1228 | 952 |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
953 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
|
954 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
|
955 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
|
956 and change the command to:: |
| 1228 | 957 |
| 958 |roundup-mailgw /opt/roundup/trackers/support | |
|
3799
ac4da2670516
trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3797
diff
changeset
|
959 |
| 1228 | 960 To test the mail gateway on unix systems, try:: |
| 961 | |
| 962 echo test |mail -s '[issue] test' support@YOUR_DOMAIN_HERE | |
| 963 | |
|
3722
41feeed84caa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3666
diff
changeset
|
964 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
|
965 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
|
966 limit. *This can cause your Roundup database to become corrupted.* |
|
41feeed84caa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3666
diff
changeset
|
967 |
|
41feeed84caa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3666
diff
changeset
|
968 |
|
3447
83e358352e6e
minor correction to recent addition by Faheem Mitha
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3446
diff
changeset
|
969 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
|
970 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
971 |
|
3446
2325b221bf47
link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3444
diff
changeset
|
972 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
|
973 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
|
974 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
|
975 included, since Exim3 is considered obsolete. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
976 |
|
3446
2325b221bf47
link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3444
diff
changeset
|
977 .. _Exim 4: http://www.exim.org/ |
|
2325b221bf47
link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3444
diff
changeset
|
978 |
|
3444
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
979 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
|
980 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
|
981 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
|
982 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
983 * 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
|
984 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
|
985 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
|
986 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
|
987 user ``roundup``. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
988 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
989 * 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
|
990 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
|
991 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
|
992 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
|
993 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
|
994 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
|
995 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
996 The matching is done in the line:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
997 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
998 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
|
999 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1000 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
|
1001 Exim4. |
|
3444
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1002 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1003 .. note:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1004 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
|
1005 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
|
1006 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
|
1007 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
|
1008 ``/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
|
1009 system with Exim4 installed. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1010 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1011 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
|
1012 README.Debian in |
|
5756
e48b039b0ec0
issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents:
5610
diff
changeset
|
1013 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=343283, which will |
|
3444
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1014 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
|
1015 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1016 This config makes a few assumptions: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1017 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1018 * 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
|
1019 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
|
1020 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
|
1021 ``/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
|
1022 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1023 * 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
|
1024 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
|
1025 user, in this case, 'roundup'. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1026 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1027 * 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
|
1028 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
|
1029 in 0.8 from ``config.py``). |
|
3444
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1030 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1031 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
|
1032 section of the Exim4 config:: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1033 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1034 # Home dir for your Roundup installation |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1035 ROUNDUP_HOME=/var/lib/roundup/trackers |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1036 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1037 # User and group for Roundup. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1038 ROUNDUP_USER=roundup |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1039 ROUNDUP_GROUP=roundup |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1040 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1041 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
|
1042 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
|
1043 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1044 roundup_router: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1045 driver = accept |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1046 # 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
|
1047 # 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
|
1048 # to be present too. |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1049 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
|
1050 transport = roundup_transport |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1051 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1052 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
|
1053 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
|
1054 |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1055 roundup_transport: |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1056 driver = pipe |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1057 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
|
1058 current_directory = ROUNDUP_HOME |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1059 home_directory = ROUNDUP_HOME |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1060 user = ROUNDUP_USER |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1061 group = ROUNDUP_GROUP |
|
0da93b338457
exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3421
diff
changeset
|
1062 |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
1063 As a regular job using a mailbox source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
1064 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 1065 |
|
3405
292fbed108ca
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3335
diff
changeset
|
1066 Set ``roundup-mailgw`` up to run every 10 minutes or so. For example |
| 3524 | 1067 (substitute ``/usr/bin`` for wherever roundup-mailgw is installed):: |
| 1228 | 1068 |
| 3524 | 1069 0,10,20,30,40,50 * * * * /usr/bin/roundup-mailgw /opt/roundup/trackers/support mailbox <mail_spool_file> |
| 1228 | 1070 |
| 1071 Where the ``mail_spool_file`` argument is the location of the roundup submission | |
| 1072 user's mail spool. On most systems, the spool for a user "issue_tracker" | |
| 1073 will be "``/var/mail/issue_tracker``". | |
| 1074 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
1075 As a regular job using a POP source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
1076 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 1077 |
|
3405
292fbed108ca
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3335
diff
changeset
|
1078 To retrieve from a POP mailbox, use a *cron* entry similar to the mailbox |
| 3524 | 1079 one (substitute ``/usr/bin`` for wherever roundup-mailgw is |
|
3405
292fbed108ca
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3335
diff
changeset
|
1080 installed):: |
| 1228 | 1081 |
| 3524 | 1082 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
|
1083 |
| 1228 | 1084 where pop_spec is "``username:password@server``" that specifies the roundup |
| 1085 submission user's POP account name, password and server. | |
| 1086 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
1087 On windows, you would set up the command using the windows scheduler. |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
1088 |
|
2211
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
1089 As a regular job using an IMAP source |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
1090 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
1091 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
1092 To retrieve from an IMAP mailbox, use a *cron* entry similar to the |
| 3524 | 1093 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
|
1094 installed):: |
|
2211
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
1095 |
| 3524 | 1096 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
|
1097 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
1098 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
|
1099 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
|
1100 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
|
1101 "``imap username:password@server mailbox``". |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
1102 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
1103 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
|
1104 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
|
1105 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
1106 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
|
1107 windows scheduler. |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
1108 |
| 1228 | 1109 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
1110 UNIX Environment Steps |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
1111 ---------------------- |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1112 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
1113 Each tracker ideally should have its own UNIX group, so create |
| 1049 | 1114 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if |
| 1115 you're using NIS). To continue with my examples so far, I would | |
| 1116 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
|
1117 group does not have to be the same as the tracker name. To this |
| 1049 | 1118 '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
|
1119 working with this Roundup tracker. In addition to 'real' users, |
| 1049 | 1120 the Roundup email gateway will need to have permissions to this |
| 1121 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
|
1122 group (typically "mail" or "daemon"). The UNIX group might then |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1123 look like:: |
| 1049 | 1124 |
| 1125 support:*:1002:jblaine,samh,geezer,mail | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1126 |
| 1049 | 1127 If you intend to use the web interface (as most people do), you |
| 1128 should also add the username your web server runs as to the group. | |
| 1129 My group now looks like this:: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1130 |
| 1049 | 1131 support:*:1002:jblaine,samh,geezer,mail,apache |
| 1132 | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
1133 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
|
1134 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
|
1135 by the group. |
|
344bad728d10
more tweakage of help display and style issues
Richard Jones <richard@users.sourceforge.net>
parents:
1049
diff
changeset
|
1136 |
|
2594
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
1137 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
|
1138 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
|
1139 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
|
1140 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
|
1141 in ``rdbms`` -> ``user`` and ``password`` in ``config.ini``. |
|
2594
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
1142 |
| 1049 | 1143 An alternative to the above is to create a new user who has the sole |
| 1144 responsibility of running roundup. This user: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1145 |
| 1049 | 1146 1. runs the CGI interface daemon |
| 1147 2. runs regular polls for email | |
| 1148 3. runs regular checks (using cron) to ensure the daemon is up | |
| 1149 4. optionally has no login password so that nobody but the "root" user | |
| 1150 may actually login and play with the roundup setup. | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1151 |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3736
diff
changeset
|
1152 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
|
1153 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
|
1154 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
|
1155 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
|
1156 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
|
1157 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1158 |
|
3830
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
1159 Public Tracker Considerations |
|
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
1160 ----------------------------- |
|
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
1161 |
|
a48c514c465f
Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents:
3814
diff
changeset
|
1162 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
|
1163 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
|
1164 |
|
5300
d8ed32b297e2
Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents:
5140
diff
changeset
|
1165 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
|
1166 `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
|
1167 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
|
1168 |
|
2069
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
1169 |
| 1228 | 1170 Maintenance |
| 1171 =========== | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1172 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
1173 Read the separate `administration guide`_ for information about how to |
| 1228 | 1174 perform common maintenance tasks with Roundup. |
| 1049 | 1175 |
|
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
|
1176 |
|
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
|
1177 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
|
1178 ========= |
|
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
|
1179 |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
1180 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
|
1181 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
|
1182 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
|
1183 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1184 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1185 Further Reading |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1186 =============== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1187 |
|
3528
762d65fefea5
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3524
diff
changeset
|
1188 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
|
1189 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
|
1190 like implementation details, you should read `Customising Roundup`_. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1191 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1192 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
1193 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
|
1194 ========================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
1195 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
1196 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
|
1197 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
|
1198 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
|
1199 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
1200 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
|
1201 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
|
1202 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
|
1203 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
|
1204 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
|
1205 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
|
1206 "issue" class, but with different properties. See the customisation |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
1207 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
|
1208 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
1209 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1210 Platform-Specific Notes |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1211 ======================= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1212 |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1213 Windows command-line tools |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1214 -------------------------- |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1215 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1216 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
|
1217 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
|
1218 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1219 On Windows 2000 and later: |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1220 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1221 1) Press the "Start" button. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1222 2) Choose "Settings" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1223 3) Choose "Control Panel" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1224 4) Choose "System" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1225 5) Choose "Advanced" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1226 6) Choose "Environmental Variables" |
|
1746
9c1da921cd35
minor rest tweak
Richard Jones <richard@users.sourceforge.net>
parents:
1688
diff
changeset
|
1227 7) Add: "<dir>\Scripts" to the "Path" environmental variable. |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1228 |
| 1747 | 1229 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
|
1230 of your Python installation. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1231 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1232 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
|
1233 Panel" is directly accessible from "Start". |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1234 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1235 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
|
1236 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1237 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1238 Windows Server |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
1239 -------------- |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
1240 |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1241 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
|
1242 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
|
1243 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1244 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1245 1. Using the Windows scheduler |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1247 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1248 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
|
1249 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
|
1250 |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1251 **Run** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1252 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1253 ``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
|
1254 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1255 **Start In** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1256 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1257 ``C:\cygwin\opt\roundup\bin`` |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1258 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1259 **Schedule** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1260 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1261 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
|
1262 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
1263 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
|
1264 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
|
1265 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1266 **Run** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1267 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1268 ``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
|
1269 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1270 **Start In** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1271 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1272 ``C:\cygwin\opt\roundup\bin`` |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1273 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1274 **Schedule** |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1275 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1276 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
|
1277 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1278 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
|
1279 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1280 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1281 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
|
1282 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1283 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1284 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
|
1285 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
|
1286 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
|
1287 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1288 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
|
1289 relevant settings. |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1576
diff
changeset
|
1290 |
|
3797
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1291 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
|
1292 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
|
1293 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1294 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
|
1295 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1296 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
|
1297 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
|
1298 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
|
1299 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1300 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
|
1301 (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
|
1302 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
|
1303 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1304 [trackers] |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1305 software = C:\DATA\Roundup\Software |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1306 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1307 (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
|
1308 ``C:\DATA\Roundup\Software``) |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1309 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1310 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
|
1311 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1312 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
|
1313 roundup-server -c start |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1314 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1315 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
|
1316 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
|
1317 automatically instead of manually. |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1318 |
|
bb6e8fafa341
Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents:
3794
diff
changeset
|
1319 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
|
1320 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
|
1321 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
|
1322 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
1323 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1324 Sendmail smrsh |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1325 -------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1326 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1327 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
|
1328 smrsh that roundup-mailgw is a valid/trusted mail handler |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1329 before it will work. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1330 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1331 This is usually done via the following 2 steps: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1332 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1333 1. make a symlink in ``/etc/smrsh`` called ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1334 which points to the full path of your actual ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1335 script. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1336 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
1337 2. change your alias to ``"|roundup-mailgw <tracker_home>"`` |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1338 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1339 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1340 Linux |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1341 ----- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1342 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
1343 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
|
1344 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1345 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1346 Solaris |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1347 ------- |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1348 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1349 You'll need to build Python. |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1350 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
1351 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
|
1352 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
1353 |
|
2972
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1354 Problems? Testing your Python... |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1355 ================================ |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1356 |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1357 .. note:: |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1358 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
|
1359 - users of the Windows installer, other binary distributions or |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1360 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
|
1361 |
|
4317
15834821b8c7
- fix explicit python version description...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents:
4315
diff
changeset
|
1362 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
|
1363 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
|
1364 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
|
1365 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
|
1366 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
|
1367 ``-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
|
1368 |
|
2972
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1369 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
|
1370 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
|
1371 please let us know! |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1372 |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1373 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
|
1374 ``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
|
1375 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
|
1376 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
|
1377 from installation and scripts. |
|
2972
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1378 |
|
dd558120d927
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2945
diff
changeset
|
1379 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1380 .. _`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
|
1381 .. _`user guide`: user_guide.html |
|
4949
c3a90535f7a7
Backed out changeset 4a3a35192ad1
John Rouillard <rouilj@ieee.org>
parents:
4948
diff
changeset
|
1382 .. _`roundup specification`: spec.html |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
1383 .. _`tracker configuration`: customizing.html#tracker-configuration |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
1384 .. _`customisation documentation`: customizing.html |
|
5300
d8ed32b297e2
Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents:
5140
diff
changeset
|
1385 .. _`preventing spam`: customizing.html#preventing-spam |
|
2161
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
1386 .. _`Adding a new field to the classic schema`: |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
1387 customizing.html#adding-a-new-field-to-the-classic-schema |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
1388 .. _`Tracking different types of issues`: |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
1389 customizing.html#tracking-different-types-of-issues |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1390 .. _`customising roundup`: customizing.html |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
1391 .. _`upgrading document`: upgrading.html |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
1392 .. _`administration guide`: admin_guide.html |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1393 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1394 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1395 .. _External hyperlink targets: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1396 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
1397 .. _apache: http://httpd.apache.org/ |
|
5337
01dabc0483b0
more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents:
5321
diff
changeset
|
1398 .. _flup: https://pypi.org/project/flup/ |
|
5756
e48b039b0ec0
issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents:
5610
diff
changeset
|
1399 .. _mod_python: http://modpython.org/ |
|
5891
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5878
diff
changeset
|
1400 .. _mod_wsgi: https://pypi.org/project/mod-wsgi/ |
|
5510
e2978ed3b550
update link to new mysqlclient module and recommend update in upgrading.txt
Christof Meerwald <cmeerw@cmeerw.org>
parents:
5494
diff
changeset
|
1401 .. _MySQLdb: https://pypi.org/project/mysqlclient/ |
|
5756
e48b039b0ec0
issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents:
5610
diff
changeset
|
1402 .. _Psycopg: http://initd.org/psycopg/ |
|
e48b039b0ec0
issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents:
5610
diff
changeset
|
1403 .. _pysqlite: https://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
|
1404 .. _`adding MySQL users`: |
|
5756
e48b039b0ec0
issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents:
5610
diff
changeset
|
1405 https://dev.mysql.com/doc/refman/8.0/en/adding-users.html |