Mercurial > p > roundup > code
annotate doc/installation.txt @ 2365:3a80831ecebe
If the target platform is win32, create .bat files...
...instead of *nix shell scripts.
Target platform is set to "win32" if main command is 'bdist_wininst'
or if the command is 'bdist' and it has the list of formats (from
command line or config file) and the first item on that list is wininst.
Otherwise target platform is set to current (build) platform.
| author | Alexander Smishlajev <a1s@users.sourceforge.net> |
|---|---|
| date | Wed, 26 May 2004 10:00:53 +0000 |
| parents | c8f426142289 |
| children | a405124c3847 ef226254ef46 |
| 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 |
| 2258 | 5 :Version: $Revision: 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:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
8 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
10 Overview |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
11 ======== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
12 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
13 Broken out separately, there are several conceptual pieces to a |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
14 Roundup installation: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
15 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
16 Roundup trackers |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
17 Trackers consist of issues (be they bug reports or otherwise), tracker |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
18 configuration file(s), web HTML files etc. Roundup trackers are initialised |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
19 with a "Template" which defines the fields usable/assignable on a |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
20 per-issue basis. Descriptions of the provided templates are given in |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
21 `choosing your template`_. |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
22 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
23 Roundup support code |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
24 Installed into your Python install's lib directory |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
25 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
26 Roundup scripts |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
27 These include the email gateway, the roundup |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
28 HTTP server, the roundup administration command-line interface, etc. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
29 |
|
1218
4c9882cb16a3
more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
1170
diff
changeset
|
30 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
31 Prerequisites |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
32 ============= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
33 |
|
1965
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
34 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
|
35 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
|
36 It is highly recommended that users install the latest patch version |
|
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
37 of python as these contain many fixes to serious bugs. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
38 |
|
727
779015e264b4
Note the version that is known to work.
Richard Jones <richard@users.sourceforge.net>
parents:
724
diff
changeset
|
39 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
|
40 later. Download the latest version from http://pybsddb.sourceforge.net/. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
41 |
|
1300
11ba3c565362
documented dependency on Active State [SF#623959]
Richard Jones <richard@users.sourceforge.net>
parents:
1287
diff
changeset
|
42 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
|
43 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
|
44 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
|
45 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
|
46 |
|
2069
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
47 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
|
48 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
49 Install the "CSV" module |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
50 ------------------------ |
|
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 Note: CSV stands for Comma-Separated-Value. These files are used by all |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
53 manner of programs (eg. spreadsheets) to exchange data. |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
54 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
55 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
|
56 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
|
57 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
58 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
|
59 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
|
60 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
|
61 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
|
62 install``.) |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
63 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
64 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
|
65 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
|
66 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
|
67 For Python 2.2, this would be:: |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
68 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
69 c:\python22\lib\site-packages |
|
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 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
|
72 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
|
73 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
74 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
|
75 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
|
76 |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
77 .. _`Object Craft`: http://object-craft.com.au/ |
|
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
78 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
79 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
80 Getting Roundup |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
81 =============== |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
82 |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
83 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
|
84 |
|
2216
759ed26e24dd
help for winzip users
Richard Jones <richard@users.sourceforge.net>
parents:
2211
diff
changeset
|
85 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
|
86 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
|
87 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
88 Testing your Python |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
89 ------------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
90 |
|
1875
3ffb7b56172a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1850
diff
changeset
|
91 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
|
92 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
|
93 please let us know! |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
94 |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
95 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
|
96 ``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
|
97 ``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
|
98 Roundup -- from installation and scripts. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
99 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
100 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
101 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
|
102 ======================== |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
103 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
104 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
|
105 ``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
|
106 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
|
107 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
|
108 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
109 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
|
110 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
|
111 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
|
112 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
|
113 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
114 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
115 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
116 ============ |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
117 |
|
1850
6e80f8f760a4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1845
diff
changeset
|
118 :Note: Some systems, such as Debian and NetBSD, already have Roundup |
|
6e80f8f760a4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1845
diff
changeset
|
119 installed. Try running the command "roundup-admin" with no arguments, |
|
6e80f8f760a4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1845
diff
changeset
|
120 and if it runs you may skip the `Basic Installation Steps`_ |
|
6e80f8f760a4
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1845
diff
changeset
|
121 below and go straight to `configuring your first tracker`_. |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
122 |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
123 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
|
124 Python -- see `testing your python`_. There's several steps to follow in your |
| 1228 | 125 installation: |
| 1049 | 126 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
127 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
|
128 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
|
129 3. then optionally `configure a web interface`_ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
130 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
|
131 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
|
132 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
|
133 6. `additional language codecs`_ |
| 1049 | 134 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
135 For information about how Roundup installs, see the `administration |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
136 guide`_. |
|
1965
43e1f2457bf2
info about how roundup is installed
Richard Jones <richard@users.sourceforge.net>
parents:
1939
diff
changeset
|
137 |
| 1049 | 138 |
| 139 Basic Installation Steps | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
140 ------------------------ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
141 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
142 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
|
143 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
|
144 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
|
145 for these locations, eg. being root on unix:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
146 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
147 python setup.py install |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
148 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
149 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
|
150 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
|
151 ``--install-script``. For example, to install them in |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
152 ``/opt/roundup/bin``:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
153 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
154 python setup.py install --install-scripts=/opt/roundup/bin |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
155 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
156 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
|
157 base directory, if you do not want to use administrator rights. If you |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
158 choose to do this, take note of the message at the end of installation |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
159 and modify the python path accordingly. |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1245
diff
changeset
|
160 |
|
1590
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 Configuring your first tracker |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
163 ------------------------------ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
164 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
165 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
|
166 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
|
167 home": |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
168 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
169 a. (Optional) If you intend to keep your roundup trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
170 under one top level directory which does not exist yet, |
| 1228 | 171 you should create that directory now. Example:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
172 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
173 mkdir /opt/roundup/trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
174 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
175 b. Either add the Roundup script location to your ``PATH`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
176 environment variable or specify the full path to |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
177 the command in the next step. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
178 |
| 1228 | 179 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
|
180 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
|
181 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
|
182 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
|
183 below. The questions will be something like (you may have more |
| 1228 | 184 templates or backends available):: |
|
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 Enter tracker home: /opt/roundup/trackers/support |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
187 Templates: classic |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
188 Select template [classic]: classic |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
189 Back ends: anydbm, bsddb |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
190 Select backend [anydbm]: anydbm |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
191 |
|
1571
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
192 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
|
193 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
|
194 will be stored in. |
|
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
195 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
196 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
|
197 initial schema. At a minimum, you must set ``MAILHOST``, |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
198 ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. Note that the |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
199 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
|
200 ``'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
|
201 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
|
202 of the `customisation documentation`_. |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
203 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
204 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
|
205 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
|
206 TRACKER_WEB variable to:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
207 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
208 TRACKER_WEB = 'http://localhost:8080/support/' |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
209 |
|
1310
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
210 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
|
211 See `Customising Roundup`_ for details on configuration and schema |
|
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
212 changes. Note that you may change any of the configuration after |
|
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
213 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
|
214 for this stuff now. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
215 |
| 1228 | 216 d. Initialise the tracker database with ``roundup-admin initialise``. |
| 217 You will need to supply an admin password at this step. You will be | |
| 218 prompted:: | |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
219 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
220 Admin Password: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
221 Confirm: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
222 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
223 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
|
224 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
225 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
|
226 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
|
227 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
|
228 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
|
229 ``'http://localhost:8080/support/'``, run:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
230 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
231 roundup-server support=/opt/roundup/trackers/support |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
232 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
233 then direct your web browser at: |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
234 |
|
1845
3c6dd167a744
Fix typo in server address [SF#822967].
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1839
diff
changeset
|
235 http://localhost:8080/support/ |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
236 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
237 and you should see the tracker interface. |
| 1049 | 238 |
| 239 | |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
240 Choosing Your Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
241 ---------------------- |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
242 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
243 Classic Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
244 ~~~~~~~~~~~~~~~~ |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
245 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
246 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
|
247 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
|
248 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
|
249 |
|
1227
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
250 Minimal Template |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
251 ~~~~~~~~~~~~~~~~ |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
252 |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
253 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
|
254 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
|
255 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
|
256 create your tracker on. |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
257 |
|
1221
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 Choosing Your Backend |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
260 --------------------- |
|
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 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
|
263 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
|
264 |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
265 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
266 Name Speed Users Support |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
267 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
268 anydbm Slowest Few Always available |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
269 bsddb Slow Few Usually available |
| 2258 | 270 bsddb3 Slow Few Needs install (pybsddb_) |
|
2238
df0444e39bc3
more useful pysqlite link
Richard Jones <richard@users.sourceforge.net>
parents:
2216
diff
changeset
|
271 sqlite Fastest(*) Few Needs install (PySQLite_) |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
272 metakit Fastest(*) Few Needs install (metakit_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
273 postgresql Fast Many Needs install/admin (psycopg_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
274 mysql Fast Many Needs install/admin (MySQLdb_) |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
275 ========== =========== ===== ============================== |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
276 |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
277 **sqlite** and **metakit** |
|
2238
df0444e39bc3
more useful pysqlite link
Richard Jones <richard@users.sourceforge.net>
parents:
2216
diff
changeset
|
278 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
|
279 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
|
280 many simultaneous users. |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
281 **postgresql** |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
282 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
|
283 additional installation steps and requirements. |
|
1507
3481507d6098
Advertising mysql
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1317
diff
changeset
|
284 **mysql** |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
285 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
|
286 installation steps and requirements. |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
287 |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
288 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
|
289 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
|
290 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
|
291 guide`_. |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
292 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
293 |
| 1228 | 294 Configure a Web Interface |
| 295 ------------------------- | |
| 296 | |
| 297 There are three web interfaces to choose from: | |
| 298 | |
| 299 1. `web server cgi-bin`_ | |
| 300 2. `stand-alone web server`_ | |
| 301 3. `Zope product - ZRoundup`_ | |
| 302 | |
| 303 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
|
304 - 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
|
305 configure your system in some way - see `platform-specific notes`_. |
| 1228 | 306 |
| 307 | |
| 308 Web Server cgi-bin | |
| 309 ~~~~~~~~~~~~~~~~~~ | |
| 310 | |
| 311 A benefit of using the cgi-bin approach is that it's the easiest way to | |
| 312 restrict access to your tracker to only use HTTPS. Access will be slower | |
| 313 than through the `stand-alone web server`_ though. | |
| 314 | |
|
1748
0f2678eeeac6
cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents:
1747
diff
changeset
|
315 Note that if your Python isn't install as "python" then you'll need to edit |
|
0f2678eeeac6
cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents:
1747
diff
changeset
|
316 the ``roundup.cgi`` script to fix the first line. |
|
0f2678eeeac6
cgi-bin install note
Richard Jones <richard@users.sourceforge.net>
parents:
1747
diff
changeset
|
317 |
|
1540
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
318 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
|
319 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
|
320 |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
321 adsutil.vbs set w3svc/AllowPathInfoForScriptMappings TRUE |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
322 |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
323 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
|
324 or ``c:\winnt\system32\inetsrv\adminsamples\`` or |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
325 ``c:\winnt\system32\inetsrv\adminscripts\`` depending on your installation. |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
326 |
| 1228 | 327 Copy the ``cgi-bin/roundup.cgi`` file to your web server's ``cgi-bin`` |
| 328 directory. You will need to configure it to tell it where your tracker home | |
| 329 is. You can do this either: | |
| 330 | |
| 331 through an environment variable | |
| 332 set the variable TRACKER_HOMES to be a colon (":") separated list of | |
| 333 name=home pairs (if you're using apache, the SetEnv directive can do this) | |
| 334 directly in the ``roundup.cgi`` file itself | |
| 335 add your instance to the TRACKER_HOMES variable as ``'name': 'home'`` | |
| 336 | |
| 337 The "name" part of the configuration will appear in the URL and identifies the | |
| 338 tracker (so you may have more than one tracker per cgi-bin script). Make sure | |
| 339 there are no spaces or other illegal characters in it (to be safe, stick to | |
| 340 letters and numbers). The "name" forms part of the URL that appears in the | |
| 341 tracker config TRACKER_WEB variable, so make sure they match. The "home" | |
| 342 part of the configuration is the tracker home directory. | |
| 343 | |
| 344 Stand-alone Web Server | |
| 345 ~~~~~~~~~~~~~~~~~~~~~~ | |
| 346 | |
| 347 This approach will give you the fastest of the three web interfaces. You may | |
| 348 investigate using ProxyPass or similar configuration in apache to have your | |
| 349 tracker accessed through the same URL as other systems. | |
| 350 | |
| 351 The stand-alone web server is started with the command ``roundup-server``. It | |
| 352 has several options - display them with ``roundup-server -h``. | |
| 353 | |
| 354 The tracker home configuration is similar to the cgi-bin - you may either edit | |
| 355 the script to change the TRACKER_HOMES variable or you may supply the | |
| 356 name=home values on the command-line after all the other options. | |
| 357 | |
| 358 To make the server run in the background, use the "-d" option, specifying the | |
| 359 name of a file to write the server process id (pid) to. | |
| 360 | |
| 361 | |
| 362 Zope Product - ZRoundup | |
| 363 ~~~~~~~~~~~~~~~~~~~~~~~ | |
| 364 | |
| 365 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to | |
| 366 your Products directory either in INSTANCE_HOME/Products or the Zope | |
| 367 code tree lib/python/Products. | |
| 368 | |
| 369 When you next (re)start up Zope, you will be able to add a ZRoundup object | |
| 370 that interfaces to your new tracker. | |
| 371 | |
| 372 | |
| 373 Configure an Email Interface | |
| 374 ---------------------------- | |
| 375 | |
| 376 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
|
377 "``nosyreaction.py``" module from your tracker "``detectors``" directory. |
| 1228 | 378 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
379 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
|
380 |
| 1228 | 381 There are three supported ways to get emailed issues into the |
| 382 Roundup tracker. You should pick ONE of the following, all | |
| 383 of which will continue my example setup from above: | |
| 384 | |
| 385 As a mail alias pipe process | |
| 386 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 387 | |
| 388 Set up a mail alias called "issue_tracker" as (include the quote marks): | |
| 389 "``|/usr/bin/python /usr/local/bin/roundup-mailgw <tracker_home>``" | |
| 390 | |
| 391 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh so | |
| 392 sendmail will accept the pipe command. In that case, symlink | |
| 393 ``/etc/smrsh/roundup-mailgw`` to "``/usr/local/bin/roundup-mailgw``" and change | |
| 394 the command to:: | |
| 395 | |
| 396 |roundup-mailgw /opt/roundup/trackers/support | |
| 397 | |
| 398 To test the mail gateway on unix systems, try:: | |
| 399 | |
| 400 echo test |mail -s '[issue] test' support@YOUR_DOMAIN_HERE | |
| 401 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
402 As a regular job using a mailbox source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
403 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 404 |
| 405 Set ``roundup-mailgw`` up to run every 10 minutes or so. For example:: | |
| 406 | |
|
1878
862646176230
fix broken cron examples
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
1875
diff
changeset
|
407 0,10,20,30,40,50 * * * * /usr/local/bin/roundup-mailgw /opt/roundup/trackers/support mailbox <mail_spool_file> |
| 1228 | 408 |
| 409 Where the ``mail_spool_file`` argument is the location of the roundup submission | |
| 410 user's mail spool. On most systems, the spool for a user "issue_tracker" | |
| 411 will be "``/var/mail/issue_tracker``". | |
| 412 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
413 As a regular job using a POP source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
414 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 415 |
|
1878
862646176230
fix broken cron examples
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
1875
diff
changeset
|
416 To retrieve from a POP mailbox, use a *cron* entry similar to the mailbox one:: |
| 1228 | 417 |
|
1878
862646176230
fix broken cron examples
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
1875
diff
changeset
|
418 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
|
419 |
| 1228 | 420 where pop_spec is "``username:password@server``" that specifies the roundup |
| 421 submission user's POP account name, password and server. | |
| 422 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
423 On windows, you would set up the command using the windows scheduler. |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
424 |
|
2211
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
425 As a regular job using an IMAP source |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
426 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
427 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
428 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
|
429 POP one:: |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
430 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
431 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
|
432 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
433 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
|
434 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
|
435 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
|
436 "``imap username:password@server mailbox``". |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
437 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
438 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
|
439 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
|
440 |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
441 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
|
442 windows scheduler. |
|
272b654b1227
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2186
diff
changeset
|
443 |
| 1228 | 444 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
445 UNIX Environment Steps |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
446 ---------------------- |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
447 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
448 Each tracker ideally should have its own UNIX group, so create |
| 1049 | 449 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if |
| 450 you're using NIS). To continue with my examples so far, I would | |
| 451 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
|
452 group does not have to be the same as the tracker name. To this |
| 1049 | 453 '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
|
454 working with this Roundup tracker. In addition to 'real' users, |
| 1049 | 455 the Roundup email gateway will need to have permissions to this |
| 456 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
|
457 group (typically "mail" or "daemon"). The UNIX group might then |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
458 look like:: |
| 1049 | 459 |
| 460 support:*:1002:jblaine,samh,geezer,mail | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
461 |
| 1049 | 462 If you intend to use the web interface (as most people do), you |
| 463 should also add the username your web server runs as to the group. | |
| 464 My group now looks like this:: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
465 |
| 1049 | 466 support:*:1002:jblaine,samh,geezer,mail,apache |
| 467 | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
468 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
|
469 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
|
470 by the group. |
|
344bad728d10
more tweakage of help display and style issues
Richard Jones <richard@users.sourceforge.net>
parents:
1049
diff
changeset
|
471 |
| 1049 | 472 An alternative to the above is to create a new user who has the sole |
| 473 responsibility of running roundup. This user: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
474 |
| 1049 | 475 1. runs the CGI interface daemon |
| 476 2. runs regular polls for email | |
| 477 3. runs regular checks (using cron) to ensure the daemon is up | |
| 478 4. optionally has no login password so that nobody but the "root" user | |
| 479 may actually login and play with the roundup setup. | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
480 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
481 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
482 Additional Language Codecs |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
483 -------------------------- |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
484 |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
485 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
|
486 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
|
487 http://cjkpython.berlios.de/ |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
488 |
|
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
489 |
|
2069
d8c7fd205cd8
info for installing the CSV module
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
490 |
| 1228 | 491 Maintenance |
| 492 =========== | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
493 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
494 Read the separate `administration guide`_ for information about how to |
| 1228 | 495 perform common maintenance tasks with Roundup. |
| 1049 | 496 |
|
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
|
497 |
|
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
|
498 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
|
499 ========= |
|
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
|
500 |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
501 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
|
502 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
|
503 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
|
504 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
505 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
506 Further Reading |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
507 =============== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
508 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
509 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
|
510 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
|
511 like implementation details, you should read `Customising Roundup`_. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
512 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
513 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
514 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
|
515 ========================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
516 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
517 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
|
518 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
|
519 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
|
520 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
521 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
|
522 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
|
523 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
|
524 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
|
525 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
|
526 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
|
527 "issue" class, but with different properties. See the customisation |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
528 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
|
529 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
530 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
531 Platform-Specific Notes |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
532 ======================= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
533 |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
534 Windows command-line tools |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
535 -------------------------- |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
536 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
537 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
|
538 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
|
539 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
540 On Windows 2000 and later: |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
541 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
542 1) Press the "Start" button. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
543 2) Choose "Settings" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
544 3) Choose "Control Panel" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
545 4) Choose "System" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
546 5) Choose "Advanced" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
547 6) Choose "Environmental Variables" |
|
1746
9c1da921cd35
minor rest tweak
Richard Jones <richard@users.sourceforge.net>
parents:
1688
diff
changeset
|
548 7) Add: "<dir>\Scripts" to the "Path" environmental variable. |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
549 |
| 1747 | 550 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
|
551 of your Python installation. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
552 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
553 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
|
554 Panel" is directly accessible from "Start". |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
555 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
556 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
|
557 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
558 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
559 Windows Server |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
560 -------------- |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
561 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
562 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
|
563 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
|
564 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
565 Run |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
566 ``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
|
567 Start In |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
568 ``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
|
569 Schedule |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
570 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
|
571 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
572 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
|
573 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
|
574 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
575 Run |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
576 ``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
|
577 Start In |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
578 ``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
|
579 Schedule |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
580 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
|
581 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
|
582 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
583 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
584 Sendmail smrsh |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
585 -------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
586 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
587 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
|
588 smrsh that roundup-mailgw is a valid/trusted mail handler |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
589 before it will work. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
590 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
591 This is usually done via the following 2 steps: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
592 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
593 1. make a symlink in ``/etc/smrsh`` called ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
594 which points to the full path of your actual ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
595 script. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
596 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
597 2. change your alias to ``"|roundup-mailgw <tracker_home>"`` |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
598 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
599 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
600 Linux |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
601 ----- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
602 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
603 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
|
604 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
605 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
|
606 ``_weakref``. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
607 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
608 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
609 Solaris |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
610 ------- |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
611 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
612 You'll need to build Python. |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
613 |
|
1939
1303c208419d
some updates that were sitting on disk
Richard Jones <richard@users.sourceforge.net>
parents:
1913
diff
changeset
|
614 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
|
615 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
616 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
617 ------------------------------------------------------------------------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
618 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
619 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
|
620 |
|
1287
5402a6f2a754
Added quotes around python interpreter in windows bat [SF#623963]
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
621 Next: `User Guide`_ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
622 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
623 .. _`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
|
624 .. _`user guide`: user_guide.html |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
625 .. _`roundup specification`: spec.html |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
626 .. _`tracker configuration`: customizing.html#tracker-configuration |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
627 .. _`customisation documentation`: customizing.html |
|
2161
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
628 .. _`Adding a new field to the classic schema`: |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
629 customizing.html#adding-a-new-field-to-the-classic-schema |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
630 .. _`Tracking different types of issues`: |
|
98656054ccfa
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2069
diff
changeset
|
631 customizing.html#tracking-different-types-of-issues |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
632 .. _`customising roundup`: customizing.html |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
633 .. _`upgrading document`: upgrading.html |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
1965
diff
changeset
|
634 .. _`administration guide`: admin_guide.html |
| 2258 | 635 .. _pybsddb: http://pybsddb.sourceforge.net/ |
|
2238
df0444e39bc3
more useful pysqlite link
Richard Jones <richard@users.sourceforge.net>
parents:
2216
diff
changeset
|
636 .. _pysqlite: http://pysqlite.sourceforge.net/ |
| 1228 | 637 .. _metakit: http://www.equi4.com/metakit/ |
|
2179
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
638 .. _Psycopg: http://initd.org/software/initd/psycopg |
|
5aa74f9879ac
rework the backend selection bit
Richard Jones <richard@users.sourceforge.net>
parents:
2161
diff
changeset
|
639 .. _MySQLdb: http://sourceforge.net/projects/mysql-python |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
640 |