Mercurial > p > roundup > code
annotate doc/installation.txt @ 1217:984c498e7deb
handle stupid mailers quoting subject lines
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Thu, 26 Sep 2002 00:01:51 +0000 |
| parents | af104fa52746 |
| children | 4c9882cb16a3 |
| 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 |
|
1170
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
5 :Version: $Revision: 1.24 $ |
|
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 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
16 Roundup support code |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
17 Installed into your Python install's lib directory |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
18 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
19 Roundup scripts |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
20 These include the email gateway, the roundup |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
21 HTTP server, the roundup administration command-line interface, etc. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
22 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
23 Roundup trackers |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
24 Trackers consist of core support files, issues |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
25 (be they bug reports or otherwise), tracker configuration file(s), |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
26 etc. Roundup trackers also adhere to a specific "Template" which |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
27 defines the fields usable/assignable on a per-issue basis. A |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
28 description of the provided templates follows. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
29 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
30 Classic Template |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
31 ---------------- |
|
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 The classic template is the one defined in the `Roundup Specification`_. It |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
34 holds issues which have priorities and statuses. Each issue may also have a |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
35 set of messages which are disseminated to the issue's list of nosy users. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
36 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
37 |
|
1170
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
38 Backends |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
39 -------- |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
40 |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
41 The actual storage of Roundup tracker information is handled by backends. |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
42 There's several to choose from, each with benefits and limitations: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
43 |
|
1170
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
44 **anydbm** |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
45 This backend is guaranteed to work on any system that Python runs on. It |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
46 will generally choose the best *dbm backend that is available on your system |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
47 (from the list dbhash, gdbm, dbm, dumbdbm). It is the least scaleable of all |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
48 backends, but performs well enough for a smallish tracker (a couple of |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
49 thousand issues, under fifty users, ...). |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
50 **bsddb** |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
51 This effectively the same as anydbm, but uses the bsddb backend. This allows |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
52 it to gain some performance and scaling benefits. |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
53 **bsddb3** |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
54 Again, this effectively the same as anydbm, but uses the bsddb3 backend. |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
55 This allows it to gain some performance and scaling benefits. |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
56 **sqlite** |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
57 This uses the SQLite embedded RDBMS to provide a fast, scaleable backend. |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
58 There are no limitations. |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
59 **gadfly** |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
60 This is a proof-of-concept relational database backend, not really intended |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
61 for actual production use, although it can be. It uses the Gadfly RDBMS |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
62 to store data. It is unable to perform string searches due to gadfly not |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
63 having a LIKE operation. It should scale well, assuming a client/server |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
64 setup is used. |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
65 **metakit** |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
66 This backend is implemented over the metakit storage system, using Mk4Py as |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
67 the interface. It scales much better than the *dbm backends, but has some |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
68 missing features: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
69 |
|
1170
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
70 - you may not unset properties once they are set |
|
af104fa52746
Added some words to the installation doc about choosing backends.
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
71 - journal retrieval is not implemented |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
72 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
73 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
74 Prerequisites |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
75 ============= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
76 |
|
727
779015e264b4
Note the version that is known to work.
Richard Jones <richard@users.sourceforge.net>
parents:
724
diff
changeset
|
77 Python 2.1.1 or newer with a functioning anydbm or bsddb module. Download the |
|
729
490bffefd5a0
"upgrade you doofus" text inserted to appease anthony ;)
Richard Jones <richard@users.sourceforge.net>
parents:
727
diff
changeset
|
78 latest version from http://www.python.org/. It is highly recommended that |
|
490bffefd5a0
"upgrade you doofus" text inserted to appease anthony ;)
Richard Jones <richard@users.sourceforge.net>
parents:
727
diff
changeset
|
79 users install the latest patch version of python - 2.1.3 or 2.2.1 - as these |
|
490bffefd5a0
"upgrade you doofus" text inserted to appease anthony ;)
Richard Jones <richard@users.sourceforge.net>
parents:
727
diff
changeset
|
80 contain many fixes to serious bugs. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
81 |
|
727
779015e264b4
Note the version that is known to work.
Richard Jones <richard@users.sourceforge.net>
parents:
724
diff
changeset
|
82 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
|
83 later. Download the latest version from http://pybsddb.sourceforge.net/. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
84 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
85 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
86 Getting Roundup |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
87 =============== |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
88 |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
89 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
|
90 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
91 Testing your Python |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
92 ------------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
93 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
94 Once you've unpacked roundup's source, run ``python ./run_tests`` in the |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
95 source directory and make sure there are no errors. |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
96 If there are errors, please let us know! |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
97 |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
98 If the above fails, you may be using the wrong version of python. Try |
|
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
99 ``python2 ./run_tests``. If that works, you will need to substitute |
|
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
100 ``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
|
101 Roundup -- from installation and scripts. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
102 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
103 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
104 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
105 ============ |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
106 |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
107 Set aside 15-30 minutes. Please make sure you're using a supported version of |
| 1049 | 108 Python -- see `testing your python`_. There's three sections to this |
| 109 installation guide: | |
| 110 | |
| 111 1. `basic installation steps`_ that all installers must follow | |
| 112 2. `shared environment steps`_ to take if you're installing on a shared | |
| 113 UNIX machine and want to restrict local access to roundup | |
| 114 3. `internet setup`_ steps to take if your tracker is to be used by the wider | |
| 115 internet community | |
| 116 | |
| 117 Most users will only need to follow the first step, since the environment will | |
| 118 be a trusted one. | |
| 119 | |
| 120 | |
| 121 Basic Installation Steps | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
122 ------------------------ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
123 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
124 1. To install the Roundup support code into your Python tree and |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
125 Roundup scripts into /usr/local/bin:: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
126 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
127 python setup.py install |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
128 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
129 If you would like to place the Roundup scripts in a directory other |
|
1024
0fa94554443f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1023
diff
changeset
|
130 than ``/usr/local/bin``, then specify the preferred location with |
|
1023
0161142aa903
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
998
diff
changeset
|
131 ``--install-script``. For example, to install them in |
|
0161142aa903
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
998
diff
changeset
|
132 ``/opt/roundup/bin``:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
133 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
134 python setup.py install --install-scripts=/opt/roundup/bin |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
135 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
136 2. To create a Roundup tracker (necessary to do before you can |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
137 use the software in any real fashion): |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
138 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
139 a. (Optional) If you intend to keep your roundup trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
140 under one top level directory which does not exist yet, |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
141 you should create that directory now. Example: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
142 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
143 mkdir /opt/roundup/trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
144 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
145 b. Either add the Roundup script location to your ``PATH`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
146 environment variable or specify the full path to |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
147 the command in the next step. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
148 |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
149 c. ``roundup-admin install`` |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
150 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
151 You will be asked a series of questions. A description of |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
152 the Roundup-provided templates can be found under the Overview_:: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
153 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
154 Enter tracker home: /opt/roundup/trackers/support |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
155 Templates: classic, extended |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
156 Select template [classic]: classic |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
157 Back ends: anydbm, bsddb |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
158 Select backend [anydbm]: anydbm |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
159 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
160 You will now be directed to edit the tracker configuration and |
| 741 | 161 initial schema. See `Customising Roundup`_ for details on configuration |
| 979 | 162 and schema changes. Note that you may change any of the configuration |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
163 after you've initialised the tracker - it's just better to have valid |
| 979 | 164 values for this stuff now. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
165 |
|
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
166 d. ``roundup-admin initialise`` |
|
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
167 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
168 This step initialises the tracker database. You will need to supply |
| 979 | 169 an admin password at this step. You will be prompted:: |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
170 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
171 Admin Password: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
172 Confirm: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
173 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
174 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
|
175 |
| 1049 | 176 3. XXX Set up the CGI interface |
| 177 | |
| 178 4. XXX Set up the mail gateway | |
| 179 | |
| 180 | |
| 181 Shared Environment Steps | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
182 ------------------------ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
183 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
184 Each tracker ideally should have its own UNIX group, so create |
| 1049 | 185 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if |
| 186 you're using NIS). To continue with my examples so far, I would | |
| 187 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
|
188 group does not have to be the same as the tracker name. To this |
| 1049 | 189 '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
|
190 working with this Roundup tracker. In addition to 'real' users, |
| 1049 | 191 the Roundup email gateway will need to have permissions to this |
| 192 area as well, so add the user your mail service runs as to the | |
| 193 group. The UNIX group might then look like:: | |
| 194 | |
| 195 support:*:1002:jblaine,samh,geezer,mail | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
196 |
| 1049 | 197 If you intend to use the web interface (as most people do), you |
| 198 should also add the username your web server runs as to the group. | |
| 199 My group now looks like this:: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
200 |
| 1049 | 201 support:*:1002:jblaine,samh,geezer,mail,apache |
| 202 | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
203 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
|
204 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
|
205 by the group. |
|
344bad728d10
more tweakage of help display and style issues
Richard Jones <richard@users.sourceforge.net>
parents:
1049
diff
changeset
|
206 |
| 1049 | 207 An alternative to the above is to create a new user who has the sole |
| 208 responsibility of running roundup. This user: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
209 |
| 1049 | 210 1. runs the CGI interface daemon |
| 211 2. runs regular polls for email | |
| 212 3. runs regular checks (using cron) to ensure the daemon is up | |
| 213 4. optionally has no login password so that nobody but the "root" user | |
| 214 may actually login and play with the roundup setup. | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
215 |
| 1049 | 216 Internet Setup |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
217 -------------- |
| 1049 | 218 |
| 219 1. There are two supported ways to get emailed issues into the | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
220 Roundup tracker. You should pick ONE of the following, both |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
221 of which will continue my example setup from above: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
222 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
223 a. Set up a mail alias called "support" as:: |
|
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 "|/opt/roundup/bin/roundup-mailgw /opt/roundup/trackers/support" |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
226 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
227 If you use Sendmail's ``smrsh`` mechanism, please read the notes |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
228 under 'Platform-Specific Notes' |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
229 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
230 b. OR... Configure roundup-mailgw to run every 10 minutes or |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
231 so via ``cron``. My cron job would be (these 2 lines all on one |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
232 line):: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
233 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
234 10 * * * * /opt/roundup/bin/roundup-mailgw |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
235 /opt/roundup/trackers/support /var/mail/support |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
236 |
|
1023
0161142aa903
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
998
diff
changeset
|
237 If you don't want to use the email component of Roundup, then remove the |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
238 "``nosyreator.py``" module from your tracker "``detectors``" directory. |
|
1023
0161142aa903
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
998
diff
changeset
|
239 |
| 1049 | 240 2. Test the email gateway. Under most flavors of UNIX, this |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
241 can be done by:: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
242 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
243 echo test | mail -s '[issue] test' support@YOUR_DOMAIN_HERE |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
244 |
| 1049 | 245 XXX mention HTTPS |
| 246 XXX mention Basic vs. cookie auth | |
| 247 | |
|
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
|
248 |
|
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
|
249 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
|
250 ========= |
|
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
|
251 |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
252 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
|
253 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
|
254 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
|
255 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
256 |
|
724
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
257 ZRoundup |
|
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
258 ======== |
|
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
259 |
|
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
260 Install roundup as usual (see installation_). |
|
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
261 |
|
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
262 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to |
|
1096
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1089
diff
changeset
|
263 your Products directory either in an TRACKER_HOME/Products or the Zope |
|
724
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
264 code tree lib/python/Products. |
|
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
265 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
266 You will need to create the tracker using the roundup-admin tool (step 2 in |
|
724
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
267 installation_). |
|
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
268 |
|
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
269 When you next (re)start up Zope, you will be able to add a ZRoundup object |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
270 that interfaces to your new tracker. |
|
724
0085e1d718c4
Made ZRoundup install info more accessible.
Richard Jones <richard@users.sourceforge.net>
parents:
688
diff
changeset
|
271 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
272 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
273 Further Reading |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
274 =============== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
275 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
276 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
|
277 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
|
278 like implementation details, you should read `Customising Roundup`_. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
279 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
280 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
281 Platform-Specific Notes |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
282 ======================= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
283 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
284 Sendmail smrsh |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
285 -------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
286 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
287 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
|
288 smrsh that roundup-mailgw is a valid/trusted mail handler |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
289 before it will work. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
290 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
291 This is usually done via the following 2 steps: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
292 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
293 1. make a symlink in ``/etc/smrsh`` called ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
294 which points to the full path of your actual ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
295 script. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
296 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
297 2. change your alias to ``"|roundup-mailgw <tracker_home>"`` |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
298 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
299 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
300 Linux |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
301 ----- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
302 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
303 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
|
304 ``_weakref``. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
305 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
306 ------------------------------------------------------------------------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
307 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
308 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
|
309 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
310 Next: `Getting Started`_ |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
311 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
312 .. _`table of contents`: index.html |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
313 .. _`getting started`: getting_started.html |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
314 .. _`roundup specification`: spec.html |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
315 .. _`customising roundup`: customizing.html |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
316 .. _`upgrading document`: upgrading.html |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
317 |