Mercurial > p > roundup > code
annotate doc/installation.txt @ 2806:845e87d5e3ba
translator objects now have the following search path:
- selected locale messages in the tracker locale dir
- selected locale messages in the system locale dir
- english messages in the tracker locale dir
- english messages in the system locale dir
automatically compile .mo files if needed (found .po file
and .mo is missing or .po mtime is greater that .mo mtime)
removed support for python < 2.0. gettext module is now required.
get_translation: removed 'domain' argument, added 'tracker_home' argument
| author | Alexander Smishlajev <a1s@users.sourceforge.net> |
|---|---|
| date | Sat, 23 Oct 2004 14:03:34 +0000 |
| parents | 8ac87d4092e2 |
| children | 2317e43609cb |
| rev | line source |
|---|---|
|
688
b38f4f95bffd
More doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
686
diff
changeset
|
1 ================== |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
2 Installing Roundup |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
3 ================== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
4 |
| 2409 | 5 :Version: 1.76 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
6 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
7 .. contents:: |
| 2409 | 8 :depth: 2 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
10 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
11 Overview |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
12 ======== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
13 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
14 Broken out separately, there are several conceptual pieces to a |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
15 Roundup installation: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
16 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
17 Roundup trackers |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
18 Trackers consist of issues (be they bug reports or otherwise), tracker |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
19 configuration file(s), web HTML files etc. Roundup trackers are initialised |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
20 with a "Template" which defines the fields usable/assignable on a |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
21 per-issue basis. Descriptions of the provided templates are given in |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
22 `choosing your template`_. |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
23 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
24 Roundup support code |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
25 Installed into your Python install's lib directory |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
26 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
27 Roundup scripts |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
28 These include the email gateway, the roundup |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
29 HTTP server, the roundup administration command-line interface, etc. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
30 |
|
1218
4c9882cb16a3
more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
1170
diff
changeset
|
31 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
32 Prerequisites |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
33 ============= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
34 |
|
1965
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
35 Roundup requires Python 2.1.3 or newer with a functioning anydbm or |
|
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
36 bsddb module. Download the latest version from http://www.python.org/. |
|
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
37 It is highly recommended that users install the latest patch version |
|
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
38 of python as these contain many fixes to serious bugs. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
39 |
|
727
779015e264b4
Note the version that is known to work.
Richard Jones <richard@users.sourceforge.net>
parents:
724
diff
changeset
|
40 If you want to use Berkeley DB bsddb3 with Roundup, use version 3.3.0 or |
|
779015e264b4
Note the version that is known to work.
Richard Jones <richard@users.sourceforge.net>
parents:
724
diff
changeset
|
41 later. Download the latest version from http://pybsddb.sourceforge.net/. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
42 |
|
1300
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
43 If you're on windows, you will either need to be using the ActiveState python |
|
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
44 distribution (at http://www.activestate.com/Products/ActivePython/), or you'll |
|
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
45 have to install the win32all package separately (get it from |
|
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
46 http://starship.python.net/crew/mhammond/win32/). |
|
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
47 |
|
2069
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
48 Non-Python2.3 users may need to `install the "CSV" module`_. |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
49 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
50 Install the "CSV" module |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
51 ------------------------ |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
52 |
| 2409 | 53 .. hint:: |
| 54 CSV stands for Comma-Separated-Value. These files are used by all | |
| 55 manner of programs (eg. spreadsheets) to exchange data. | |
|
2069
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
56 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
57 The "CSV" module is required if you wish to import or export data in the |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
58 tracker, or if you wish to use the online generic class editing facility. |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
59 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
60 If you're using a version of Python older than 2.3, then you will need to |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
61 install the "CSV" module from `Object Craft`_. Users of Python2.3 and later |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
62 don't need to. If you have a C compiler installed, then download the source |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
63 and follow their installation instructions (simply ``python setup.py |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
64 install``.) |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
65 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
66 If you're on Windows and don't have a C compiler, then you'll need to |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
67 download the pre-compiled ``csv.pyd`` file and install it. To install, just |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
68 copy it to your Python installation in the ``lib\site-packages`` directory. |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
69 For Python 2.2, this would be:: |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
70 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
71 c:\python22\lib\site-packages |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
72 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
73 Once the CSV module is installed, you *must* restart roundup-server if it |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
74 is already running, or the new module won't be detected. |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
75 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
76 If you're on some other platform and don't have a C compiler, you'll need |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
77 to ask for help on the roundup-users mailing list. |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
78 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
79 .. _`Object Craft`: http://object-craft.com.au/ |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
80 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
81 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
82 Getting Roundup |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
83 =============== |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
84 |
|
2742
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
85 .. note:: |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
86 Some systems, such as Debian and NetBSD, already have Roundup |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
87 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
|
88 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
|
89 below and go straight to `configuring your first tracker`_. |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
90 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
91 Download the latest version from http://roundup.sf.net/. |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
92 |
|
2216
759ed26e24dd
help for winzip users
Richard Jones <richard@users.sourceforge.net>
parents:
2211
diff
changeset
|
93 If you're using WinZIP's "classic" interface, make sure the "Use |
|
759ed26e24dd
help for winzip users
Richard Jones <richard@users.sourceforge.net>
parents:
2211
diff
changeset
|
94 folder names" check box is checked before you extract the files. |
|
759ed26e24dd
help for winzip users
Richard Jones <richard@users.sourceforge.net>
parents:
2211
diff
changeset
|
95 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
96 Testing your Python |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
97 ------------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
98 |
| 2409 | 99 .. note:: |
|
2742
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
100 The ``run_tests.py`` script is packaged in Roundup's source distribution |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
101 - users of the Windows installer, other binary distributions or |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
102 pre-installed Roundup will need to download the source to use it. |
| 2401 | 103 |
|
1875
3ffb7b56172a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1850
diff
changeset
|
104 Once you've unpacked roundup's source, run ``python run_tests.py`` in the |
|
1850
6e80f8f760a4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1845
diff
changeset
|
105 source directory and make sure there are no errors. If there are errors, |
|
6e80f8f760a4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1845
diff
changeset
|
106 please let us know! |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
107 |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
108 If the above fails, you may be using the wrong version of python. Try |
|
1875
3ffb7b56172a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1850
diff
changeset
|
109 ``python2 run_tests.py``. If that works, you will need to substitute |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
110 ``python2`` for ``python`` in all further commands you use in relation to |
|
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
111 Roundup -- from installation and scripts. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
112 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
113 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
114 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
|
115 ======================== |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
116 |
|
2741
d2b5ebf53d08
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2665
diff
changeset
|
117 .. note:: |
|
2742
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
118 The ``demo.py`` script is packaged in Roundup's source distribution - |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
119 users of the Windows installer, other binary distributions or |
|
8ac87d4092e2
more install doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
2741
diff
changeset
|
120 pre-installed Roundup will need to download the source to use it. |
| 2401 | 121 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
122 If you just want to give Roundup a whirl Right Now, then simply run |
|
1640
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1629
diff
changeset
|
123 ``python demo.py``. This will set up a simple demo tracker on your |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
124 machine. When it's done, it'll print out a URL to point your web browser |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
125 at so you may start playing. Three users will be set up: |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
126 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
127 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
|
128 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
|
129 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
|
130 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
|
131 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
132 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
133 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
134 ============ |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
135 |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
136 Set aside 15-30 minutes. Please make sure you're using a supported version of |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
137 Python -- see `testing your python`_. There's several steps to follow in your |
| 1228 | 138 installation: |
| 1049 | 139 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
140 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
|
141 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
|
142 3. then optionally `configure a web interface`_ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
143 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
|
144 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
|
145 UNIX machine and want to restrict local access to roundup |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
146 6. `additional language codecs`_ |
| 1049 | 147 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
148 For information about how Roundup installs, see the `administration |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
149 guide`_. |
|
1965
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
150 |
| 1049 | 151 |
| 152 Basic Installation Steps | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
153 ------------------------ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
154 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
155 To install the Roundup support code into your Python tree and |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
156 Roundup scripts into /usr/local/bin (substitute that path for whatever is |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
157 appropriate on your system). You need to have write permissions |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
158 for these locations, eg. being root on unix:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
159 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
160 python setup.py install |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
161 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
162 If you would like to place the Roundup scripts in a directory other |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
163 than ``/usr/local/bin``, then specify the preferred location with |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
164 ``--install-script``. For example, to install them in |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
165 ``/opt/roundup/bin``:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
166 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
167 python setup.py install --install-scripts=/opt/roundup/bin |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
168 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
169 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
|
170 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
|
171 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
|
172 yourself. |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1245
diff
changeset
|
173 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
174 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
175 Configuring your first tracker |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
176 ------------------------------ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
177 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
178 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
|
179 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
|
180 home": |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
181 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
182 a. (Optional) If you intend to keep your roundup trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
183 under one top level directory which does not exist yet, |
| 1228 | 184 you should create that directory now. Example:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
185 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
186 mkdir /opt/roundup/trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
187 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
188 b. Either add the Roundup script location to your ``PATH`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
189 environment variable or specify the full path to |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
190 the command in the next step. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
191 |
| 1228 | 192 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
|
193 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
|
194 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
|
195 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
|
196 below. The questions will be something like (you may have more |
| 1228 | 197 templates or backends available):: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
198 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
199 Enter tracker home: /opt/roundup/trackers/support |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
200 Templates: classic |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
201 Select template [classic]: classic |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
202 Back ends: anydbm, bsddb |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
203 Select backend [anydbm]: anydbm |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
204 |
|
1571
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
205 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
|
206 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
|
207 will be stored in. |
|
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
208 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
209 You will now be directed to edit the tracker configuration and |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
210 initial schema. At a minimum, you must set ``MAILHOST``, |
| 2409 | 211 ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. The |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
212 configuration file uses Python syntax, so almost every value must be |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
213 ``'quoted'`` using single or double quotes. If you get stuck, and get |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
214 configuration file errors, then see the `tracker configuration`_ section |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
215 of the `customisation documentation`_. |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
216 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
217 If you just want to get set up to test things quickly (and follow |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
218 the instructions in step 3 below), you can even just set the |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
219 TRACKER_WEB variable to:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
220 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
221 TRACKER_WEB = 'http://localhost:8080/support/' |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
222 |
|
1310
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
223 The URL *must* end in a '/', or your web interface *will not work*. |
|
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
224 See `Customising Roundup`_ for details on configuration and schema |
| 2409 | 225 changes. You may change any of the configuration after |
|
1310
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
226 you've initialised the tracker - it's just better to have valid values |
|
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
227 for this stuff now. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
228 |
| 1228 | 229 d. Initialise the tracker database with ``roundup-admin initialise``. |
| 230 You will need to supply an admin password at this step. You will be | |
| 231 prompted:: | |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
232 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
233 Admin Password: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
234 Confirm: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
235 |
| 2401 | 236 Note: running this command will *destroy any existing data in the |
| 237 database*. In the case of MySQL and PostgreSQL, any exsting database | |
| 238 will be dropped and re-created. | |
| 239 | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
240 Once this is done, the tracker has been created. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
241 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
242 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
|
243 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
|
244 optionally `configure an email interface`_. If you want to try your |
|
dd43853684d4
don't undersell the roundup-server
Richard Jones <richard@users.sourceforge.net>
parents:
1310
diff
changeset
|
245 new tracker out, assuming ``TRACKER_WEB`` is set to |
|
dd43853684d4
don't undersell the roundup-server
Richard Jones <richard@users.sourceforge.net>
parents:
1310
diff
changeset
|
246 ``'http://localhost:8080/support/'``, run:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
247 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
248 roundup-server support=/opt/roundup/trackers/support |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
249 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
250 then direct your web browser at: |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
251 |
|
1845
3c6dd167a744
Fix typo in server address [SF#822967].
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1839
diff
changeset
|
252 http://localhost:8080/support/ |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
253 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
254 and you should see the tracker interface. |
| 1049 | 255 |
| 256 | |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
257 Choosing Your Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
258 ---------------------- |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
259 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
260 Classic Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
261 ~~~~~~~~~~~~~~~~ |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
262 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
263 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
|
264 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
|
265 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
|
266 |
|
1227
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
267 Minimal Template |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
268 ~~~~~~~~~~~~~~~~ |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
269 |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
270 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
|
271 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
|
272 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
|
273 create your tracker on. |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
274 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
275 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
276 Choosing Your Backend |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
277 --------------------- |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
278 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
279 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
|
280 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
|
281 |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
282 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
283 Name Speed Users Support |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
284 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
285 anydbm Slowest Few Always available |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
286 bsddb Slow Few Usually available |
| 2258 | 287 bsddb3 Slow Few Needs install (pybsddb_) |
|
2238
df0444e39bc3
more useful pysqlite link
Richard Jones <richard@users.sourceforge.net>
parents:
2216
diff
changeset
|
288 sqlite Fastest(*) Few Needs install (PySQLite_) |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
289 metakit Fastest(*) Few Needs install (metakit_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
290 postgresql Fast Many Needs install/admin (psycopg_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
291 mysql Fast Many Needs install/admin (MySQLdb_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
292 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
293 |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
294 **sqlite** and **metakit** |
|
2238
df0444e39bc3
more useful pysqlite link
Richard Jones <richard@users.sourceforge.net>
parents:
2216
diff
changeset
|
295 These use the embedded database engines PySQLite_ and metakit_ to provide |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
296 very fast backends. They are not suitable for trackers which will have |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
297 many simultaneous users. |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
298 **postgresql** |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
299 Backend for popular RDBMS PostgreSQL. You must read doc/postgresql.txt for |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
300 additional installation steps and requirements. |
|
1507
3481507d6098
Advertising mysql
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1317
diff
changeset
|
301 **mysql** |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
302 Backend for popular RDBMS MySQL. You must read doc/mysql.txt for additional |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
303 installation steps and requirements. |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
304 |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
305 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
|
306 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
|
307 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
|
308 guide`_. |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
309 |
| 2401 | 310 Regardless of which backend you choose, Roundup will attempt to initialise |
| 311 a new database for you when you run the roundup-admin "initialise" command. | |
| 312 In the case of MySQL and PostgreSQL you will need to have the appropriate | |
| 313 privileges to create databases. | |
| 314 | |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
315 |
| 1228 | 316 Configure a Web Interface |
| 317 ------------------------- | |
| 318 | |
| 319 There are three web interfaces to choose from: | |
| 320 | |
| 321 1. `web server cgi-bin`_ | |
| 322 2. `stand-alone web server`_ | |
| 323 3. `Zope product - ZRoundup`_ | |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
324 4. `Apache HTTP Server with mod_python`_ |
| 1228 | 325 |
| 326 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
|
327 - 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
|
328 configure your system in some way - see `platform-specific notes`_. |
| 1228 | 329 |
| 330 | |
| 331 Web Server cgi-bin | |
| 332 ~~~~~~~~~~~~~~~~~~ | |
| 333 | |
| 334 A benefit of using the cgi-bin approach is that it's the easiest way to | |
| 335 restrict access to your tracker to only use HTTPS. Access will be slower | |
| 336 than through the `stand-alone web server`_ though. | |
| 337 | |
| 2409 | 338 If your Python isn't install as "python" then you'll need to edit |
|
1748
0f2678eeeac6
cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents:
1747
diff
changeset
|
339 the ``roundup.cgi`` script to fix the first line. |
|
0f2678eeeac6
cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents:
1747
diff
changeset
|
340 |
|
1540
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
341 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
|
342 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
|
343 |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
344 adsutil.vbs set w3svc/AllowPathInfoForScriptMappings TRUE |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
345 |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
346 The ``adsutil.vbs`` file can be found in either ``c:\inetpub\adminscripts`` |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
347 or ``c:\winnt\system32\inetsrv\adminsamples\`` or |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
348 ``c:\winnt\system32\inetsrv\adminscripts\`` depending on your installation. |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
349 |
| 1228 | 350 Copy the ``cgi-bin/roundup.cgi`` file to your web server's ``cgi-bin`` |
| 351 directory. You will need to configure it to tell it where your tracker home | |
| 352 is. You can do this either: | |
| 353 | |
| 354 through an environment variable | |
| 355 set the variable TRACKER_HOMES to be a colon (":") separated list of | |
| 356 name=home pairs (if you're using apache, the SetEnv directive can do this) | |
| 357 directly in the ``roundup.cgi`` file itself | |
| 358 add your instance to the TRACKER_HOMES variable as ``'name': 'home'`` | |
| 359 | |
| 360 The "name" part of the configuration will appear in the URL and identifies the | |
| 361 tracker (so you may have more than one tracker per cgi-bin script). Make sure | |
| 362 there are no spaces or other illegal characters in it (to be safe, stick to | |
| 363 letters and numbers). The "name" forms part of the URL that appears in the | |
| 364 tracker config TRACKER_WEB variable, so make sure they match. The "home" | |
| 365 part of the configuration is the tracker home directory. | |
| 366 | |
|
2665
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
367 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
|
368 ``.cgi`` extension of the cgi script. Place the ``roundup.cgi`` script |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
369 wherever you want it to be, renamed it to just ``roundup``, and add a |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
370 couple lines to your Apache configuration:: |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
371 |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
372 <Location /path/to/roundup> |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
373 SetHandler cgi-script |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
374 </Location> |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
375 |
|
7d6dda802ca0
cgi install tip
Richard Jones <richard@users.sourceforge.net>
parents:
2594
diff
changeset
|
376 |
| 1228 | 377 Stand-alone Web Server |
| 378 ~~~~~~~~~~~~~~~~~~~~~~ | |
| 379 | |
| 380 This approach will give you the fastest of the three web interfaces. You may | |
| 381 investigate using ProxyPass or similar configuration in apache to have your | |
| 382 tracker accessed through the same URL as other systems. | |
| 383 | |
| 384 The stand-alone web server is started with the command ``roundup-server``. It | |
| 385 has several options - display them with ``roundup-server -h``. | |
| 386 | |
| 387 The tracker home configuration is similar to the cgi-bin - you may either edit | |
| 388 the script to change the TRACKER_HOMES variable or you may supply the | |
| 389 name=home values on the command-line after all the other options. | |
| 390 | |
| 391 To make the server run in the background, use the "-d" option, specifying the | |
| 392 name of a file to write the server process id (pid) to. | |
| 393 | |
| 394 | |
| 395 Zope Product - ZRoundup | |
| 396 ~~~~~~~~~~~~~~~~~~~~~~~ | |
| 397 | |
| 398 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to | |
| 399 your Products directory either in INSTANCE_HOME/Products or the Zope | |
| 400 code tree lib/python/Products. | |
| 401 | |
| 402 When you next (re)start up Zope, you will be able to add a ZRoundup object | |
| 403 that interfaces to your new tracker. | |
| 404 | |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
405 Apache HTTP Server with mod_python |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
406 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
407 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
408 `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
|
409 within the server. Running Roundup this way is much faster than all |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
410 above options and, like `web server cgi-bin`_, allows to use HTTPS |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
411 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
|
412 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
413 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
|
414 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
|
415 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
416 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
|
417 (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
|
418 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
|
419 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
|
420 is located in ``/usr/lib/apache2/build/``):: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
421 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
422 LD_PRELOAD=/lib/libpthread.so.0 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
423 export LD_PRELOAD |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
424 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
425 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
|
426 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
427 LD_PRELOAD=/usr/lib/libc_r.so |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
428 export LD_PRELOAD |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
429 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
430 Next, you have to add Roundup trackers configuration to apache config. |
|
2559
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
431 Roundup apache interface uses two options specified with ``PythonOption`` |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
432 directives: |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
433 |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
434 TrackerHome: |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
435 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
|
436 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
|
437 |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
438 TrackerLaguage: |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
439 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
|
440 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
|
441 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
|
442 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
|
443 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
|
444 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
|
445 |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
446 In the following example we have two trackers set up in |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
447 ``/var/db/roundup/support`` and ``var/db/roundup/devel`` and accessed |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
448 as ``https://my.host/roundup/support/`` and ``https://my.host/roundup/devel/`` |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
449 respectively. Having them share same parent directory allows us to |
|
2559
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
450 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
|
451 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
|
452 interface (default). |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
453 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
454 Static files from ``html`` directory are served by apache itself - this |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
455 is quickier and generally more robust than doing that from python. |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
456 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
|
457 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
|
458 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
459 Example mod_python configuration:: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
460 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
461 ################################################# |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
462 # Roundup Issue tracker |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
463 ################################################# |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
464 # enable Python optimizations (like 'python -O') |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
465 PythonOptimize On |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
466 # let apache handle static files from 'html' directories |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
467 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
|
468 # everything else is handled by roundup web UI |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
469 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
|
470 # roundup requires a slash after tracker name - add it if missing |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
471 RedirectMatch permanent /roundup/([^/]+)$ /roundup/$1/ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
472 # common settings for all roundup trackers |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
473 <Directory /var/db/roundup/*> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
474 Order allow,deny |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
475 Allow from all |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
476 AllowOverride None |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
477 Options None |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
478 AddHandler python-program .py |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
479 PythonHandler roundup.cgi.apache |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
480 # 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
|
481 # (note that *some* tracebacks will be displayed anyway) |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
482 #PythonDebug On |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
483 </Directory> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
484 # 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
|
485 <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
|
486 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
|
487 PythonOption TrackerLanguage ru |
|
6c096b4aea67
added description and example of mod_python interface option TrackerLanguage
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2554
diff
changeset
|
488 </Directory> |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
489 <Directory /var/db/roundup/devel> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
490 PythonOption TrackerHome /var/db/roundup/devel |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
491 </Directory> |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
492 |
| 1228 | 493 |
| 494 Configure an Email Interface | |
| 495 ---------------------------- | |
| 496 | |
| 497 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
|
498 "``nosyreaction.py``" module from your tracker "``detectors``" directory. |
| 1228 | 499 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
500 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
|
501 |
| 1228 | 502 There are three supported ways to get emailed issues into the |
| 503 Roundup tracker. You should pick ONE of the following, all | |
| 504 of which will continue my example setup from above: | |
| 505 | |
| 506 As a mail alias pipe process | |
| 507 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 508 | |
| 509 Set up a mail alias called "issue_tracker" as (include the quote marks): | |
| 510 "``|/usr/bin/python /usr/local/bin/roundup-mailgw <tracker_home>``" | |
| 511 | |
| 512 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh so | |
| 513 sendmail will accept the pipe command. In that case, symlink | |
| 514 ``/etc/smrsh/roundup-mailgw`` to "``/usr/local/bin/roundup-mailgw``" and change | |
| 515 the command to:: | |
| 516 | |
| 517 |roundup-mailgw /opt/roundup/trackers/support | |
| 518 | |
| 519 To test the mail gateway on unix systems, try:: | |
| 520 | |
| 521 echo test |mail -s '[issue] test' support@YOUR_DOMAIN_HERE | |
| 522 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
523 As a regular job using a mailbox source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
524 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 525 |
| 526 Set ``roundup-mailgw`` up to run every 10 minutes or so. For example:: | |
| 527 | |
|
1878
862646176230
fix broken cron examples
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
1875
diff
changeset
|
528 0,10,20,30,40,50 * * * * /usr/local/bin/roundup-mailgw /opt/roundup/trackers/support mailbox <mail_spool_file> |
| 1228 | 529 |
| 530 Where the ``mail_spool_file`` argument is the location of the roundup submission | |
| 531 user's mail spool. On most systems, the spool for a user "issue_tracker" | |
| 532 will be "``/var/mail/issue_tracker``". | |
| 533 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
534 As a regular job using a POP source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
535 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 536 |
|
1878
862646176230
fix broken cron examples
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
1875
diff
changeset
|
537 To retrieve from a POP mailbox, use a *cron* entry similar to the mailbox one:: |
| 1228 | 538 |
|
1878
862646176230
fix broken cron examples
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
1875
diff
changeset
|
539 0,10,20,30,40,50 * * * * /usr/local/bin/roundup-mailgw /opt/roundup/trackers/support pop <pop_spec> |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
540 |
| 1228 | 541 where pop_spec is "``username:password@server``" that specifies the roundup |
| 542 submission user's POP account name, password and server. | |
| 543 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
544 On windows, you would set up the command using the windows scheduler. |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
545 |
|
2211
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
546 As a regular job using an IMAP source |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
547 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
548 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
549 To retrieve from an IMAP mailbox, use a *cron* entry similar to the |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
550 POP one:: |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
551 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
552 0,10,20,30,40,50 * * * * /usr/local/bin/roundup-mailgw /opt/roundup/trackers/support imap <imap_spec> |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
553 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
554 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
|
555 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
|
556 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
|
557 "``imap username:password@server mailbox``". |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
558 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
559 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
|
560 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
|
561 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
562 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
|
563 windows scheduler. |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
564 |
| 1228 | 565 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
566 UNIX Environment Steps |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
567 ---------------------- |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
568 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
569 Each tracker ideally should have its own UNIX group, so create |
| 1049 | 570 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if |
| 571 you're using NIS). To continue with my examples so far, I would | |
| 572 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
|
573 group does not have to be the same as the tracker name. To this |
| 1049 | 574 '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
|
575 working with this Roundup tracker. In addition to 'real' users, |
| 1049 | 576 the Roundup email gateway will need to have permissions to this |
| 577 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
|
578 group (typically "mail" or "daemon"). The UNIX group might then |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
579 look like:: |
| 1049 | 580 |
| 581 support:*:1002:jblaine,samh,geezer,mail | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
582 |
| 1049 | 583 If you intend to use the web interface (as most people do), you |
| 584 should also add the username your web server runs as to the group. | |
| 585 My group now looks like this:: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
586 |
| 1049 | 587 support:*:1002:jblaine,samh,geezer,mail,apache |
| 588 | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
589 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
|
590 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
|
591 by the group. |
|
344bad728d10
more tweakage of help display and style issues
Richard Jones <richard@users.sourceforge.net>
parents:
1049
diff
changeset
|
592 |
|
2594
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
593 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
|
594 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
|
595 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
|
596 to modify the database. Alternatively, explicitly specify a database login |
|
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
597 in ``POSTRGRESQL_DATABASE`` or ``MYSQL_DATABASE`` in ``config.py``. |
|
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
2559
diff
changeset
|
598 |
| 1049 | 599 An alternative to the above is to create a new user who has the sole |
| 600 responsibility of running roundup. This user: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
601 |
| 1049 | 602 1. runs the CGI interface daemon |
| 603 2. runs regular polls for email | |
| 604 3. runs regular checks (using cron) to ensure the daemon is up | |
| 605 4. optionally has no login password so that nobody but the "root" user | |
| 606 may actually login and play with the roundup setup. | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
607 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
608 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
609 Additional Language Codecs |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
610 -------------------------- |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
611 |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
612 If you intend to send messages to Roundup that use Chinese, Japanese or |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
613 Korean encodings the you'll need to obtain CJKCodecs from |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
614 http://cjkpython.berlios.de/ |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
615 |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
616 |
|
2069
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
617 |
| 1228 | 618 Maintenance |
| 619 =========== | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
620 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
621 Read the separate `administration guide`_ for information about how to |
| 1228 | 622 perform common maintenance tasks with Roundup. |
| 1049 | 623 |
|
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
|
624 |
|
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
|
625 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
|
626 ========= |
|
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
|
627 |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
628 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
|
629 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
|
630 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
|
631 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
632 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
633 Further Reading |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
634 =============== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
635 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
636 If you intend to use Roundup with anything other than the defualt |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
637 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
|
638 like implementation details, you should read `Customising Roundup`_. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
639 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
640 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
641 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
|
642 ========================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
643 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
644 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
|
645 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
|
646 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
|
647 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
648 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
|
649 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
|
650 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
|
651 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
|
652 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
|
653 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
|
654 "issue" class, but with different properties. See the customisation |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
655 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
|
656 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
657 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
658 Platform-Specific Notes |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
659 ======================= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
660 |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
661 Windows command-line tools |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
662 -------------------------- |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
663 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
664 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
|
665 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
|
666 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
667 On Windows 2000 and later: |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
668 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
669 1) Press the "Start" button. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
670 2) Choose "Settings" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
671 3) Choose "Control Panel" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
672 4) Choose "System" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
673 5) Choose "Advanced" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
674 6) Choose "Environmental Variables" |
|
1746
9c1da921cd35
minor rest tweak
Richard Jones <richard@users.sourceforge.net>
parents:
1688
diff
changeset
|
675 7) Add: "<dir>\Scripts" to the "Path" environmental variable. |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
676 |
| 1747 | 677 Where <dir> in 7) is the root directory (e.g., ``C:\Python22\Scripts``) |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
678 of your Python installation. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
679 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
680 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
|
681 Panel" is directly accessible from "Start". |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
682 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
683 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
|
684 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
685 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
686 Windows Server |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
687 -------------- |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
688 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
689 To have the Roundup web server start up when your machine boots up, set the |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
690 following up in Scheduled Tasks (note, the following is for a cygwin setup): |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
691 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
692 Run |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
693 ``c:\cygwin\bin\bash.exe -c "roundup-server TheProject=/opt/roundup/trackers/support"`` |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
694 Start In |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
695 ``C:\cygwin\opt\roundup\bin`` |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
696 Schedule |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
697 At System Startup |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
698 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
699 To have the Roundup mail gateway run periodically to poll a POP email address, |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
700 set the following up in Scheduled Tasks: |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1576
diff
changeset
|
701 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
702 Run |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
703 ``c:\cygwin\bin\bash.exe -c "roundup-mailgw /opt/roundup/trackers/support pop roundup:roundup@mail-server"`` |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
704 Start In |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
705 ``C:\cygwin\opt\roundup\bin`` |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
706 Schedule |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
707 Every 10 minutes from 5:00AM for 24 hours every day |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
708 Stop the task if it runs for 8 minutes |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
709 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
710 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
711 Sendmail smrsh |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
712 -------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
713 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
714 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
|
715 smrsh that roundup-mailgw is a valid/trusted mail handler |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
716 before it will work. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
717 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
718 This is usually done via the following 2 steps: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
719 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
720 1. make a symlink in ``/etc/smrsh`` called ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
721 which points to the full path of your actual ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
722 script. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
723 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
724 2. change your alias to ``"|roundup-mailgw <tracker_home>"`` |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
725 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
726 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
727 Linux |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
728 ----- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
729 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
730 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
|
731 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
732 Python 2.1.1 as shipped with SuSE7.3 might be missing module |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
733 ``_weakref``. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
734 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
735 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
736 Solaris |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
737 ------- |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
738 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
739 You'll need to build Python. |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
740 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
741 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
|
742 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
743 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
744 ------------------------------------------------------------------------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
745 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
746 Back to `Table of Contents`_ |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
747 |
|
1287
5402a6f2a754
Added quotes around python interpreter in windows bat [SF#623963]
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
748 Next: `User Guide`_ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
749 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
750 .. _`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
|
751 .. _`user guide`: user_guide.html |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
752 .. _`roundup specification`: spec.html |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
753 .. _`tracker configuration`: customizing.html#tracker-configuration |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
754 .. _`customisation documentation`: customizing.html |
|
2161
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
755 .. _`Adding a new field to the classic schema`: |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
756 customizing.html#adding-a-new-field-to-the-classic-schema |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
757 .. _`Tracking different types of issues`: |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
758 customizing.html#tracking-different-types-of-issues |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
759 .. _`customising roundup`: customizing.html |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
760 .. _`upgrading document`: upgrading.html |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
761 .. _`administration guide`: admin_guide.html |
|
2554
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
762 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
763 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
764 .. _External hyperlink targets: |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
765 |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
766 .. _apache: http://httpd.apache.org/ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
767 .. _metakit: http://www.equi4.com/metakit/ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
768 .. _mod_python: http://www.modpython.org/ |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
769 .. _MySQLdb: http://sourceforge.net/projects/mysql-python |
|
52944e87909c
added mod_python setup example
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
2449
diff
changeset
|
770 .. _Psycopg: http://initd.org/software/initd/psycopg |
| 2258 | 771 .. _pybsddb: http://pybsddb.sourceforge.net/ |
|
2238
df0444e39bc3
more useful pysqlite link
Richard Jones <richard@users.sourceforge.net>
parents:
2216
diff
changeset
|
772 .. _pysqlite: http://pysqlite.sourceforge.net/ |