Mercurial > p > roundup > code

annotate doc/installation.txt @ 6774:e7b4ad2c57ac

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
landmarks, skiplink, remove bad attrs, autocomplete search layout.html: Add main and nav landmarks to layout templte. Add skiplink to get to main. Remove Description meta tag from layout template in favor of description metadata in individual files. Remove obsolete border attribute from sourceforge logo. Add autocomplete="on" attribute for search input box. doc/*.txt Remove language attribute from description meta tags. These changes also occur for other files not in this commit. Thse other files have changes to files for the 2.2.0 release not yet tobe committed.
author John Rouillard <rouilj@ieee.org>
date Tue, 12 Jul 2022 15:00:30 -0400
parents eb6cd0867ead
children a24ec63759f6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6586
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6581
diff changeset
1 .. meta::
6774
e7b4ad2c57ac landmarks, skiplink, remove bad attrs, autocomplete search
John Rouillard <rouilj@ieee.org>
parents: 6769
diff changeset
2 :description:
6586
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6581
diff changeset
3 Everything about installing the Roundup issue tracker web and
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6581
diff changeset
4 mail interfaces and configuring a tracker. How to download and
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6581
diff changeset
5 demonstrate Roundup using using command line or
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6581
diff changeset
6 Docker. Optional software that adds functionality to Roundup.
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6581
diff changeset
7
6168
de9d602c8ce6 more index entries and CHANGES.txt update for them.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
8 .. index:: Installation
de9d602c8ce6 more index entries and CHANGES.txt update for them.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
9
688
b38f4f95bffd More doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents: 686
diff changeset
10 ==================
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 Installing Roundup
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
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
14 .. contents::
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
15 :depth: 3
4890
609edf9de0a5 docs: Remove one nesting level from ToC on subpages
anatoly techtonik <techtonik@gmail.com>
parents: 4792
diff changeset
16 :local:
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 Overview
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 ========
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 Broken out separately, there are several conceptual pieces to a
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 Roundup installation:
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24
1221
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
25 Roundup trackers
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
26 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
27 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
28 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
29 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
30 `choosing your template`_.
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
31
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32 Roundup support code
3297
8f7dc283bfa5 some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents: 3296
diff changeset
33 Installed into your Python install's lib directory.
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 Roundup scripts
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 These include the email gateway, the roundup
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 HTTP server, the roundup administration command-line interface, etc.
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents: 1170
diff changeset
39
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 Prerequisites
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 =============
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42
5526
df3f553fa414 Update documentation for Python 3 support (issue 2550968, issue 2550980).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5510
diff changeset
43 Roundup requires Python 2.7 or 3.4 or newer with a functioning
5756
e48b039b0ec0 issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents: 5610
diff changeset
44 anydbm module. Download the latest version from https://www.python.org/.
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1939
diff changeset
45 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
46 of python as these contain many fixes to serious bugs.
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47
3421
0d9406d14186 MySQL now creates String columns using the TEXT column type
Richard Jones <richard@users.sourceforge.net>
parents: 3417
diff changeset
48 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
49 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
50 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
51
3296
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
52 Optional Components
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
53 ===================
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
54
3297
8f7dc283bfa5 some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents: 3296
diff changeset
55 You may optionally install and use:
3296
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
56
3623
bef78d81b79c added optional prerequisite: pytz
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3571
diff changeset
57 Timezone Definitions
3731
e6ef9abfe403 fix pytz requirement version and download URL for latest package
Richard Jones <richard@users.sourceforge.net>
parents: 3730
diff changeset
58 Full timezone support requires pytz_ module (version 2005i or later)
3730
8e3b881060b4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3729
diff changeset
59 which brings the `Olson tz database`_ into Python. If pytz_ is not
8e3b881060b4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3729
diff changeset
60 installed, timezones may be specified as numeric hour offsets only.
5140
7ea6bbf4286c update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
61 This is optional but strongly suggested.
5321
4566360871dc Raises python requirement to 2.7.
Bernhard Reiter <bernhard@intevation.de>
parents: 5300
diff changeset
62
3296
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
63 An RDBMS
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
64 Sqlite, MySQL and Postgresql are all supported by Roundup and will be
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
65 used if available. One of these is recommended if you are anticipating a
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
66 large user base (see `choosing your backend`_ below).
3297
8f7dc283bfa5 some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents: 3296
diff changeset
67
6174
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 6168
diff changeset
68 .. index:: roundup-admin:: reindex subcommand
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 6168
diff changeset
69
3296
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
70 Xapian full-text indexer
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
71 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
72 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
73 anticipating a large number of issues (> 5000).
3296
d5fa5a0b5216 some minimalist docs for Xapian
Richard Jones <richard@users.sourceforge.net>
parents: 3153
diff changeset
74
3297
8f7dc283bfa5 some more Xapian stuff (doc, test fixes)
Richard Jones <richard@users.sourceforge.net>
parents: 3296
diff changeset
75 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
76 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
77 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
78
4378
477f2a47cbca - Indexer Xapian, made Xapian 1.2 compatible.
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 4355
diff changeset
79 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
80
5108
67fad01d2009 issue2550653: xapian search, stemming is not working
John Rouillard <rouilj@ieee.org>
parents: 5096
diff changeset
81 Note that capitalization is not preserved by the Xapian search.
67fad01d2009 issue2550653: xapian search, stemming is not working
John Rouillard <rouilj@ieee.org>
parents: 5096
diff changeset
82 This is required to make the porter stemmer work so that searching
67fad01d2009 issue2550653: xapian search, stemming is not working
John Rouillard <rouilj@ieee.org>
parents: 5096
diff changeset
83 for silent also returns documents with the word silently. Note that
67fad01d2009 issue2550653: xapian search, stemming is not working
John Rouillard <rouilj@ieee.org>
parents: 5096
diff changeset
84 the current stemming implementation is designed for English.
67fad01d2009 issue2550653: xapian search, stemming is not working
John Rouillard <rouilj@ieee.org>
parents: 5096
diff changeset
85
5096
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
86 Whoosh full-text indexer
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
87 The Whoosh_ full-text indexer is also supported and will be used by
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
88 default if it is available (and Xapian is not installed). This is
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
89 recommended if you are anticipating a large number of issues (> 5000).
6576
c55d56ab9ee9 Document whoosh implements fuzzy search.
John Rouillard <rouilj@ieee.org>
parents: 6555
diff changeset
90 It is also the only search backend that implements fuzzy search. It
c55d56ab9ee9 Document whoosh implements fuzzy search.
John Rouillard <rouilj@ieee.org>
parents: 6555
diff changeset
91 matches any word that has a 1 character difference from the search term.
5096
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
92
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
93 You may install Whoosh at any time, even after a tracker has been
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
94 installed and used. You will need to run the "roundup-admin reindex"
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
95 command if the tracker has existing data.
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
96
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
97 Roundup was tested with Whoosh 2.5.7, but earlier versions in the
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
98 2.0 series may work. Whoosh is a pure python indexer so it is slower
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
99 than Xapian, but should be useful for moderately sized trackers.
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
100 It uses the StandardAnalyzer which is suited for Western languages.
e74c3611b138 - issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents: 5083
diff changeset
101
3885
d4163100f4f3 add pyopenssl to optional components
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3830
diff changeset
102 pyopenssl
d4163100f4f3 add pyopenssl to optional components
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3830
diff changeset
103 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
104 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
105 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
106 unnecessary.
d4163100f4f3 add pyopenssl to optional components
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3830
diff changeset
107
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5486
diff changeset
108 gpg
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5486
diff changeset
109 If gpg_ is installed you can configure the mail gateway to perform
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3885
diff changeset
110 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
111 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
112 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
113
5013
c1443d96ac94 jinja2: optional requirement added to installation.txt and link to wiki page.
Bernhard Reiter <bernhard@intevation.de>
parents: 4949
diff changeset
114 jinja2
c1443d96ac94 jinja2: optional requirement added to installation.txt and link to wiki page.
Bernhard Reiter <bernhard@intevation.de>
parents: 4949
diff changeset
115 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
116 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
117 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
118
5878
1b57d8f3eb97 Add rudimentery experiment JSON Web Token (jwt) support
John Rouillard <rouilj@ieee.org>
parents: 5756
diff changeset
119 pyjwt
6391
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
120 To use jwt tokens for login (experimental), install `pyjwt`_
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
121 (v1.7.1, v2.0.1 tested). If you don't have it installed, jwt
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
122 tokens are not supported.
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
123
6097
90a1470edbea added markdown rendering support using either markdown2 or markdown
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5940
diff changeset
124 docutils
6391
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
125 To use ReStructuredText rendering you need to have the `docutils`_
6097
90a1470edbea added markdown rendering support using either markdown2 or markdown
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5940
diff changeset
126 package installed.
90a1470edbea added markdown rendering support using either markdown2 or markdown
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5940
diff changeset
127
6099
55c56ceacb8e escape HTML tags in markdown content
Christof Meerwald <cmeerw@cmeerw.org>
parents: 6097
diff changeset
128 markdown, markdown2 or mistune
6391
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
129 To use markdown rendering you need to have the markdown_, markdown2_
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
130 or mistune_ (v0.8.4 tested) package installed.
6097
90a1470edbea added markdown rendering support using either markdown2 or markdown
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5940
diff changeset
131
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
132 zstd, brotli
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
133 To have roundup compress the returned data using one of these
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
134 algorithms, you can install one or more of zstd_ or brotli_.
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
135 Roundup's responses can always be compressed with gzip from the
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
136 Python standard library. Also nginx and various wsgi server can
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
137 compress the response from roundup as they transmit/proxy it to the
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
138 client.
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
139
4686
4e740f02e165 Remove pywin32 installation dependency by porting portalocker.py to ctypes.
anatoly techtonik <techtonik@gmail.com>
parents: 4672
diff changeset
140 Windows Service
4e740f02e165 Remove pywin32 installation dependency by porting portalocker.py to ctypes.
anatoly techtonik <techtonik@gmail.com>
parents: 4672
diff changeset
141 You can run Roundup as a Windows service if pywin32_ is installed.
5140
7ea6bbf4286c update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
142 Otherwise it must be started manually.
4686
4e740f02e165 Remove pywin32 installation dependency by porting portalocker.py to ctypes.
anatoly techtonik <techtonik@gmail.com>
parents: 4672
diff changeset
143
998
a1922b2521a7 reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents: 991
diff changeset
144 Getting Roundup
a1922b2521a7 reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents: 991
diff changeset
145 ===============
a1922b2521a7 reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents: 991
diff changeset
146
2742
8ac87d4092e2 more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents: 2741
diff changeset
147 .. note::
6629
6fe56720e13d Remove windows installer directions, update disrributions
John Rouillard <rouilj@ieee.org>
parents: 6619
diff changeset
148 Some systems, such as Gentoo and NetBSD, already have Roundup
2742
8ac87d4092e2 more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents: 2741
diff changeset
149 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
150 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
151 below and go straight to `configuring your first tracker`_.
6629
6fe56720e13d Remove windows installer directions, update disrributions
John Rouillard <rouilj@ieee.org>
parents: 6619
diff changeset
152 However they may install an old version, so you are probably
6fe56720e13d Remove windows installer directions, update disrributions
John Rouillard <rouilj@ieee.org>
parents: 6619
diff changeset
153 beter off installing it from the roundup web site or pypi.
2742
8ac87d4092e2 more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents: 2741
diff changeset
154
6265
b2eb59ada444 Replace http:....roundup-tracker.org with https. Also fix wiki links.
John Rouillard <rouilj@ieee.org>
parents: 6262
diff changeset
155 Download the latest version from https://www.roundup-tracker.org/.
998
a1922b2521a7 reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents: 991
diff changeset
156
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
157 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
158 ========================
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
159
4688
80f9a1fbc0cc doc: Remove WinZip tutorial and mention demo.py becoming 'roundup-demo'
anatoly techtonik <techtonik@gmail.com>
parents: 4686
diff changeset
160 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
161 and run ``demo.py`` (it will be available as ``roundup-demo`` script
6738
966263ad45ea Document how to run if there is no python3.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
162 after installation). (On systems that don't provide a ``python3``
966263ad45ea Document how to run if there is no python3.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
163 program you might need to run ``python demo.py``.)
2401
a405124c3847 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2258
diff changeset
164
3571
f0b1c8ff4a2a Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3528
diff changeset
165 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
166 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
167 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
168
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
169 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
170 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
171 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
172 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
173
3571
f0b1c8ff4a2a Note: demo runs on localhost
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3528
diff changeset
174 .. [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
175 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
176 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
177 your editor, change host name in the ``web`` option in section
6738
966263ad45ea Document how to run if there is no python3.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
178 ``[tracker]``, save the file, then re-run the demo.py program.
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
179
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
180 Installation
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
181 ============
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
182
2991
b9a55628a78d more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2988
diff changeset
183 Set aside 15-30 minutes. There's several steps to follow in your
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
184 installation:
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
185
1590
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
186 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
187 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
188 3. then optionally `configure a web interface`_
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
189 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
190 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
191 UNIX machine and want to restrict local access to roundup
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
192
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents: 1965
diff changeset
193 For information about how Roundup installs, see the `administration
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents: 1965
diff changeset
194 guide`_.
1965
43e1f2457bf2 info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents: 1939
diff changeset
195
6727
3f3ce3004013 issue2551206 - remove mention of roundup installer, fix up windows docs
John Rouillard <rouilj@ieee.org>
parents: 6663
diff changeset
196 The following assumes that you are using the source distribution.
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
197
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
198 Basic Installation Steps
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
199 ------------------------
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
200
6739
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
201 Installation of Roundup using Python3 in a virtual environment is
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
202 probably the path of least resistance. Use::
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
203
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
204 python3 -m venv /path/to/environment/roundup
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
205
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
206 then proceed as below after activating (assuming a Bourne like shell)
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
207 the Python environment using::
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
208
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
209 . /path/to/environment/roundup/bin/activate
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
210
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
211 then use the alias ``deactivate`` to return to the normal Python
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
212 environment. If you create the virtual envirnment as a non-root user,
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
213 you can install below using the same user.
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
214
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
215 To install the Roundup support code into your Python tree and Roundup
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
216 scripts into /usr/bin (substitute that path for whatever is
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
217 appropriate on your system). You need to have write permissions for
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
218 these locations, so you may need to run wthese commands with ``sudo``
00fe67eb8a91 Update locations templates and locale files are stored
John Rouillard <rouilj@ieee.org>
parents: 6738
diff changeset
219 if root permission is required::
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
220
1590
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
221 python setup.py install
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
222
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
223 If you would like to place the Roundup scripts in a directory other
3524
ed82c2c6ee34 fix doc
Richard Jones <richard@users.sourceforge.net>
parents: 3523
diff changeset
224 than ``/usr/bin``, then specify the preferred location with
3949
29dfb873b32e Small documentation cleanup
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3935
diff changeset
225 ``--install-scripts``. For example, to install them in
1590
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
226 ``/opt/roundup/bin``::
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
227
1590
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
228 python setup.py install --install-scripts=/opt/roundup/bin
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
229
1590
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
230 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
231 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
232 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
233 yourself.
1282
2feb3e0a9955 included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents: 1245
diff changeset
234
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
235 Docker Support
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
236 ~~~~~~~~~~~~~~
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
237
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
238 If you don't want to install it natively, you can create a Docker
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
239 container. This installs roundup using the `stand-alone web server`_
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
240 method. This is an http only install so we suggest putting an https
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
241 terminating proxy in front of it.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
242
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
243 This is a work in progress and patches to improve it are welcome. You
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
244 can find the docker config files under the `scripts/Docker` directory
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
245 of the source tree.
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
246
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
247 The dockerized Roundup includes database drivers for anydbm, sqlite,
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
248 MySQL and Postgresql (Postgresl is untested). It also includes
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
249 additional libraries that are listed in
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
250 `scripts/Docker/requirements.txt`.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
251
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
252 Email support is a work in progress. Outgoing email should work given
6769
eb6cd0867ead spelling fix.
John Rouillard <rouilj@ieee.org>
parents: 6766
diff changeset
253 an external SMTP server. Receiving email should work by using a
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
254 scheduled (cron) job to access email:
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
255
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
256 * `As a regular job using a mailbox source`_
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
257 * `As a regular job using a POP source`_
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
258 * `As a regular job using an IMAP source`_
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
259
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
260 Patches for better email support are welcome.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
261
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
262 If you want to use a MySQL backend, the `docker-compose.yml` file will
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
263 deploy a Roundup container and a MySQL container backend for use with
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
264 Roundup.
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
265
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
266 Building a Docker Container
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
267 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
268
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
269 To build a docker container using the code in the current directory,
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
270 run this build command from the top of the source tree::
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
271
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
272 docker build -t roundup-app -f scripts/Docker/Dockerfile .
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
273
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
274 You can also build a container using the newest Roundup release on
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
275 PyPI, by running::
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
276
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
277 docker build -t roundup-app --build-arg="source=pypi" \
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
278 -f scripts/Docker/Dockerfile .
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
279
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
280 The docker declares a single volume mounted at
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
281 ``/usr/src/app/tracker`` inside the container. You will mount your
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
282 tracker home directory at this location.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
283
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
284
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
285 Configuring Roundup in the Container
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
286 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
287
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
288 Once the docker is created using one of the build commands above, run
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
289 an interactive session it with::
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
290
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
291 docker run -it --rm -p 9017:8080 \
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
292 -v $PWD/tracker:/usr/src/app/tracker roundup-app:latest
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
293
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
294 The ``-v`` option maps a directory from the host into the docker
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
295 container. Note that uid 1000 is used by roundup. So the uid of the
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
296 directory (and all files under it) must be uid 1000. This example
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
297 assumes your tracker configs are in the tracker subdirectory. Replace
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
298 ``$PWD/tracker`` with the full path name to the directory where the
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
299 tracker home(s) are to be stored.
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
300
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
301 The ``-p`` option maps an external port (9017) to proxy the roundup
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
302 server running at port 8080 to the outside.
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
303
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
304 If the tracker directory is empty, the docker container will prompt
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
305 you to install a tracker template and prompt you for the database
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
306 type.
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
307
6581
b5fb268b7f04 Docker installation doc improved and switchable debugging
John Rouillard <rouilj@ieee.org>
parents: 6576
diff changeset
308 Then you need to configure the tracker by editing
b5fb268b7f04 Docker installation doc improved and switchable debugging
John Rouillard <rouilj@ieee.org>
parents: 6576
diff changeset
309 ``template/config.ini``. Make sure that the tracker web setting ends
b5fb268b7f04 Docker installation doc improved and switchable debugging
John Rouillard <rouilj@ieee.org>
parents: 6576
diff changeset
310 in ``/issues/`` See `Configuring your first tracker` and the top of
b5fb268b7f04 Docker installation doc improved and switchable debugging
John Rouillard <rouilj@ieee.org>
parents: 6576
diff changeset
311 ``config.ini`` for other settings.
b5fb268b7f04 Docker installation doc improved and switchable debugging
John Rouillard <rouilj@ieee.org>
parents: 6576
diff changeset
312
b5fb268b7f04 Docker installation doc improved and switchable debugging
John Rouillard <rouilj@ieee.org>
parents: 6576
diff changeset
313 Once you have configured the tracker, run another interactive session
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
314 with::
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
315
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
316 docker run --rm -it -p 9017:8080 \
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
317 -v $PWD/tracker:/usr/src/app/tracker roundup-app:latest
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
318
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
319 this will initialize the database and attempt to start the server. If
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
320 that is successful, use control-c to exit the server.
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
321
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
322 Now start the server non-interactively (note no `-it` option) with::
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
323
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
324 docker run -p 9017:8080 \
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
325 -v $PWD/tracker:/usr/src/app/tracker roundup-app:latest
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
326
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
327 Your tracker will be available at: ``http://yourhost:9017/issues/``.
6522
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
328
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
329 If you need to access your container while the server is running you
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
330 can use::
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
331
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
332 docker exec -it c0d5 sh
e6ae8188f61a issue2551163 Docker/containerization support
John Rouillard <rouilj@ieee.org>
parents: 6458
diff changeset
333
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
334 where ``c0d5`` is the id prefix for the running container obtained
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
335 from ``docker container ls``.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
336
6581
b5fb268b7f04 Docker installation doc improved and switchable debugging
John Rouillard <rouilj@ieee.org>
parents: 6576
diff changeset
337 If you add ``-e SHELL_DEBUG=1`` to the docker command, it sets the
b5fb268b7f04 Docker installation doc improved and switchable debugging
John Rouillard <rouilj@ieee.org>
parents: 6576
diff changeset
338 ``SHELL_DEBUG`` environment variable which will enable debugging
b5fb268b7f04 Docker installation doc improved and switchable debugging
John Rouillard <rouilj@ieee.org>
parents: 6576
diff changeset
339 output from the startup script.
b5fb268b7f04 Docker installation doc improved and switchable debugging
John Rouillard <rouilj@ieee.org>
parents: 6576
diff changeset
340
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
341 Non-Guided Installation
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
342 '''''''''''''''''''''''
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
343
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
344 If you got a tracker installed using the automatic setup above, you
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
345 can skip this section. To manually install and initialize the
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
346 trackers, you can get a shell without starting the roundup-server
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
347 using::
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
348
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
349 docker run -it \
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
350 -v $PWD/tracker:/usr/src/app/tracker \
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
351 --entrypoint sh roundup-app:latest
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
352
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
353 Now you can configure your tracker using ``roundup-admin -i tracker``
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
354 using the directions for `Configuring your first tracker`.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
355
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
356 Defining Multiple Trackers
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
357 ^^^^^^^^^^^^^^^^^^^^^^^^^^
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
358
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
359 If you want to run multiple trackers, create a subdirectory for each
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
360 tracker home under the volume mount point (``$PWD/tracker``). Then
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
361 invoke ``docker run`` passing the roundup-server tracker
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
362 specifications like::
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
363
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
364 docker run --rm -p 9017:8080 \
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
365 -v /.../issue.tracker:/usr/src/app/tracker \
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
366 roundup-app:latest tracker1=tracker/tracker1_home \
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
367 tracker2=tracker/tracker2_home
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
368
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
369 This will set up two trackers that can be reached at
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
370 ``http://yourhost:9017/tracker1/`` and ``http://yourhost:9017/tracker2/``.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
371 The arguments after roundup-app:latest are tracker paths that are
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
372 passed to roundup-server.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
373
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
374 Docker-compose Deployment
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
375 ^^^^^^^^^^^^^^^^^^^^^^^^^
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
376
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
377 If you want to run using the mysql backend, you can use docker-compose
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
378 with ``scripts/Docker/docker-compose.yml``. This will run Roundup and
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
379 MySQL in containers. Directions for building using docker-compose are
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
380 at the top of the yml file.
1590
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
381
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
382 Configuring your first tracker
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
383 ------------------------------
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
384
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
385 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
386 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
387 home":
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
388
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
389 a. (Optional) If you intend to keep your roundup trackers
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
390 under one top level directory which does not exist yet,
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
391 you should create that directory now. Example::
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
392
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
393 mkdir /opt/roundup/trackers
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
394
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
395 b. Either add the Roundup script location to your ``PATH``
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
396 environment variable or specify the full path to
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
397 the command in the next step.
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
398
6174
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 6168
diff changeset
399 .. index:: roundup-admin; install subcommand
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 6168
diff changeset
400
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
401 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
402 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
403 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
404 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
405 below. The questions will be something like (you may have more
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
406 templates or backends available)::
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
407
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
408 Enter tracker home: /opt/roundup/trackers/support
6766
c27fc7f499c7 Update install with all current templates and mandatory backends.
John Rouillard <rouilj@ieee.org>
parents: 6739
diff changeset
409 Templates: minimal, jinja2, classic, responsive, devel
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
410 Select template [classic]: classic
6766
c27fc7f499c7 Update install with all current templates and mandatory backends.
John Rouillard <rouilj@ieee.org>
parents: 6739
diff changeset
411 Back ends: anydbm, sqlite
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
412 Select backend [anydbm]: anydbm
738
7e093cbaaa98 split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents: 729
diff changeset
413
2818
2317e43609cb remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2742
diff changeset
414 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
415 third-party database modules. Standard python distribution
6766
c27fc7f499c7 Update install with all current templates and mandatory backends.
John Rouillard <rouilj@ieee.org>
parents: 6739
diff changeset
416 includes anydbm and sqlite module only.
2818
2317e43609cb remove bsddb; suggest using sqlite better than metakit
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2742
diff changeset
417
1571
8b5ff6ca0674 more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
418 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
419 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
420 will be stored in.
8b5ff6ca0674 more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1560
diff changeset
421
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
422 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
423 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
424 (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
425 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
426 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
427 configuration`_ section of the `customisation documentation`_.
1245
d8c98af869ff merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents: 1244
diff changeset
428
1574
67af854f4c33 more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
429 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
430 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
431 "tracker :: web" variable to::
1244
8dd4f736370b merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents: 1240
diff changeset
432
3303
520eef0e0e91 fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents: 3297
diff changeset
433 web = http://localhost:8080/support/
1244
8dd4f736370b merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents: 1240
diff changeset
434
1310
ff7b08d9ceb5 more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents: 1300
diff changeset
435 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
436 See `Customising Roundup`_ for details on configuration and schema
2409
Richard Jones <richard@users.sourceforge.net>
parents: 2401
diff changeset
437 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
438 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
439 for this stuff now.
738
7e093cbaaa98 split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents: 729
diff changeset
440
6174
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 6168
diff changeset
441 .. index:: roundup-admin; initialise subcommand
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 6168
diff changeset
442
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
443 d. Initialise the tracker database with ``roundup-admin initialise``.
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
444 You will need to supply an admin password at this step. You will be
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
445 prompted::
738
7e093cbaaa98 split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents: 729
diff changeset
446
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
447 Admin Password:
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
448 Confirm:
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
449
2401
a405124c3847 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2258
diff changeset
450 Note: running this command will *destroy any existing data in the
4355
Richard Jones <richard@users.sourceforge.net>
parents: 4324
diff changeset
451 database*. In the case of MySQL and PostgreSQL, any existing database
2401
a405124c3847 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2258
diff changeset
452 will be dropped and re-created.
a405124c3847 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2258
diff changeset
453
4792
1a0cf0345465 issue2550789 document how to initialize a tracker without exposing the admin password
John Rouillard <rouilj@ieee.org>
parents: 4688
diff changeset
454 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
455 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
456 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
457 line.
738
7e093cbaaa98 split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents: 729
diff changeset
458
1590
198dbefc1d5a more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents: 1588
diff changeset
459 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
460 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
461 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
462 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
463 ``'http://localhost:8080/support/'``, run::
1244
8dd4f736370b merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents: 1240
diff changeset
464
1574
67af854f4c33 more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
465 roundup-server support=/opt/roundup/trackers/support
1244
8dd4f736370b merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents: 1240
diff changeset
466
8dd4f736370b merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents: 1240
diff changeset
467 then direct your web browser at:
8dd4f736370b merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents: 1240
diff changeset
468
1845
3c6dd167a744 Fix typo in server address [SF#822967].
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1839
diff changeset
469 http://localhost:8080/support/
1244
8dd4f736370b merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents: 1240
diff changeset
470
8dd4f736370b merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents: 1240
diff changeset
471 and you should see the tracker interface.
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
472
5138
c54720396f40 issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents: 5108
diff changeset
473 To run your tracker on some interface other than 127.0.0.1 and port
c54720396f40 issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents: 5108
diff changeset
474 8080 (make sure you change the "tracker :: web" changes to match) use::
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
475
5138
c54720396f40 issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents: 5108
diff changeset
476 roundup-server -p 1080 -n 0.0.0.0 support=/opt/roundup/trackers/support
c54720396f40 issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents: 5108
diff changeset
477
c54720396f40 issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents: 5108
diff changeset
478 to run the server at port 1080 and bind to all ip addresses on your system.
c54720396f40 issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents: 5108
diff changeset
479 Then direct your web browser to ``http://your_host_name:1080/support``.
5321
4566360871dc Raises python requirement to 2.7.
Bernhard Reiter <bernhard@intevation.de>
parents: 5300
diff changeset
480
1221
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
481 Choosing Your Template
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
482 ----------------------
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
483
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
484 Classic Template
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
485 ~~~~~~~~~~~~~~~~
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
486
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
487 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
488 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
489 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
490
1227
92d8e1aad2e9 added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents: 1221
diff changeset
491 Minimal Template
92d8e1aad2e9 added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents: 1221
diff changeset
492 ~~~~~~~~~~~~~~~~
92d8e1aad2e9 added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents: 1221
diff changeset
493
92d8e1aad2e9 added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents: 1221
diff changeset
494 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
495 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
496 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
497 create your tracker on.
92d8e1aad2e9 added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents: 1221
diff changeset
498
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
499 .. index:: database; choosing your backend
1221
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
500
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
501 Choosing Your Backend
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
502 ---------------------
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
503
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
504 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
505 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
506
2179
5aa74f9879ac rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents: 2161
diff changeset
507 ========== =========== ===== ==============================
5aa74f9879ac rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents: 2161
diff changeset
508 Name Speed Users Support
5aa74f9879ac rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents: 2161
diff changeset
509 ========== =========== ===== ==============================
5aa74f9879ac rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents: 2161
diff changeset
510 anydbm Slowest Few Always available
3729
60d3865b3cb6 grammar R us
Richard Jones <richard@users.sourceforge.net>
parents: 3728
diff changeset
511 sqlite Fastest(*) Few May need install (PySQLite_)
6663
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
512 postgresql Fast Many Needs install/admin (psycopg2_)
2179
5aa74f9879ac rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents: 2161
diff changeset
513 mysql Fast Many Needs install/admin (MySQLdb_)
5aa74f9879ac rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents: 2161
diff changeset
514 ========== =========== ===== ==============================
5aa74f9879ac rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents: 2161
diff changeset
515
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
516 **sqlite**
3935
1dab48842cbd Throwing up hands in resignation and finally deleting the metakit backend.
Richard Jones <richard@users.sourceforge.net>
parents: 3922
diff changeset
517 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
518 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
519 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
520 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
521
b476fef16ccc fixed support for pysqlite2 (version 2.1.0 is the minimum version supported)
Richard Jones <richard@users.sourceforge.net>
parents: 3722
diff changeset
522 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
523 being bundled with Python 2.5+)
3794
f5ddd1639a15 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
524
f5ddd1639a15 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3754
diff changeset
525 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
526 to work, 3.1.3 is known to have problems).
6588
91ab3e0ffcd0 Summary: Add test cases for sqlite fts
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
527
91ab3e0ffcd0 Summary: Add test cases for sqlite fts
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
528 Roundup supports using sqlite's full text search capability. This
91ab3e0ffcd0 Summary: Add test cases for sqlite fts
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
529 can improve searching if you are not installing another indexer like
91ab3e0ffcd0 Summary: Add test cases for sqlite fts
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
530 xapian or whoosh. It works best with English text.
2179
5aa74f9879ac rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents: 2161
diff changeset
531 **postgresql**
6663
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
532 Backend for popular RDBMS PostgreSQL. You must read
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
533 `doc/postgresql.txt`_ for additional installation steps and
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
534 requirements. You must also configure
3666
8304a1c1cc98 encourage use of latest psycopg
Richard Jones <richard@users.sourceforge.net>
parents: 3647
diff changeset
535 the ``rdbms`` section of your tracker's ``config.ini``. It is recommended
6663
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
536 that you use at least version 2.8 of psycopg2.
1507
3481507d6098 Advertising mysql
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1317
diff changeset
537 **mysql**
6663
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
538 Backend for popular RDBMS MySQL. You must read `doc/mysql.txt`_ for
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
539 additional installation steps and requirements. You must also
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
540 configure the ``rdbms`` section of your tracker's ``config.ini``
1221
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
541
2179
5aa74f9879ac rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents: 2161
diff changeset
542 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
543 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
544 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
545 guide`_.
1221
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
546
2401
a405124c3847 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2258
diff changeset
547 Regardless of which backend you choose, Roundup will attempt to initialise
6174
5522c950a2e4 Add indexing for roundup-admin references.
John Rouillard <rouilj@ieee.org>
parents: 6168
diff changeset
548 a new database for you when you run the "``roundup-admin initialise``" command.
2401
a405124c3847 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2258
diff changeset
549 In the case of MySQL and PostgreSQL you will need to have the appropriate
a405124c3847 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2258
diff changeset
550 privileges to create databases.
a405124c3847 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 2258
diff changeset
551
1221
778297033003 cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
552
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
553 Configure a Web Interface
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
554 -------------------------
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
555
5486
a5edd6adff14 Change count of number of ways to run roundup to "multiple".
John Rouillard <rouilj@ieee.org>
parents: 5367
diff changeset
556 There are multiple web interfaces to choose from:
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
557
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
558 .. contents::
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
559 :depth: 1
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
560 :local:
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
561
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
562 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
563 - 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
564 configure your system in some way - see `platform-specific notes`_.
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
565
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
566 .. index:: pair: web interface; cgi
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
567
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
568 Web Server cgi-bin
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
569 ~~~~~~~~~~~~~~~~~~
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
570
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
571 A benefit of using the cgi-bin approach is that it's the easiest way to
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
572 restrict access to your tracker to only use HTTPS. Access will be slower
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
573 than through the `stand-alone web server`_ though.
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
574
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3736
diff changeset
575 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
576 the ``roundup.cgi`` script to fix the first line.
0f2678eeeac6 cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents: 1747
diff changeset
577
1540
3e65577ad6d7 minor changes
Richard Jones <richard@users.sourceforge.net>
parents: 1528
diff changeset
578 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
579 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
580
3e65577ad6d7 minor changes
Richard Jones <richard@users.sourceforge.net>
parents: 1528
diff changeset
581 adsutil.vbs set w3svc/AllowPathInfoForScriptMappings TRUE
3e65577ad6d7 minor changes
Richard Jones <richard@users.sourceforge.net>
parents: 1528
diff changeset
582
3799
ac4da2670516 trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3797
diff changeset
583 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
584 or ``c:\winnt\system32\inetsrv\adminsamples\`` or
3e65577ad6d7 minor changes
Richard Jones <richard@users.sourceforge.net>
parents: 1528
diff changeset
585 ``c:\winnt\system32\inetsrv\adminscripts\`` depending on your installation.
3e65577ad6d7 minor changes
Richard Jones <richard@users.sourceforge.net>
parents: 1528
diff changeset
586
6370
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
587 See:
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
588
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
589 https://docs.microsoft.com/en-us/iis/web-dev-reference/server-variables
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
590
2988
f4023f1cc1d6 apply IE caching "fix" to automatically serve up all pages expired
Richard Jones <richard@users.sourceforge.net>
parents: 2979
diff changeset
591 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
592
6370
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
593 https://docs.microsoft.com/en-us/iis/
2988
f4023f1cc1d6 apply IE caching "fix" to automatically serve up all pages expired
Richard Jones <richard@users.sourceforge.net>
parents: 2979
diff changeset
594
3736
a2d22d0de0bc WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents: 3731
diff changeset
595 Copy the ``frontends/roundup.cgi`` file to your web server's ``cgi-bin``
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
596 directory. You will need to configure it to tell it where your tracker home
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
597 is. You can do this either:
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
598
3303
520eef0e0e91 fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents: 3297
diff changeset
599 Through an environment variable
520eef0e0e91 fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents: 3297
diff changeset
600 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
601 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
602
520eef0e0e91 fix installation docs referring to old-style configuration variables
Richard Jones <richard@users.sourceforge.net>
parents: 3297
diff changeset
603 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
604 Add your instance to the TRACKER_HOMES variable as ``'name': 'home'``
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
605
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
606 The "name" part of the configuration will appear in the URL and identifies the
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
607 tracker (so you may have more than one tracker per cgi-bin script). Make sure
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
608 there are no spaces or other illegal characters in it (to be safe, stick to
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
609 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
610 tracker config "tracker :: web" variable, so make sure they match. The "home"
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
611 part of the configuration is the tracker home directory.
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
612
2665
7d6dda802ca0 cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents: 2594
diff changeset
613 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
614 ``.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
615 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
616 couple lines to your Apache configuration::
3799
ac4da2670516 trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3797
diff changeset
617
2665
7d6dda802ca0 cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents: 2594
diff changeset
618 <Location /path/to/roundup>
7d6dda802ca0 cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents: 2594
diff changeset
619 SetHandler cgi-script
7d6dda802ca0 cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents: 2594
diff changeset
620 </Location>
7d6dda802ca0 cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents: 2594
diff changeset
621
7d6dda802ca0 cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents: 2594
diff changeset
622
4324
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
623 CGI-bin for Limited-Access Hosting
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
624 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
625
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
626 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
627 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
628 ``.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
629
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
630 1. Install flup_
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
631 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
632 containing::
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
633
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
634 #!/usr/bin/env python
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
635
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
636 # 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
637 # installed Roundup
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
638 #import sys
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
639 #sys.path.append('...')
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
640
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
641 # 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
642 #import cgitb
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
643 #cgitb.enable()
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
644
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
645 # obtain the WSGI request dispatcher
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
646 from roundup.cgi.wsgi_handler import RequestDispatcher
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
647 tracker_home = '/path/to/tracker/home'
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
648 app = RequestDispatcher(tracker_home)
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
649
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
650 from flup.server.cgi import WSGIServer
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
651 WSGIServer(app).run()
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
652
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
653 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
654 directory to contain::
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
655
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
656 RewriteEngine On
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
657 RewriteBase /
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
658 RewriteRule ^(.*)$ /cgi-bin/roundup_stub/$1 [L]
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
659
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
660 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
661 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
662 stub to get some debugging information.
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
663
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
664 .. index:: pair: web interface; stand alone server
4324
c70762f2be4e flup setup docs from Christian Glass
Richard Jones <richard@users.sourceforge.net>
parents: 4317
diff changeset
665
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
666 Stand-alone Web Server
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
667 ~~~~~~~~~~~~~~~~~~~~~~
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
668
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3736
diff changeset
669 This approach will give you faster response than cgi-bin. You may
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
670 investigate using ProxyPass or similar configuration in apache to have your
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
671 tracker accessed through the same URL as other systems.
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
672
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
673 The stand-alone web server is started with the command ``roundup-server``. It
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
674 has several options - display them with ``roundup-server -h``.
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
675
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
676 The tracker home configuration is similar to the cgi-bin - you may either edit
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
677 the script to change the TRACKER_HOMES variable or you may supply the
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
678 name=home values on the command-line after all the other options.
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
679
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
680 To make the server run in the background, use the "-d" option, specifying the
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
681 name of a file to write the server process id (pid) to.
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
682
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
683
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
684 .. index:: pair: web interface; Zope
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
685
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
686 Zope Product - ZRoundup
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
687 ~~~~~~~~~~~~~~~~~~~~~~~
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
688
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
689 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
690 your Products directory either in INSTANCE_HOME/Products or the Zope
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
691 code tree lib/python/Products.
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
692
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
693 When you next (re)start up Zope, you will be able to add a ZRoundup object
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
694 that interfaces to your new tracker.
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
695
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
696 .. index:: ! triple: web interface; apache; mod_wsgi
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
697 ! single: wsgi; apache
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
698
5891
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
699 Apache HTTP Server with mod_wsgi
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
700 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
701
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
702 This is a work in progress thanks to Garth Jensen.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
703
5909
d57347ae6f25 Typo fixes in installation.txt doc.
John Rouillard <rouilj@ieee.org>
parents: 5908
diff changeset
704 See the main web site for `mod_wsgi`_ which include directions for
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
705 using mod_wsgi-express which is easier if you are not used to apache
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
706 configuration. Also there is the
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
707 `main mod_wsgi <https://modwsgi.readthedocs.io/en/develop/>`_ for more
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
708 detailed directions.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
709
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
710 Background
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
711 ^^^^^^^^^^
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
712
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
713 These notes were developed on a Microsoft Azure VM running Ubuntu
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
714 18.04 LTS. The instructions below assume:
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
715
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
716 - python and roundup are already installed
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
717 - roundup is running in the system python instance (e.g. no virtual
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
718 environment)
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
719 - the tracker ``mytracker`` is installed in the ``trackers`` folder of
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
720 home directory of a user called ``admin``. Thus, the absolute path to
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
721 the tracker home directory is ``/home/admin/trackers/mytracker``.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
722 - the server has a static public IP address of 11.11.11.101
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
723
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
724 Install mod-wsgi
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
725 ^^^^^^^^^^^^^^^^
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
726
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
727 You can install/build it using the python package manager pip, or
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
728 install using the OS package manager (apt).
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
729
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
730 Pip install of mod_wsgi
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
731 '''''''''''''''''''''''
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
732
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
733 This is the tested method, and offers an easier path to get started,
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
734 but it does mean that you will need to keep up to date with any
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
735 security or other issues. If you use the packages supplied by your OS
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
736 vendor, you may get more timely updates and notifications.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
737
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
738 The mod_wsgi docs talk about two installation methods: (1) the
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
739 so-called CMMI method or (2) with pip. The pip method also provides an
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
740 admin script called ``mod_wsgi-express`` that can start up a
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
741 standalone instance of Apache directly from the command line with an
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
742 auto generated configuration. These instructions follow the pip
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
743 method.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
744
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
745
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
746 1. The `mod_wsgi`_ PyPi page lists prerequisites for various types of
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
747 systems. For Ubuntu, they are apache2 and apache2-dev. To see
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
748 installed apache packages, you can use ``dpkg -l | grep apache``.
5909
d57347ae6f25 Typo fixes in installation.txt doc.
John Rouillard <rouilj@ieee.org>
parents: 5908
diff changeset
749 If apache2 or apache2-dev are not installed, they install them
d57347ae6f25 Typo fixes in installation.txt doc.
John Rouillard <rouilj@ieee.org>
parents: 5908
diff changeset
750 with:
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
751
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
752 - ``sudo apt update``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
753 - ``sudo apt install apache2 apache2-dev``
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
754
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
755 2. If ``pip`` is not already installed, install it with
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
756 ``sudo apt install python-pip``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
757
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
758 If you are using python 3, use ``sudo apt-install python3-pip`` and
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
759 change references to pip in the directions to pip3.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
760 3. ``sudo pip install mod_wsgi``. In my case, I got warnings about
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
761 the user not owning directories, but it said it completed
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
762 "successfully."
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
763 4. For testing, open port 8000 for TCP on the server. For an Azure VM,
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
764 this is done with Azure Portal under ``Networking`` > ``Add inbound port``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
765 rule.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
766 5. Test with ``mod_wsgi-express start-server``. This should serve
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
767 up content on localhost port 8000. You can then direct a browser on
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
768 the server itself to http://localhost:8000/ or on another machine at
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
769 the server's domain name or ip address followed by colon then 8000
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
770 (e.g. http://11.11.11.101:8000/). If successful, you should see a
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
771 Malt Whiskey image.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
772
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
773 Package manager install of mod_wsgi
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
774 '''''''''''''''''''''''''''''''''''
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
775
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
776 On debian (which should work for Ubuntu), install apache2 with
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
777 libapache2-mod-wsgi:
5891
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
778
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
779 - ``sudo apt update``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
780 - ``sudo apt install apache2 libapache2-mod-wsgi``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
781
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
782 this is the less tested method for installing mod_wsgi and may not
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
783 install mod_wsgi-express, which is used below. However there is an
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
784 example apache config included as part of `WSGI Variations`_ that can
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
785 be used to hand craft an apache config.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
786
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
787 You should make sure that the version you install is 3.5 or newer due
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
788 to security issues in older releases.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
789
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
790 Configure web interface via wsgi_handler
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
791 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
792
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
793 1. In the tracker's home directory create a ``wsgi.py`` file with the
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
794 following content (substituting ``/home/admin/trackers/mytracker``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
795 with the absolute path for your tracker's home directory):
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
796
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
797 .. code:: python
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
798
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
799 from roundup.cgi.wsgi_handler import RequestDispatcher
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
800 tracker_home = '/home/admin/trackers/mytracker'
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
801 application = RequestDispatcher(tracker_home)
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
802
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
803 To run the tracker on Port 8000 as a foreground process
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
804 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
805
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
806 1. Change the ``tracker.web`` url in ``config.ini`` to port 8000 at the
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
807 server domain name or ip address (e.g. http://11.11.11.101:8000/).
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
808 2. Open port 8000 for TCP on the server if you didn't already do so.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
809 3. ``cd`` to your tracker home directory, then run
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
810 ``mod_wsgi-express start-server wsgi.py``.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
811 4. Test by directing a browser on another machine to the url you set
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
812 ``tracker.web`` to in ``config.ini``.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
813
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
814 Run tracker as background daemon
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
815 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
816
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
817 To run the tracker on Port 80 or as a background process, you'll need
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
818 to configure a UNIX group with appropriate privileges as described in
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
819 `UNIX environment steps`_. These steps are summarized here:
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
820
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
821 1. To add a group named "mytrackergrp" run: ``sudo groupadd mytrackergrp``.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
822 2. Add the owner of the tracker home (admin in this example) run:
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
823 ``sudo usermod -a -G mytrackergrp admin``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
824 3. Add user that runs Apache (the default on Ubuntu is www-data) run:
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
825 ``sudo usermod -a -G mytrackergrp www-data``
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
826 4. Add user mail service runs as (e.g. daemon) run:
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
827 ``sudo usermod -a -G mytrackergrp daemon``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
828 5. Change group of the database in the tracker folder run:
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
829 ``sudo chgrp -R mytrackergrp ~/trackers/mytracker``.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
830 6. Make sure group can write to the database, and any new files created
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
831 in the database will be owned by the group run:
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
832 ``sudo chmod -R g+sw ~/trackers/mytracker/db``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
833
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
834 To run mod_wsgi on PORT 80
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
835 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
836
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
837 1. Change the ``tracker.web`` url in ``config.ini`` to the server url
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
838 with no port designator. E.g. http://11.11.11.101.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
839 2. Open port 80 on the server for TCP traffic if it isn't open already.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
840 3. Stop the system instance of Apache to make sure it isn't holding on
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
841 to port 80 run: ``sudo service apache2 stop``.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
842
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
843 To run as a foreground process
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
844 ''''''''''''''''''''''''''''''
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
845
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
846 1. From the tracker home directory, run
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
847 ``sudo mod_wsgi-express start-server wsgi.py --port 80 --user admin --group mytrackergrp``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
848
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
849 To run as a background process
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
850 ''''''''''''''''''''''''''''''
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
851
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
852 1. From the tracker home directory, bash
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
853 ``sudo mod_wsgi-express setup-server wsgi.py --port=80 --user admin --group mytrackergrp --server-root=/etc/mod_wsgi-express-80``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
854 2. Then, run ``sudo /etc/mod_wsgi-express-80/apachectl start``
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
855 3. To stop, run ``sudo /etc/mod_wsgi-express-80/apachectl stop``
5891
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
856
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
857 .. index:: triple: web interface; apache; mod_python (depricated)
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
858
2554
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
859 Apache HTTP Server with mod_python
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
860 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
861
5891
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
862 As of roundup 2.0, mod_python support is deprecated. The apache.py
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
863 file is still available, but may be limited to working for Python 2
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
864 only. Using mod_wsgi with Apache is the recommended way to deploy
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
865 roundup under apache.
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
866
2554
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
867 `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
868 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
869 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
870 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
871
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
872 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
873 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
874
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
875 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
876 (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
877 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
878 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
879 is located in ``/usr/lib/apache2/build/``)::
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
880
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
881 LD_PRELOAD=/lib/libpthread.so.0
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
882 export LD_PRELOAD
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
883
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
884 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
885
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
886 LD_PRELOAD=/usr/lib/libc_r.so
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
887 export LD_PRELOAD
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
888
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
889 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
890 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
891 ``PythonOption`` directives:
2559
6c096b4aea67 added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2554
diff changeset
892
6c096b4aea67 added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2554
diff changeset
893 TrackerHome:
6c096b4aea67 added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2554
diff changeset
894 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
895 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
896
4249
87b3e905ae2e fixed typos in the installation instructions
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 4226
diff changeset
897 TrackerLanguage:
2559
6c096b4aea67 added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2554
diff changeset
898 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
899 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
900 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
901 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
902 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
903 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
904
2945
98efa80f0f90 added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2921
diff changeset
905 TrackerDebug:
98efa80f0f90 added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2921
diff changeset
906 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
907 ``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
908 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
909 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
910 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
911 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
912
98efa80f0f90 added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2921
diff changeset
913 TrackerTiming:
98efa80f0f90 added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2921
diff changeset
914 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
915 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
916 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
917 ``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
918 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
919 timing display is disabled.
98efa80f0f90 added mod_python options TrackerDebug and TrackerTiming
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2921
diff changeset
920
2554
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
921 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
922 ``/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
923 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
924 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
925 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
926 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
927 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
928 interface (default).
2554
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
929
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
930 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
931 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
932 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
933 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
934
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
935 Example mod_python configuration::
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
936
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
937 #################################################
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
938 # Roundup Issue tracker
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
939 #################################################
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
940 # enable Python optimizations (like 'python -O')
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
941 PythonOptimize On
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
942 # let apache handle static files from 'html' directories
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
943 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
944 # everything else is handled by roundup web UI
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
945 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
946 # 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
947 RedirectMatch permanent ^/roundup/([^/]+)$ /roundup/$1/
2554
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
948 # common settings for all roundup trackers
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
949 <Directory /var/db/roundup/*>
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
950 Order allow,deny
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
951 Allow from all
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
952 AllowOverride None
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
953 Options None
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
954 AddHandler python-program .py
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
955 PythonHandler roundup.cgi.apache
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
956 # 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
957 # (note that *some* tracebacks will be displayed anyway)
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
958 #PythonDebug On
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
959 </Directory>
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
960 # 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
961 <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
962 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
963 PythonOption TrackerLanguage ru
6c096b4aea67 added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2554
diff changeset
964 </Directory>
2554
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
965 <Directory /var/db/roundup/devel>
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
966 PythonOption TrackerHome /var/db/roundup/devel
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
967 </Directory>
3965
248c3a7bc94d seems like a reasonable patch
Richard Jones <richard@users.sourceforge.net>
parents: 3949
diff changeset
968
3814
a612bdc6b1d3 thanks alex
Richard Jones <richard@users.sourceforge.net>
parents: 3799
diff changeset
969 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
970 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
971 your system.
3799
ac4da2670516 trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3797
diff changeset
972
3797
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
973 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
974
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
975 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
976 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
977 <Directory C:/DATA/roundup/*>
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
978 <Directory C:/DATA/roundup/support>
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
979 <Directory C:/DATA/roundup/devel>
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 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
982 ``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
983 inside the httpd.conf file!)
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
984
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
985 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
986 `http://<roundupserver>/roundup/support/`` and
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
987 ``http://<roundupserver>/roundup/devel/``
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 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
990 serving with SSL.
2554
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
991
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
992 Nginx HTTP Server
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
993 ~~~~~~~~~~~~~~~~~
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
994
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
995 This configuration uses gunicorn to run roundup behind an Nginx proxy.
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
996 The proxy also compresses the data using gzip. The url for the tracker
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
997 in config.ini should be ``https://tracker.example.org``.
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
998
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
999 .. code::
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1000
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1001 user nginx;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1002 worker_processes auto;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1003 worker_rlimit_nofile 10000;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1004
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1005 error_log /var/log/nginx/global-error.log;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1006 pid /var/run/nginx.pid;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1007
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1008 events {
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1009 worker_connections 1024;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1010 }
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1011
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1012 upstream tracker-tracker {
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1013 # gunicorn uses this socket for communication
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1014 server unix:/var/run/roundup/tracker.sock fail_timeout=0;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1015 }
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1016
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1017 http {
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1018 include /etc/nginx/mime.types;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1019 default_type application/octet-stream;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1020
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1021 log_format main '$remote_addr - $remote_user [$time_local] "$request" '
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1022 '$status $body_bytes_sent "$http_referer" '
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1023 '"$http_user_agent" "$http_x_forwarded_for"';
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1024
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1025 access_log /var/log/nginx/global-access.log main;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1026 sendfile on;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1027 tcp_nopush on;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1028 tcp_nodelay on;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1029 server_tokens off;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1030
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1031 gzip_http_version 1.1;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1032 gzip_proxied any;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1033 gzip_min_length 500;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1034 # default comp_level is 1
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1035 gzip_comp_level 6;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1036 gzip_disable msie6
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1037 gzip_types text/plain text/css
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1038 text/xml application/xml
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1039 text/javascript application/javascript
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1040 text/json application/json;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1041 # upstream proxies need to match Accept-Encoding as
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1042 # part of their cache check
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1043 gzip_vary on
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1044
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1045 server {
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1046 listen 80;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1047 server_name tracker.example.org;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1048
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1049 location /.well-known/acme-challenge/ {
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1050 alias /etc/lego/.well-known/acme-challenge/;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1051 try_files $uri =404;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1052 }
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1053
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1054 location / {
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1055 return 301 https://$http_host$request_uri;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1056 }
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1057 }
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1058
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1059 server {
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1060 listen 443 ssl;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1061 server_name tracker.example.org;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1062 include mime.types;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1063
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1064 # By default use the snakeoil certificate...
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1065 # change this if you are using a real SSL cert
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1066 ssl_certificate /etc/ssl/certs/ssl-cert-snakeoil.pem;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1067 ssl_certificate_key /etc/ssl/private/ssl-cert-snakeoil.key;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1068
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1069 # These are useful for @@files where roundup is bypassed.
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1070 # but can be set by roundup as well. See:
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1071 # https://wiki.roundup-tracker.org/AddingContentSecurityPolicy
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1072 # which also sets other security headers.
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1073 add_header Strict-Transport-Security "max-age=63072000; includeSubdomains; preload";
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1074 add_header X-Frame-Options "sameorigin";
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1075 add_header X-Xss-Protection "1; mode=block";
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1076 add_header X-Content-Type-Options "nosniff";
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1077 add_header X-Permitted-Cross-Domain-Policies "none";
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1078
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1079 error_log /var/log/nginx/roundup-tracker.error.log;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1080 access_log /var/log/nginx/roundup-tracker.access.log
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1081
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1082 root /home/roundup/trackers/tracker/;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1083
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1084 # have nginx return files from @@file directly rather than
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1085 # going though roundup
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1086 location /@@file/ {
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1087 rewrite ^/@@file/(.*) /html/$1 break;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1088 # note that you can not use cache control (see customizing doc)
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1089 # in roundup to set the expires headers since we are
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1090 # bypassing roundup. Consider using a map or different
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1091 # location stanzas to vary the expiration times.
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1092 expires 1h;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1093 }
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1094
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1095 location / {
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1096 # must define tracker-tracker in upstream stanza
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1097 proxy_pass http://tracker-tracker/;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1098 proxy_set_header Host $host;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1099 proxy_set_header X-Real-IP $remote_addr;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1100 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1101 }
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1102 }
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1103 }
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1104
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1105
6555
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1106 FastCGI (Cherokee, Hiawatha, lighttpd)
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1108
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1109 The Hiawatha and lighttpd web servers can run Roundup using FastCGI.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1110 Cherokee can run FastCGI but it also supports wsgi directly using a
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1111 uWSGI, Gnuicorn etc.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1112
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1113 To run Roundup suing FastCGI, the flup_ package can be used under
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1114 Python 2 and Python 3. We don't have a detailed config for this, but
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1115 the basic idea can be found at:
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1116 https://flask.palletsprojects.com/en/2.0.x/deploying/fastcgi/
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1117
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1118 If you have deployed Roundup using FastCGI and flup we welcome example
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1119 configuration files and instructions.
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1120
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1121 .. _flup: https://pypi.org/project/flup/
34cbd0e633d2 Added FastCGI deployment info, updated Docker docs; docker-compose added
John Rouillard <rouilj@ieee.org>
parents: 6522
diff changeset
1122
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1123 WSGI Variations
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1124 ~~~~~~~~~~~~~~~
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1125
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
1126 .. index:: triple: web interface; apache; mod_wsgi
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
1127 single: wsgi; apache
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
1128
5938
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1129 Apache Alternate
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1130 ^^^^^^^^^^^^^^^^
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1131
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1132 This method from Thomas Arendsen Hein goes into a bit more detail and
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1133 is designed to allow you to run multiple roundup trackers each under
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1134 their own user.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1135
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1136 The tracker instances are read-only to the tracker user and located
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1137 under /srv/roundup/. The (writable) data files are stored in the home
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1138 directory of the user running the tracker.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1139
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1140 To install roundup, download and unpack a distribution tarball and run
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1141 the following as user "roundup"::
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1142
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1143 python setup.py build_doc
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1144 python setup.py sdist --manifest-only
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1145 python setup.py install --home="/home/roundup/install" --force
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1146
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1147 Create a user roundup-foo, group roundup-foo to run the tracker. Add
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1148 the following apache config to
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1149 /etc/apache2/sites-available/roundup-foo (under debian/Ubunutu, modify
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1150 as needed):
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1151
6653
7545d3a3a307 ci was throwing errors as it couldn't parse apache config file format as xml. change xml parser to ApacheConf parser as defined/supported by pygments
John Rouillard <rouilj@ieee.org>
parents: 6629
diff changeset
1152 .. code:: ApacheConf
3736
a2d22d0de0bc WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents: 3731
diff changeset
1153
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1154 ServerAdmin webmaster@example.com
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1155 ErrorLog /var/log/apache2/error.log
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1156
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1157 LogLevel notice
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1158
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1159 DocumentRoot /var/www/
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1160
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1161 <VirtualHost *:80>
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1162 CustomLog /var/log/apache2/access.log vhost_combined
3736
a2d22d0de0bc WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents: 3731
diff changeset
1163
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
1164 # allow access to roundup docs
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1165 Alias /doc/ /home/roundup/install/share/doc/roundup/html/
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1166
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
1167 # make apache serve static assets like css rather than
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1168 # having roundup serve the files
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1169 Alias /foo/@@file/ /srv/roundup/foo/html/
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1170
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
1171 # make /foo into /foo/
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1172 RedirectMatch permanent ^/(foo)$ /$1/
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1173
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
1174 # start a wsgi daemon process running as user roundup-foo
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
1175 # in group roundup-foo. This also changes directory to
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
1176 # ~roundup-foo before it starts roundup.wsgi.
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1177 WSGIDaemonProcess roundup-foo display-name=roundup-foo user=roundup-foo group=roundup-foo threads=25
3736
a2d22d0de0bc WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents: 3731
diff changeset
1178
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1179 # make tracker available at /foo and tie it into the
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
1180 # wsgi script below.
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1181 WSGIScriptAlias /foo /srv/roundup/foo/roundup.wsgi
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1182 <Location /foo>
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1183 WSGIProcessGroup roundup-foo
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1184 </Location>
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1185 </VirtualHost>
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1186
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1187 The directory ~roundup-foo should have:
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1188
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1189 * a ``db`` subdirectory where messages and files will be stored
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1190 * a symbolic link called ``instance`` to /srv/roundup/foo which has
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1191 been initialized using ``roundup-admin``.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1192
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1193 The `Apache HTTP Server with mod_wsgi`_ section above has a simple
5910
aec362e31fcd doc/installation.txt: fix typo
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5909
diff changeset
1194 WSGI handler. This is an enhanced version to be put into
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1195 ``/srv/roundup/foo/roundup.wsgi``.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1196
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1197 .. code:: python
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1198
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1199 import sys, os
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1200 sys.stdout = sys.stderr
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1201
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1202 enabled = True
3736
a2d22d0de0bc WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents: 3731
diff changeset
1203
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1204 if enabled:
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1205 # Add the directory with the roundup installation
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
1206 # subdirectory to the python path.
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1207 sys.path.insert(0, '/home/roundup/install/lib/python')
3736
a2d22d0de0bc WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents: 3731
diff changeset
1208
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1209 # obtain the WSGI request dispatcher
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1210 from roundup.cgi.wsgi_handler import RequestDispatcher
5911
133efe1fbff7 doc/installation.txt: replace tabs, remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 5910
diff changeset
1211
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1212 tracker_home = os.path.join(os.getcwd(), 'instance')
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1213 application = RequestDispatcher(tracker_home)
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1214 else:
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1215 def application(environ, start_response):
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1216 status = '503 Service Unavailable'
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1217 output = 'service is down for maintenance'
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1218 response_headers = [('Content-type', 'text/plain'),
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1219 ('Content-Length', str(len(output)))]
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1220 start_response(status, response_headers)
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1221 return [output]
3736
a2d22d0de0bc WSGI support via roundup.cgi.wsgi_handler
Richard Jones <richard@users.sourceforge.net>
parents: 3731
diff changeset
1222
5908
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1223 This handler allows you to temporarily disable the tracker by setting
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1224 "enabled = False", apache will automatically detect the changed
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1225 roundup.wsgi file and reload it.
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1226
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1227 One last change is needed. In the tracker's config.ini change the db
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1228 parameter in the [main] section to be /home/roundup-foo/db. This will
c7ab00dd6502 First pass at updated wsgi documentation
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
1229 put the files and messages in the db directory for the user.
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1230
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
1231 .. index:: pair: web interface; gunicorn
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
1232 single: wsgi; gunicorn
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
1233
5938
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1234 Gunicorn Installation
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1235 ^^^^^^^^^^^^^^^^^^^^^
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1236
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1237 To run with gunicorn use pip to install gunicorn. This configuration
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1238 uses a front end web server like nginx, hiawatha, apache configured as
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1239 a reverse proxy. See your web server's documentation on how to set it
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1240 up as a reverse proxy.
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1241
6390
7c852cad2ca8 Add wsgi.py to frontends. Update docs.
John Rouillard <rouilj@ieee.org>
parents: 6372
diff changeset
1242 The file wsgi.py (obtained from ``frontends/wsgi.py``) should be in
7c852cad2ca8 Add wsgi.py to frontends. Update docs.
John Rouillard <rouilj@ieee.org>
parents: 6372
diff changeset
1243 the current directory with the contents::
5938
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1244
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1245 # if roundup is not installed on the default PYTHONPATH
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1246 # set it here with:
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1247 import sys
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1248 sys.path.append('/path/to/roundup/install/directory')
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1249
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1250 # obtain the WSGI request dispatcher
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1251 from roundup.cgi.wsgi_handler import RequestDispatcher
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1252 tracker_home = '/path/to/tracker/install/directory'
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1253
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1254 app = RequestDispatcher(tracker_home)
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1255
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1256 Assuming the proxy forwards /tracker, run gunicorn as::
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1257
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1258 SCRIPT_NAME=/tracker gunicorn --bind 127.0.0.1:8917 --timeout=10 wsgi:app
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1259
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1260 this runs roundup at port 8917 on the loopback interface. You should
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1261 configure the reverse proxy to talk to 127.0.0.1 at port 8917.
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1262 If you want you can use a unix domain socket instead. Example:
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1263 ``--bind unix:///var/run/roundup/tracker.sock`` would be used for the
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1264 nginx configuration below.
5938
16eec1c41e0e Add basic gunicorn configuration mechanism.
John Rouillard <rouilj@ieee.org>
parents: 5911
diff changeset
1265
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
1266 .. index:: pair: web interface; uWSGI
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
1267 single: wsgi; uWSGI
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6099
diff changeset
1268
5940
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1269 uWSGI Installation
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1270 ^^^^^^^^^^^^^^^^^^
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1271
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1272 For a basic roundup install using uWSGI behind a front end server,
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1273 install uwsgi and the python3 (or python) plugin. Then run::
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1274
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1275 uwsgi --http-socket 127.0.0.1:8917 \
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1276 --plugin python3 --mount=/tracker=wsgi.py \
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1277 --manage-script-name --callable app
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1278
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1279 using the same wsgi.py as was used for gunicorn. If you get path not
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1280 found errors, check the mount option. The /tracker entry must match
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1281 the path used for the [tracker] web value in the tracker's config.ini.
459426a8c61e Add basic uwsgi setup.
John Rouillard <rouilj@ieee.org>
parents: 5938
diff changeset
1282
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1283 Configure an Email Interface
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1284 ----------------------------
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1285
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1286 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
1287 "``nosyreaction.py``" module from your tracker "``detectors``" directory.
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1288
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
1289 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
1290
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3736
diff changeset
1291 There are five supported ways to get emailed issues into the
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1292 Roundup tracker. You should pick ONE of the following, all
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1293 of which will continue my example setup from above:
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1294
3799
ac4da2670516 trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3797
diff changeset
1295 As a mail alias pipe process
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1296 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1297
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1298 Set up a mail alias called "issue_tracker" as (include the quote marks):
3524
ed82c2c6ee34 fix doc
Richard Jones <richard@users.sourceforge.net>
parents: 3523
diff changeset
1299 "``|/usr/bin/python /usr/bin/roundup-mailgw <tracker_home>``"
ed82c2c6ee34 fix doc
Richard Jones <richard@users.sourceforge.net>
parents: 3523
diff changeset
1300 (substitute ``/usr/bin`` for wherever roundup-mailgw is installed).
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1301
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3736
diff changeset
1302 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
1303 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
1304 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
1305 and change the command to::
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1306
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1307 |roundup-mailgw /opt/roundup/trackers/support
3799
ac4da2670516 trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3797
diff changeset
1308
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1309 To test the mail gateway on unix systems, try::
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1310
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1311 echo test |mail -s '[issue] test' support@YOUR_DOMAIN_HERE
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1312
3722
41feeed84caa *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3666
diff changeset
1313 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
1314 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
1315 limit. *This can cause your Roundup database to become corrupted.*
41feeed84caa *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3666
diff changeset
1316
41feeed84caa *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3666
diff changeset
1317
3447
83e358352e6e minor correction to recent addition by Faheem Mitha
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3446
diff changeset
1318 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
1319 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1320
3446
2325b221bf47 link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3444
diff changeset
1321 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
1322 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
1323 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
1324 included, since Exim3 is considered obsolete.
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1325
3446
2325b221bf47 link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3444
diff changeset
1326 .. _Exim 4: http://www.exim.org/
2325b221bf47 link to exim site
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3444
diff changeset
1327
3444
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1328 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
1329 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
1330 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
1331
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1332 * 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
1333 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
1334 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
1335 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
1336 user ``roundup``.
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1337
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1338 * 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
1339 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
1340 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
1341 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
1342 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
1343 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
1344
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1345 The matching is done in the line::
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1346
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1347 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
1348
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1349 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
1350 Exim4.
3444
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1351
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1352 .. note::
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1353 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
1354 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
1355 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
1356 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
1357 ``/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
1358 system with Exim4 installed.
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1359
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1360 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
1361 README.Debian in
5756
e48b039b0ec0 issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents: 5610
diff changeset
1362 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=343283, which will
3444
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1363 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
1364
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1365 This config makes a few assumptions:
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1366
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1367 * 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
1368 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
1369 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
1370 ``/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
1371
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1372 * 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
1373 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
1374 user, in this case, 'roundup'.
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1375
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1376 * 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
1377 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
1378 in 0.8 from ``config.py``).
3444
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1379
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1380 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
1381 section of the Exim4 config::
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1382
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1383 # Home dir for your Roundup installation
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1384 ROUNDUP_HOME=/var/lib/roundup/trackers
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1385
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1386 # User and group for Roundup.
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1387 ROUNDUP_USER=roundup
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1388 ROUNDUP_GROUP=roundup
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1389
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1390 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
1391 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
1392
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1393 roundup_router:
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1394 driver = accept
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1395 # 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
1396 # 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
1397 # to be present too.
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1398 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
1399 transport = roundup_transport
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1400
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1401 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
1402 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
1403
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1404 roundup_transport:
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1405 driver = pipe
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1406 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
1407 current_directory = ROUNDUP_HOME
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1408 home_directory = ROUNDUP_HOME
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1409 user = ROUNDUP_USER
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1410 group = ROUNDUP_GROUP
0da93b338457 exim configuration instructions (from [SF#1393860])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3421
diff changeset
1411
1317
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1316
diff changeset
1412 As a regular job using a mailbox source
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1316
diff changeset
1413 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1414
3405
292fbed108ca *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3335
diff changeset
1415 Set ``roundup-mailgw`` up to run every 10 minutes or so. For example
3524
ed82c2c6ee34 fix doc
Richard Jones <richard@users.sourceforge.net>
parents: 3523
diff changeset
1416 (substitute ``/usr/bin`` for wherever roundup-mailgw is installed)::
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1417
3524
ed82c2c6ee34 fix doc
Richard Jones <richard@users.sourceforge.net>
parents: 3523
diff changeset
1418 0,10,20,30,40,50 * * * * /usr/bin/roundup-mailgw /opt/roundup/trackers/support mailbox <mail_spool_file>
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1419
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1420 Where the ``mail_spool_file`` argument is the location of the roundup submission
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1421 user's mail spool. On most systems, the spool for a user "issue_tracker"
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1422 will be "``/var/mail/issue_tracker``".
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1423
1317
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1316
diff changeset
1424 As a regular job using a POP source
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1316
diff changeset
1425 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1426
3405
292fbed108ca *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3335
diff changeset
1427 To retrieve from a POP mailbox, use a *cron* entry similar to the mailbox
3524
ed82c2c6ee34 fix doc
Richard Jones <richard@users.sourceforge.net>
parents: 3523
diff changeset
1428 one (substitute ``/usr/bin`` for wherever roundup-mailgw is
3405
292fbed108ca *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3335
diff changeset
1429 installed)::
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1430
3524
ed82c2c6ee34 fix doc
Richard Jones <richard@users.sourceforge.net>
parents: 3523
diff changeset
1431 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
1432
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1433 where pop_spec is "``username:password@server``" that specifies the roundup
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1434 submission user's POP account name, password and server.
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1435
1317
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1316
diff changeset
1436 On windows, you would set up the command using the windows scheduler.
28ae91aae74f clarifications
Richard Jones <richard@users.sourceforge.net>
parents: 1316
diff changeset
1437
2211
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2186
diff changeset
1438 As a regular job using an IMAP source
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2186
diff changeset
1439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2186
diff changeset
1440
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2186
diff changeset
1441 To retrieve from an IMAP mailbox, use a *cron* entry similar to the
3524
ed82c2c6ee34 fix doc
Richard Jones <richard@users.sourceforge.net>
parents: 3523
diff changeset
1442 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
1443 installed)::
2211
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2186
diff changeset
1444
3524
ed82c2c6ee34 fix doc
Richard Jones <richard@users.sourceforge.net>
parents: 3523
diff changeset
1445 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
1446
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2186
diff changeset
1447 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
1448 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
1449 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
1450 "``imap username:password@server mailbox``".
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2186
diff changeset
1451
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2186
diff changeset
1452 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
1453 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
1454
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2186
diff changeset
1455 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
1456 windows scheduler.
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2186
diff changeset
1457
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1458
1939
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
1459 UNIX Environment Steps
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
1460 ----------------------
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1461
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1462 Each tracker ideally should have its own UNIX group, so create
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1463 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1464 you're using NIS). To continue with my examples so far, I would
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1465 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
1466 group does not have to be the same as the tracker name. To this
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1467 '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
1468 working with this Roundup tracker. In addition to 'real' users,
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1469 the Roundup email gateway will need to have permissions to this
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1470 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
1471 group (typically "mail" or "daemon"). The UNIX group might then
67af854f4c33 more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
1472 look like::
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1473
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1474 support:*:1002:jblaine,samh,geezer,mail
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1475
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1476 If you intend to use the web interface (as most people do), you
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1477 should also add the username your web server runs as to the group.
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1478 My group now looks like this::
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1479
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1480 support:*:1002:jblaine,samh,geezer,mail,apache
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1481
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1482 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
1483 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
1484 by the group.
344bad728d10 more tweakage of help display and style issues
Richard Jones <richard@users.sourceforge.net>
parents: 1049
diff changeset
1485
2594
c0d6d5004464 rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2559
diff changeset
1486 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
1487 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
1488 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
1489 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
1490 in ``rdbms`` -> ``user`` and ``password`` in ``config.ini``.
2594
c0d6d5004464 rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2559
diff changeset
1491
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1492 An alternative to the above is to create a new user who has the sole
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1493 responsibility of running roundup. This user:
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1494
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1495 1. runs the CGI interface daemon
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1496 2. runs regular polls for email
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1497 3. runs regular checks (using cron) to ensure the daemon is up
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1498 4. optionally has no login password so that nobody but the "root" user
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1499 may actually login and play with the roundup setup.
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1500
3754
9f4dd27ae843 documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents: 3736
diff changeset
1501 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
1502 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
1503 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
1504 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
1505 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
1506
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1507
3830
a48c514c465f Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents: 3814
diff changeset
1508 Public Tracker Considerations
a48c514c465f Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents: 3814
diff changeset
1509 -----------------------------
a48c514c465f Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents: 3814
diff changeset
1510
a48c514c465f Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents: 3814
diff changeset
1511 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
1512 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
1513
5300
d8ed32b297e2 Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents: 5140
diff changeset
1514 See the section on `Preventing SPAM`_ in the
d8ed32b297e2 Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents: 5140
diff changeset
1515 `customisation documentation`_ that has a simple detector
d8ed32b297e2 Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents: 5140
diff changeset
1516 that will block lot of spam attempts.
3830
a48c514c465f Add simple anti-spam recipe to docs
Richard Jones <richard@users.sourceforge.net>
parents: 3814
diff changeset
1517
2069
d8c7fd205cd8 info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents: 2003
diff changeset
1518
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1519 Maintenance
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1520 ===========
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1521
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents: 1965
diff changeset
1522 Read the separate `administration guide`_ for information about how to
1228
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
1523 perform common maintenance tasks with Roundup.
1049
Richard Jones <richard@users.sourceforge.net>
parents: 1024
diff changeset
1524
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
1525
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
1526 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
1527 =========
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
1528
882
b99948d32a2d clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents: 798
diff changeset
1529 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
1530 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
1531 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
1532
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1533
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1534 Further Reading
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1535 ===============
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1536
3528
762d65fefea5 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3524
diff changeset
1537 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
1538 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
1539 like implementation details, you should read `Customising Roundup`_.
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1540
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1541
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
1542 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
1543 =========================
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
1544
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
1545 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
1546 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
1547 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
1548
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
1549 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
1550 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
1551 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
1552 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
1553 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
1554 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
1555 "issue" class, but with different properties. See the customisation
98656054ccfa *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2069
diff changeset
1556 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
1557
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
1558
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1559 Platform-Specific Notes
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1560 =======================
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1561
1649
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1562 Windows command-line tools
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1563 --------------------------
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1564
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1565 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
1566 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
1567
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1568 On Windows 2000 and later:
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1569
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1570 1) Press the "Start" button.
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1571 2) Choose "Settings"
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1572 3) Choose "Control Panel"
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1573 4) Choose "System"
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1574 5) Choose "Advanced"
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1575 6) Choose "Environmental Variables"
1746
9c1da921cd35 minor rest tweak
Richard Jones <richard@users.sourceforge.net>
parents: 1688
diff changeset
1576 7) Add: "<dir>\Scripts" to the "Path" environmental variable.
1649
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1577
6727
3f3ce3004013 issue2551206 - remove mention of roundup installer, fix up windows docs
John Rouillard <rouilj@ieee.org>
parents: 6663
diff changeset
1578 Where <dir> in 7) is the root directory (e.g., ``C:\Python27\Scripts``)
1649
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1579 of your Python installation.
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1580
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1581 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
1582 Panel" is directly accessible from "Start".
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1583
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1584 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
1585
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1586
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1587 Windows Server
6d392197daa3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1648
diff changeset
1588 --------------
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
1589
3797
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1590 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
1591 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
1592
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1593
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1594 1. Using the Windows scheduler
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1595 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1596
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1597 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
1598 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
1599
3797
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1600 **Run**
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1601
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1602 ``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
1603
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1604 **Start In**
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1605
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1606 ``C:\cygwin\opt\roundup\bin``
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1607
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1608 **Schedule**
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1609
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1610 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
1611
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
1612 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
1613 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
1614
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1615 **Run**
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1616
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1617 ``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
1618
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1619 **Start In**
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1620
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1621 ``C:\cygwin\opt\roundup\bin``
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1622
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1623 **Schedule**
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1624
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1625 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
1626
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1627 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
1628
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1629
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1630 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
1631 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1632
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1633 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
1634 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
1635 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
1636
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1637 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
1638 relevant settings.
1588
1ac46e7e4150 more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 1576
diff changeset
1639
3797
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1640 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
1641 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
1642
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1643 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
1644
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1645 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
1646 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
1647 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
1648
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1649 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
1650 (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
1651 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
1652
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1653 [trackers]
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1654 software = C:\DATA\Roundup\Software
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1655
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1656 (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
1657 ``C:\DATA\Roundup\Software``)
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1658
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1659 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
1660
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1661 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
1662 roundup-server -c start
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1663
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1664 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
1665 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
1666 automatically instead of manually.
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1667
bb6e8fafa341 Updated Windows installation docs (thanks Bo Berglund)
Richard Jones <richard@users.sourceforge.net>
parents: 3794
diff changeset
1668 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
1669 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
1670 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
1671
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1574
diff changeset
1672
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1673 Sendmail smrsh
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1674 --------------
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1675
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1676 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
1677 smrsh that roundup-mailgw is a valid/trusted mail handler
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1678 before it will work.
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1679
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1680 This is usually done via the following 2 steps:
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1681
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1682 1. make a symlink in ``/etc/smrsh`` called ``roundup-mailgw``
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1683 which points to the full path of your actual ``roundup-mailgw``
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1684 script.
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1685
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1078
diff changeset
1686 2. change your alias to ``"|roundup-mailgw <tracker_home>"``
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1687
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1688
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1689 Linux
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1690 -----
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1691
1939
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
1692 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
1693
67af854f4c33 more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
1694
67af854f4c33 more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
1695 Solaris
67af854f4c33 more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
1696 -------
67af854f4c33 more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
1697
67af854f4c33 more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
1698 You'll need to build Python.
67af854f4c33 more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
1699
1939
1303c208419d some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
1700 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
1701
1574
67af854f4c33 more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
1702
2972
dd558120d927 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2945
diff changeset
1703 Problems? Testing your Python...
dd558120d927 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2945
diff changeset
1704 ================================
dd558120d927 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2945
diff changeset
1705
dd558120d927 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2945
diff changeset
1706 .. note::
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1707 The ``run_tests.py`` script is not packaged in Roundup's source
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1708 distribution anymore. You should install pytest using your
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1709 distributions package manger or using pip/pip2/pip3 to install
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1710 pytest for your python version. See the `administration guide`_
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1711 for details.
2972
dd558120d927 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2945
diff changeset
1712
4317
15834821b8c7 - fix explicit python version description...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4315
diff changeset
1713 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
1714 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
1715 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
1716 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
1717 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
1718 ``-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
1719
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1720 Once you've unpacked roundup's source, if you have pytest installed,
6619
637501e529f3 fix typo
John Rouillard <rouilj@ieee.org>
parents: 6588
diff changeset
1721 run ``python -m pytest test`` in the source directory and make sure
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1722 there are no errors. If there are errors, please let us know!
2972
dd558120d927 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2945
diff changeset
1723
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1724 .. _`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
1725 .. _`user guide`: user_guide.html
4949
c3a90535f7a7 Backed out changeset 4a3a35192ad1
John Rouillard <rouilj@ieee.org>
parents: 4948
diff changeset
1726 .. _`roundup specification`: spec.html
1245
d8c98af869ff merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents: 1244
diff changeset
1727 .. _`tracker configuration`: customizing.html#tracker-configuration
d8c98af869ff merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents: 1244
diff changeset
1728 .. _`customisation documentation`: customizing.html
5300
d8ed32b297e2 Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents: 5140
diff changeset
1729 .. _`preventing spam`: customizing.html#preventing-spam
2161
98656054ccfa *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2069
diff changeset
1730 .. _`Adding a new field to the classic schema`:
98656054ccfa *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2069
diff changeset
1731 customizing.html#adding-a-new-field-to-the-classic-schema
98656054ccfa *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2069
diff changeset
1732 .. _`Tracking different types of issues`:
98656054ccfa *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2069
diff changeset
1733 customizing.html#tracking-different-types-of-issues
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1734 .. _`customising roundup`: customizing.html
882
b99948d32a2d clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents: 798
diff changeset
1735 .. _`upgrading document`: upgrading.html
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents: 1965
diff changeset
1736 .. _`administration guide`: admin_guide.html
6663
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
1737 .. _`doc/postgresql.txt`: postgresql.html
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
1738 .. _`doc/mysql.txt`: mysql.html
2554
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
1739
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
1740
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
1741 .. _External hyperlink targets:
52944e87909c added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2449
diff changeset
1742
6391
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1743
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1744
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1745 .. _`adding MySQL users`:
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1746 https://dev.mysql.com/doc/refman/8.0/en/creating-accounts.html
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1747 .. _apache: https://httpd.apache.org/
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1748 .. _brotli: https://pypi.org/project/Brotli/
6391
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1749 .. _docutils: https://pypi.org/project/docutils/
5337
01dabc0483b0 more changes to prep for 1.6 release.
John Rouillard <rouilj@ieee.org>
parents: 5321
diff changeset
1750 .. _flup: https://pypi.org/project/flup/
6391
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1751 .. _gpg: https://www.gnupg.org/software/gpgme/index.html
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1752 .. _jinja2: https://palletsprojects.com/p/jinja/
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1753 .. _markdown: https://python-markdown.github.io/
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1754 .. _markdown2: https://github.com/trentm/python-markdown2
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1755 .. _mistune: https://pypi.org/project/mistune/
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1756 .. _mod_python: https://github.com/grisha/mod_python
5891
6e341009593b Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents: 5878
diff changeset
1757 .. _mod_wsgi: https://pypi.org/project/mod-wsgi/
5510
e2978ed3b550 update link to new mysqlclient module and recommend update in upgrading.txt
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5494
diff changeset
1758 .. _MySQLdb: https://pypi.org/project/mysqlclient/
6391
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1759 .. _Olson tz database: https://www.iana.org/time-zones
6663
e63f514bb0e6 issue2551201 - Update references to psycopg2
John Rouillard <rouilj@ieee.org>
parents: 6653
diff changeset
1760 .. _Psycopg2: https://www.psycopg.org/
6391
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1761 .. _pyjwt: https://pypi.org/project/PyJWT/
6419
4d321d52d67d fix broken link for pyopenssl
John Rouillard <rouilj@ieee.org>
parents: 6391
diff changeset
1762 .. _pyopenssl: https://pypi.org/project/pyOpenSSL/
5756
e48b039b0ec0 issue2550966: fix suboptimal links in docs.
John Rouillard <rouilj@ieee.org>
parents: 5610
diff changeset
1763 .. _pysqlite: https://pysqlite.org/
6391
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1764 .. _pytz: https://pypi.org/project/pytz/
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1765 .. _pywin32: https://pypi.org/project/pywin32/
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1766 .. _Whoosh: https://whoosh.readthedocs.org/en/latest
205bc1d27985 Added links for pyjwt, markdown libs, rearranged links.
John Rouillard <rouilj@ieee.org>
parents: 6390
diff changeset
1767 .. _Xapian: https://xapian.org/
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6419
diff changeset
1768 .. _zstd: https://pypi.org/project/zstd/
Roundup Issue Tracker: http://roundup-tracker.org/