File: README.Debian

package info (click to toggle)
request-tracker3.6 3.6.1-4+etch1
  • links: PTS
  • area: main
  • in suites: etch
  • size: 9,028 kB
  • ctags: 1,371
  • sloc: perl: 27,270; sh: 671; makefile: 327
file content (198 lines) | stat: -rw-r--r-- 7,877 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
request-tracker3.6 for Debian
---------------------------

Installation
------------
Read NOTES.Debian for installation and configuration notes.

I mean this.

Yes, you. You've installed the package, right? You need to configure
it before using it. NOTES.Debian is bursting with config-goodness.

Seriously. You can't install a complex package like this and expect it
to just work.

standalone_httpd
----------------

RT3.6 comes with a script to allow it to be run in a standalone mode
that does not require apache to be installed. In the upstream package
this is called standalone_httpd, we have changed the name to
rt-standalone_httpd to avoid any conflicts with other
packages. Currently I believe this standalone mode is still considered
beta-quality only so you still want to install a separate
webserver. We do not expect to be dropping our dependencies on apache
or apache2 any time soon.

Note: This script has been moved to the examples directory for now as
it depends on a new package which is not in Debian at the moment. 
You will need to install the libhttp-server-simple-perl (>= 0.07)
package and also grab HTTP::Server::Simple::Mason (>= 0.09) from CPAN.

Upgrading from request-tracker3.4 to request-tracker3.6
-------------------------------------------------------

The MOST IMPORTANT thing to note is that if you have more than one of
the request-tracker3, request-tracker3.2, request-tracker3.4 and
request-tracker3.6 packages installed at the same time then you will 
have to be careful to use the correct version of commands such as 
rt-setup-database, rt-mailgate and rt-crontool, etc.. If in any doubt, 
add on the -3.0, -3.2, -3.4 or -3.6 extension to the name of the command. 
The commands are all managed via the update-alternatives script.

If you are considering upgrading your system and want to keep your
current data we strongly recommend doing a dump of your current
database and then restoring into a new separate database, for use by
rt3.6. This will allow you to attempt the upgrade and changes required
without destroying your existing data. It will also allow you to run
rt 3.0, rt 3.2, rt 3.4 and rt 3.6 side-by-side without any chance of 
conflicts.

Currently rt3.6 makes only small changes to the database schema, these
are the addition of the Attributes table and associated indexes and a
sequence. You will also need to update/add some data to a few existing
tables. All these changes can be done via this (bash) command:

# for x in /etc/request-tracker3.6/upgrade/*; do \
     for y in schema acl insert; do \
        /usr/sbin/rt-setup-database-3.6 --action $y --datadir $x \
          --dba rtuser --dba-password wibble; \
     done;\
  done;

You will need to specify the correct rt username and password for your
installation. If you are using PostgreSQL, as with the original
install, you will probably need to allow access to the database
template1 for your rtuser, see NOTES.Debian for details.

Upgrading the request-tracker3.6 package
--------------------------------------
There are often notes in NEWS.Debian that describe schema changes you
should make to your database, often for performance reasons.


Config changes
--------------

If you change /etc/request-tracker3.6/RT_SiteConfig.pm and use
Apache's modperl, you have to re-start Apache: '/etc/init.d/apache
restart'. Don't use the 'apachectl graceful' or 'apachectl restart';
they're not quite enough.

Please remember, NEVER EDIT RT_Config.pm EVEN IF YOU THINK IT IS A GOOD IDEA!


Upgrading from RT2
------------------

The tools to do this are available at:

http://www.fsck.com/pub/rt/devel/rt2-to-rt3.tar.gz

This really is not the easiest thing in the world but is achievable
with a bit of thought and careful planning. The way to go about it is
to dump the RT2 database using the tool provided (rt-2.0-to-dumpfile)
whilst you still have RT2 installed. Once that is done, and it might
take sometime - we are talking days here for a big database - install
the RT3 Debian package. Go through all the notes in the NOTES.Debian
file then load the old data with the tool provided
(dumpfile-to-rt-3.0) into your nice shiny, newly prepared, RT3
database - again this can take days for a big database.

If you are reading this then you have probably already removed your
RT2 Debian package and installed RT3 instead, your best plan is to
download a tarball of RT2. Unpack it somewhere like
/usr/local/share/rt2/ and then edit the rt2-to-rt3 dump script to
point to the correct place. The lines to change are something like:

use lib "/opt/rt-bps/lib";
use lib "/opt/rt-bps/etc";

replacing the /opt/rt-bps/lib with the path to your RT2 libraries and
/opt/rt-bps/etc with the path to your RT2 configuration files.

Any problems/questions about upgrading from RT2 to RT3 should be sent
to the rt-users mailing list at rt-users@lists.fsck.com


Local changes to RT html or library source
------------------------------------------

If you want to make local changes to the RT web interface, you should
copy the relevant mason or html files into the
/usr/local/share/request-tracker3.6/html hierarchy, preserving the
directory structure. Any changes you make will immediately have an
effect on the web interface, you do not need to restart the web
server. You should ensure that the correct permissions are set on the
files so that the webserver can access them.

If you want to make local changes to the RT library code, you can copy
the relevant Perl libraries into the
/usr/local/share/request-tracker3.6/lib hierarchy, preserving the
directory structure.

A better method is to use RT's Overlay system which allows the
creation and use of Perl modules which just contain the modified, or
new, subroutines. If, for instance, you wanted to alter the Perl
module RT::Templates, you can place the changed subroutines into
RT::Templates_Local (the file name would be
/usr/local/share/request-tracker3.6/lib/RT/Templates_Local.pm).

You will probably need to reload or restart the web server for Perl
library changes to have effect.

There are also overlay files which use the words _Vendor and _Overlay.
_Overlay is for a system overlay by the original author, _Vendor is
for 3rd-party vendor add-ons, while _Local is for site-local
customizations.

These overlay files can contain new subs or subs to replace existing
subs in this module.

If you will be working with perl 5.6.0 or greater, each of these files
should begin with the line

   no warnings qw(redefine);

so that perl does not kick and scream when you redefine a subroutine
or variable in your overlay.

Note that local additions and changes should ALWAYS be put into the
/usr/local directories. Any changes to files that are shipped with
request-tracker3.6 will be lost at the next update unless they are
conffiles (i.e. in /etc/request-tracker3.6). Any files you add into the
/usr/local/share/request-tracker3.6 hierarchy will be preserved if you
decide to remove or purge the package.


/usr/local is read-only
-----------------------

Sometimes systems have a /usr/local/ that is mounted read-only so you
cannot make use of the custom hierarchy of request-tracker3.6 that would
otherwise be there. In this case you can alter the place where the
custom hierarchy is found by overlaying the RT.pm with an RT_Local.pm in
/usr/share/perl5/ which would look something like this:

##########
$LocalPath = '/path/to/somewhere/else/request-tracker3.6';
$LocalEtcPath = $LocalPath . '/etc';
$LocalLexiconPath = $LocalPath . '/po';

$MasonLocalComponentRoot = $LocalPath . '/html';

unshift @INC, ($LocalPath . '/lib') ;

1;
##########

Remember to restart the webserver after creating the overlay file if
you are using mod_perl version 1 or 2.
 

This text was originally written by 
Stephen Quinney <sjq@debian.org>, Thu Sep 15 14:57:05 2005

 -- Niko Tyni <ntyni@iki.fi> Mon, 21 Aug 2006 00:05:45 +0300