Mercurial > p > roundup > code
annotate doc/installation.txt @ 2064:fd4763c6efae maint-0.6 0.6.7
pre-release stuff
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Mon, 01 Mar 2004 00:07:27 +0000 |
| parents | 41c0241ea9c9 |
| children | 6807107fc8aa |
| 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 |
|
1879
41c0241ea9c9
fixup cron samples
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
1851
diff
changeset
|
5 :Version: $Revision: 1.55.2.5 $ |
|
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 |
| 1849 | 34 Python 2.1.3 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
|
35 latest version from http://www.python.org/. It is highly recommended that |
| 1849 | 36 users install the latest patch version of python - 2.1.3, 2.2.3 or 2.3.2 - |
| 37 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 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
47 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
48 Getting Roundup |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
49 =============== |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
50 |
|
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
51 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
|
52 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
53 Testing your Python |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
54 ------------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
55 |
|
998
a1922b2521a7
reordering to make a little more sense
Richard Jones <richard@users.sourceforge.net>
parents:
991
diff
changeset
|
56 Once you've unpacked roundup's source, run ``python ./run_tests`` in the |
| 1849 | 57 source directory and make sure there are no errors. If there are errors, |
| 58 please let us know! | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
59 |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
60 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
|
61 ``python2 ./run_tests``. If that works, you will need to substitute |
|
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
62 ``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
|
63 Roundup -- from installation and scripts. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
64 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
65 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
66 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
|
67 ======================== |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
68 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
69 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
|
70 ``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
|
71 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
|
72 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
|
73 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
74 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
|
75 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
|
76 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
|
77 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
|
78 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
79 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
80 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
81 ============ |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
82 |
|
1851
fe15b8506d47
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1849
diff
changeset
|
83 :Note: Some systems, such as Debian and NetBSD, already have Roundup |
|
fe15b8506d47
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1849
diff
changeset
|
84 installed. Try running the command "roundup-admin" with no arguments, |
|
fe15b8506d47
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1849
diff
changeset
|
85 and if it runs you may skip the `Basic Installation Steps`_ |
|
fe15b8506d47
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1849
diff
changeset
|
86 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
|
87 |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
88 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
|
89 Python -- see `testing your python`_. There's several steps to follow in your |
| 1228 | 90 installation: |
| 1049 | 91 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
92 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
|
93 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
|
94 3. then optionally `configure a web interface`_ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
95 4. and optionally `configure an email interface`_ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
96 5. `shared 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
|
97 UNIX machine and want to restrict local access to roundup |
| 1049 | 98 |
| 99 | |
| 100 Basic Installation Steps | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
101 ------------------------ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
102 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
103 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
|
104 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
|
105 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
|
106 for these locations, eg. being root on unix:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
107 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
108 python setup.py install |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
109 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
110 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
|
111 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
|
112 ``--install-script``. For example, to install them in |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
113 ``/opt/roundup/bin``:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
114 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
115 python setup.py install --install-scripts=/opt/roundup/bin |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
116 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
117 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
|
118 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
|
119 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
|
120 and modify the python path accordingly. |
|
1282
2feb3e0a9955
included doc ideas from Bernhard Reiter
Richard Jones <richard@users.sourceforge.net>
parents:
1245
diff
changeset
|
121 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
122 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
123 Configuring your first tracker |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
124 ------------------------------ |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
125 |
|
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
126 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
|
127 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
|
128 home": |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
129 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
130 a. (Optional) If you intend to keep your roundup trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
131 under one top level directory which does not exist yet, |
| 1228 | 132 you should create that directory now. Example:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
133 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
134 mkdir /opt/roundup/trackers |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
135 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
136 b. Either add the Roundup script location to your ``PATH`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
137 environment variable or specify the full path to |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
138 the command in the next step. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
139 |
| 1228 | 140 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
|
141 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
|
142 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
|
143 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
|
144 below. The questions will be something like (you may have more |
| 1228 | 145 templates or backends available):: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
146 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
147 Enter tracker home: /opt/roundup/trackers/support |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
148 Templates: classic |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
149 Select template [classic]: classic |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
150 Back ends: anydbm, bsddb |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
151 Select backend [anydbm]: anydbm |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
152 |
|
1571
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
153 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
|
154 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
|
155 will be stored in. |
|
8b5ff6ca0674
more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents:
1560
diff
changeset
|
156 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
157 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
|
158 initial schema. At a minimum, you must set ``MAILHOST``, |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
159 ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. Note that the |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
160 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
|
161 ``'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
|
162 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
|
163 of the `customisation documentation`_. |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
164 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
165 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
|
166 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
|
167 TRACKER_WEB variable to:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
168 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
169 TRACKER_WEB = 'http://localhost:8080/support/' |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
170 |
|
1310
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
171 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
|
172 See `Customising Roundup`_ for details on configuration and schema |
|
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
173 changes. Note that you may change any of the configuration after |
|
ff7b08d9ceb5
more URL trailing-/ requirements
Richard Jones <richard@users.sourceforge.net>
parents:
1300
diff
changeset
|
174 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
|
175 for this stuff now. |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
176 |
| 1228 | 177 d. Initialise the tracker database with ``roundup-admin initialise``. |
| 178 You will need to supply an admin password at this step. You will be | |
| 179 prompted:: | |
|
738
7e093cbaaa98
split instance initialisation into two steps...
Richard Jones <richard@users.sourceforge.net>
parents:
729
diff
changeset
|
180 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
181 Admin Password: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
182 Confirm: |
|
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 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
|
185 |
|
1590
198dbefc1d5a
more installation doc cleanups
Richard Jones <richard@users.sourceforge.net>
parents:
1588
diff
changeset
|
186 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
|
187 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
|
188 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
|
189 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
|
190 ``'http://localhost:8080/support/'``, run:: |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
191 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
192 roundup-server support=/opt/roundup/trackers/support |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
193 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
194 then direct your web browser at: |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
195 |
|
1846
cc13abad744e
Backport fix for typo in server address [SF#822967].
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1750
diff
changeset
|
196 http://localhost:8080/support/ |
|
1244
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
197 |
|
8dd4f736370b
merge from maintenance branch
Richard Jones <richard@users.sourceforge.net>
parents:
1240
diff
changeset
|
198 and you should see the tracker interface. |
| 1049 | 199 |
| 200 | |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
201 Choosing Your Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
202 ---------------------- |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
203 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
204 Classic Template |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
205 ~~~~~~~~~~~~~~~~ |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
206 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
207 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
|
208 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
|
209 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
|
210 |
|
1227
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
211 Minimal Template |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
212 ~~~~~~~~~~~~~~~~ |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
213 |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
214 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
|
215 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
|
216 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
|
217 create your tracker on. |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1221
diff
changeset
|
218 |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
219 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
220 Choosing Your Backend |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
221 --------------------- |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
222 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
223 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
|
224 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
|
225 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
226 **anydbm** |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
227 This backend is guaranteed to work on any system that Python runs on. It |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
228 will generally choose the best dbm backend that is available on your system |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
229 (from the list dbhash, gdbm, dbm, dumbdbm). It is the least scaleable of all |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
230 backends, but performs well enough for a smallish tracker (a couple of |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
231 thousand issues, under fifty users, ...). |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
232 **bsddb** |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
233 This effectively the same as anydbm, but uses the bsddb backend. This allows |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
234 it to gain some performance and scaling benefits. |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
235 **bsddb3** |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
236 Again, this effectively the same as anydbm, but uses the bsddb3 backend. |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
237 This allows it to gain some performance and scaling benefits. |
|
1240
606522be902a
merged fix from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
238 **sqlite** |
| 1228 | 239 This uses the SQLite_ embedded RDBMS to provide a fast, scaleable backend. |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
240 There are no limitations, and it's much faster and more scaleable than the |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
241 dbm backends. |
|
1507
3481507d6098
Advertising mysql
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1317
diff
changeset
|
242 **mysql** |
|
1595
1ae674595c04
benchmarks says something completely different...
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1590
diff
changeset
|
243 Backend for popular RDBMS MySQL. According to benchmarks, this backend works |
|
1648
496f8f741e26
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1640
diff
changeset
|
244 much faster than any of \*dbm ones, but slightly slower than metakit and |
|
1595
1ae674595c04
benchmarks says something completely different...
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1590
diff
changeset
|
245 sqlite. A good scalability is not a property of this backend for now, |
|
1ae674595c04
benchmarks says something completely different...
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1590
diff
changeset
|
246 though. For more info on backend installation see doc/mysql.txt. |
|
1240
606522be902a
merged fix from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
247 **metakit** |
| 1228 | 248 This backend is implemented over the metakit_ storage system, using Mk4Py as |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
249 the interface. It scales much better than the dbm backends. |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
250 |
|
1629
27768800be5c
pre-release machinations
Richard Jones <richard@users.sourceforge.net>
parents:
1595
diff
changeset
|
251 You should be wary of using all but the mysql backend with high-volume trackers |
|
27768800be5c
pre-release machinations
Richard Jones <richard@users.sourceforge.net>
parents:
1595
diff
changeset
|
252 (requests every second or two) as database locking is done on the whole |
|
27768800be5c
pre-release machinations
Richard Jones <richard@users.sourceforge.net>
parents:
1595
diff
changeset
|
253 database. |
|
27768800be5c
pre-release machinations
Richard Jones <richard@users.sourceforge.net>
parents:
1595
diff
changeset
|
254 |
|
27768800be5c
pre-release machinations
Richard Jones <richard@users.sourceforge.net>
parents:
1595
diff
changeset
|
255 You may set your tracker up with the anydbm backend (which is guaranteed to be |
|
27768800be5c
pre-release machinations
Richard Jones <richard@users.sourceforge.net>
parents:
1595
diff
changeset
|
256 available) and switch to one of the other backends at any time using the |
|
1221
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
257 instructions in the `maintenance documentation`_. |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
258 |
|
778297033003
cleanup of install docco
Richard Jones <richard@users.sourceforge.net>
parents:
1218
diff
changeset
|
259 |
| 1228 | 260 Configure a Web Interface |
| 261 ------------------------- | |
| 262 | |
| 263 There are three web interfaces to choose from: | |
| 264 | |
| 265 1. `web server cgi-bin`_ | |
| 266 2. `stand-alone web server`_ | |
| 267 3. `Zope product - ZRoundup`_ | |
| 268 | |
| 269 You may need to give the web server user permission to access the tracker home | |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
270 - see the `shared environment steps`_ for information. You may also need to |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
271 configure your system in some way - see `platform-specific notes`_. |
| 1228 | 272 |
| 273 | |
| 274 Web Server cgi-bin | |
| 275 ~~~~~~~~~~~~~~~~~~ | |
| 276 | |
| 277 A benefit of using the cgi-bin approach is that it's the easiest way to | |
| 278 restrict access to your tracker to only use HTTPS. Access will be slower | |
| 279 than through the `stand-alone web server`_ though. | |
| 280 | |
|
1750
85cf4268f24c
backport "cgi-bin install note" from HEAD
Richard Jones <richard@users.sourceforge.net>
parents:
1746
diff
changeset
|
281 Note that if your Python isn't install as "python" then you'll need to edit |
|
85cf4268f24c
backport "cgi-bin install note" from HEAD
Richard Jones <richard@users.sourceforge.net>
parents:
1746
diff
changeset
|
282 the ``roundup.cgi`` script to fix the first line. |
|
85cf4268f24c
backport "cgi-bin install note" from HEAD
Richard Jones <richard@users.sourceforge.net>
parents:
1746
diff
changeset
|
283 |
|
1540
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
284 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
|
285 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
|
286 |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
287 adsutil.vbs set w3svc/AllowPathInfoForScriptMappings TRUE |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
288 |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
289 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
|
290 or ``c:\winnt\system32\inetsrv\adminsamples\`` or |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
291 ``c:\winnt\system32\inetsrv\adminscripts\`` depending on your installation. |
|
3e65577ad6d7
minor changes
Richard Jones <richard@users.sourceforge.net>
parents:
1528
diff
changeset
|
292 |
| 1228 | 293 Copy the ``cgi-bin/roundup.cgi`` file to your web server's ``cgi-bin`` |
| 294 directory. You will need to configure it to tell it where your tracker home | |
| 295 is. You can do this either: | |
| 296 | |
| 297 through an environment variable | |
| 298 set the variable TRACKER_HOMES to be a colon (":") separated list of | |
| 299 name=home pairs (if you're using apache, the SetEnv directive can do this) | |
| 300 directly in the ``roundup.cgi`` file itself | |
| 301 add your instance to the TRACKER_HOMES variable as ``'name': 'home'`` | |
| 302 | |
| 303 The "name" part of the configuration will appear in the URL and identifies the | |
| 304 tracker (so you may have more than one tracker per cgi-bin script). Make sure | |
| 305 there are no spaces or other illegal characters in it (to be safe, stick to | |
| 306 letters and numbers). The "name" forms part of the URL that appears in the | |
| 307 tracker config TRACKER_WEB variable, so make sure they match. The "home" | |
| 308 part of the configuration is the tracker home directory. | |
| 309 | |
| 310 Stand-alone Web Server | |
| 311 ~~~~~~~~~~~~~~~~~~~~~~ | |
| 312 | |
| 313 This approach will give you the fastest of the three web interfaces. You may | |
| 314 investigate using ProxyPass or similar configuration in apache to have your | |
| 315 tracker accessed through the same URL as other systems. | |
| 316 | |
| 317 The stand-alone web server is started with the command ``roundup-server``. It | |
| 318 has several options - display them with ``roundup-server -h``. | |
| 319 | |
| 320 The tracker home configuration is similar to the cgi-bin - you may either edit | |
| 321 the script to change the TRACKER_HOMES variable or you may supply the | |
| 322 name=home values on the command-line after all the other options. | |
| 323 | |
| 324 To make the server run in the background, use the "-d" option, specifying the | |
| 325 name of a file to write the server process id (pid) to. | |
| 326 | |
| 327 | |
| 328 Zope Product - ZRoundup | |
| 329 ~~~~~~~~~~~~~~~~~~~~~~~ | |
| 330 | |
| 331 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to | |
| 332 your Products directory either in INSTANCE_HOME/Products or the Zope | |
| 333 code tree lib/python/Products. | |
| 334 | |
| 335 When you next (re)start up Zope, you will be able to add a ZRoundup object | |
| 336 that interfaces to your new tracker. | |
| 337 | |
| 338 | |
| 339 Configure an Email Interface | |
| 340 ---------------------------- | |
| 341 | |
| 342 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
|
343 "``nosyreaction.py``" module from your tracker "``detectors``" directory. |
| 1228 | 344 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
345 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
|
346 |
| 1228 | 347 There are three supported ways to get emailed issues into the |
| 348 Roundup tracker. You should pick ONE of the following, all | |
| 349 of which will continue my example setup from above: | |
| 350 | |
| 351 As a mail alias pipe process | |
| 352 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 353 | |
| 354 Set up a mail alias called "issue_tracker" as (include the quote marks): | |
| 355 "``|/usr/bin/python /usr/local/bin/roundup-mailgw <tracker_home>``" | |
| 356 | |
| 357 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh so | |
| 358 sendmail will accept the pipe command. In that case, symlink | |
| 359 ``/etc/smrsh/roundup-mailgw`` to "``/usr/local/bin/roundup-mailgw``" and change | |
| 360 the command to:: | |
| 361 | |
| 362 |roundup-mailgw /opt/roundup/trackers/support | |
| 363 | |
| 364 To test the mail gateway on unix systems, try:: | |
| 365 | |
| 366 echo test |mail -s '[issue] test' support@YOUR_DOMAIN_HERE | |
| 367 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
368 As a regular job using a mailbox source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
369 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 370 |
| 371 Set ``roundup-mailgw`` up to run every 10 minutes or so. For example:: | |
| 372 | |
|
1879
41c0241ea9c9
fixup cron samples
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
1851
diff
changeset
|
373 0,10,20,30,40,50 * * * * /usr/local/bin/roundup-mailgw /opt/roundup/trackers/support mailbox <mail_spool_file> |
| 1228 | 374 |
| 375 Where the ``mail_spool_file`` argument is the location of the roundup submission | |
| 376 user's mail spool. On most systems, the spool for a user "issue_tracker" | |
| 377 will be "``/var/mail/issue_tracker``". | |
| 378 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
379 As a regular job using a POP source |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
380 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1228 | 381 |
|
1879
41c0241ea9c9
fixup cron samples
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
1851
diff
changeset
|
382 To retrieve from a POP mailbox, use a *cron* entry similar to the mailbox one:: |
| 1228 | 383 |
|
1879
41c0241ea9c9
fixup cron samples
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
1851
diff
changeset
|
384 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
|
385 |
| 1228 | 386 where pop_spec is "``username:password@server``" that specifies the roundup |
| 387 submission user's POP account name, password and server. | |
| 388 | |
|
1317
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
389 On windows, you would set up the command using the windows scheduler. |
|
28ae91aae74f
clarifications
Richard Jones <richard@users.sourceforge.net>
parents:
1316
diff
changeset
|
390 |
| 1228 | 391 |
| 1049 | 392 Shared Environment Steps |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
393 ------------------------ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
394 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
395 Each tracker ideally should have its own UNIX group, so create |
| 1049 | 396 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if |
| 397 you're using NIS). To continue with my examples so far, I would | |
| 398 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
|
399 group does not have to be the same as the tracker name. To this |
| 1049 | 400 '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
|
401 working with this Roundup tracker. In addition to 'real' users, |
| 1049 | 402 the Roundup email gateway will need to have permissions to this |
| 403 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
|
404 group (typically "mail" or "daemon"). The UNIX group might then |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
405 look like:: |
| 1049 | 406 |
| 407 support:*:1002:jblaine,samh,geezer,mail | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
408 |
| 1049 | 409 If you intend to use the web interface (as most people do), you |
| 410 should also add the username your web server runs as to the group. | |
| 411 My group now looks like this:: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
412 |
| 1049 | 413 support:*:1002:jblaine,samh,geezer,mail,apache |
| 414 | |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
415 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
|
416 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
|
417 by the group. |
|
344bad728d10
more tweakage of help display and style issues
Richard Jones <richard@users.sourceforge.net>
parents:
1049
diff
changeset
|
418 |
| 1049 | 419 An alternative to the above is to create a new user who has the sole |
| 420 responsibility of running roundup. This user: | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
421 |
| 1049 | 422 1. runs the CGI interface daemon |
| 423 2. runs regular polls for email | |
| 424 3. runs regular checks (using cron) to ensure the daemon is up | |
| 425 4. optionally has no login password so that nobody but the "root" user | |
| 426 may actually login and play with the roundup setup. | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
427 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
428 |
| 1228 | 429 Maintenance |
| 430 =========== | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
431 |
| 1228 | 432 Read the separate `maintenance documentation`_ for information about how to |
| 433 perform common maintenance tasks with Roundup. | |
| 1049 | 434 |
|
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
|
435 |
|
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
|
436 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
|
437 ========= |
|
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
|
438 |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
439 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
|
440 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
|
441 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
|
442 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
443 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
444 Further Reading |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
445 =============== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
446 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
447 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
|
448 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
|
449 like implementation details, you should read `Customising Roundup`_. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
450 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
451 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
452 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
|
453 ========================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
454 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
455 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
|
456 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
|
457 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
|
458 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
459 1. Do you want a tracker per product you sell/support? You can just add |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
460 a new property to your issues called Product, and filter by that. |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
461 2. Do you want to track internal software development issues and customer |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
462 support issues separately? You can just set up an additiona "issue" |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
463 class called "cust_issues" in the same tracker, mimicing the normal |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
464 "issue" class, but with different properties. |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
465 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
466 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
467 Platform-Specific Notes |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
468 ======================= |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
469 |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
470 Windows command-line tools |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
471 -------------------------- |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
472 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
473 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
|
474 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
|
475 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
476 On Windows 2000 and later: |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
477 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
478 1) Press the "Start" button. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
479 2) Choose "Settings" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
480 3) Choose "Control Panel" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
481 4) Choose "System" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
482 5) Choose "Advanced" |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
483 6) Choose "Environmental Variables" |
|
1746
9c1da921cd35
minor rest tweak
Richard Jones <richard@users.sourceforge.net>
parents:
1688
diff
changeset
|
484 7) Add: "<dir>\Scripts" to the "Path" environmental variable. |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
485 |
|
1750
85cf4268f24c
backport "cgi-bin install note" from HEAD
Richard Jones <richard@users.sourceforge.net>
parents:
1746
diff
changeset
|
486 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
|
487 of your Python installation. |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
488 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
489 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
|
490 Panel" is directly accessible from "Start". |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
491 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
492 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
|
493 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
494 |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
495 Windows Server |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1648
diff
changeset
|
496 -------------- |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
497 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
498 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
|
499 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
|
500 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
501 Run |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
502 ``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
|
503 Start In |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
504 ``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
|
505 Schedule |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
506 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
|
507 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
508 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
|
509 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
|
510 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
511 Run |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
512 ``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
|
513 Start In |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
514 ``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
|
515 Schedule |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
516 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
|
517 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
|
518 |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1574
diff
changeset
|
519 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
520 Sendmail smrsh |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
521 -------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
522 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
523 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
|
524 smrsh that roundup-mailgw is a valid/trusted mail handler |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
525 before it will work. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
526 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
527 This is usually done via the following 2 steps: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
528 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
529 1. make a symlink in ``/etc/smrsh`` called ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
530 which points to the full path of your actual ``roundup-mailgw`` |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
531 script. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
532 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1078
diff
changeset
|
533 2. change your alias to ``"|roundup-mailgw <tracker_home>"`` |
|
659
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 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
536 Linux |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
537 ----- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
538 |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1576
diff
changeset
|
539 Make sure you read the instructions under `shared environment steps`_. |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
540 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
541 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
|
542 ``_weakref``. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
543 |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
544 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
545 Solaris |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
546 ------- |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
547 |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
548 You'll need to build Python. |
|
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
549 |
|
1588
1ac46e7e4150
more doc work - new improved overview doc
Richard Jones <richard@users.sourceforge.net>
parents:
1576
diff
changeset
|
550 Make sure you read the instructions under `shared environment steps`_. |
|
1574
67af854f4c33
more installation hintage
Richard Jones <richard@users.sourceforge.net>
parents:
1571
diff
changeset
|
551 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
552 ------------------------------------------------------------------------------- |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
553 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
554 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
|
555 |
|
1287
5402a6f2a754
Added quotes around python interpreter in windows bat [SF#623963]
Richard Jones <richard@users.sourceforge.net>
parents:
1282
diff
changeset
|
556 Next: `User Guide`_ |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
557 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
558 .. _`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
|
559 .. _`user guide`: user_guide.html |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
560 .. _`roundup specification`: spec.html |
|
1245
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
561 .. _`tracker configuration`: customizing.html#tracker-configuration |
|
d8c98af869ff
merge from maint-0-5
Richard Jones <richard@users.sourceforge.net>
parents:
1244
diff
changeset
|
562 .. _`customisation documentation`: customizing.html |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
563 .. _`customising roundup`: customizing.html |
|
882
b99948d32a2d
clearing up ambiguous ref name
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
564 .. _`upgrading document`: upgrading.html |
|
1218
4c9882cb16a3
more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
1170
diff
changeset
|
565 .. _`maintenance documentation`: maintenance.html |
| 1228 | 566 .. _sqlite: http://www.hwaci.com/sw/sqlite/ |
| 567 .. _metakit: http://www.equi4.com/metakit/ | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
568 |