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