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