1 RT is an enterprise-grade issue tracking system. It allows organizations
2 to keep track of what needs to get done, who is working on which tasks,
3 what's already been done, and when tasks were (or weren't) completed.
5 RT doesn't cost anything to use, no matter how much you use it; it
6 is freely available under the terms of Version 2 of the GNU General
9 RT is commercially-supported software. To purchase support, training,
10 custom development, or professional services, please get in touch with
11 us at sales@bestpractical.com.
14 Best Practical Solutions, LLC
21 o Perl 5.8.3 or later (http://www.perl.org).
23 Perl versions prior to 5.8.3 contain bugs that could result
24 in data corruption. RT won't start on older versions.
26 o A supported SQL database
28 Currently supported: Mysql 4.0.13 or later with InnoDB support.
29 Postgres 7.2 or later.
31 SQLite 3.0. (Not recommended for production)
33 o Apache version 1.3.x or 2.x (http://httpd.apache.org)
34 with mod_perl -- (http://perl.apache.org )
35 or with FastCGI -- (www.fastcgi.com)
36 or other webserver with FastCGI support
38 RT's FastCGI handler needs to access RT's configuration file.
40 o Various and sundry perl modules
41 A tool included with RT takes care of the installation of
42 most of these automatically during the install process.
44 The tool supplied with RT uses Perl's CPAN system
45 (http://www.cpan.org) to install modules. Some operating
46 systems package all or some of the modules required, and
47 you may be better off installing the modules that way.
53 1 Unpack this distribution other than where you want to install RT
55 To do this cleanly, run the following command:
57 tar xzvf rt.tar.gz -C /tmp
59 2 Run the "configure" script.
61 ./configure --help to see the list of options
62 ./configure (with the flags you want)
64 RT defaults to installing in /opt/rt3 with MySQL as its database. It
65 tries to guess which of www-data, www, apache or nobody your webserver
66 will run as, but you can override that behavior. Note that the
67 default install directory in /opt/rt3 does not work under SELinux's
68 default configuration.
70 If you're upgrading RT stop and review the UPGRADING document.
71 Some extensions you're using may have been integrated into
72 core, or there may be other extra steps to follow. It's recommended
73 that you use a new clean directory when you're upgrading to
74 new major release (for example from 3.6.x to 3.8.x).
76 3 Make sure that RT has everything it needs to run.
78 Check for missing dependencies by running:
82 4 If the script reports any missing dependencies, install them by hand
83 or run the following command as a user who has permission to install perl
84 modules on your system:
88 Some modules require user input or environment variables to install correctly,
89 so it may be necessary to install them manually.
91 5 Check to make sure everything was installed properly.
95 It might sometimes be necessary to run "make fixdeps" several times
96 to install all necessary perl modules.
98 6 If this is a new installation:
100 As a user with permission to install RT in your chosen directory, type:
104 Set up etc/RT_SiteConfig.pm in your RT installation directory.
105 You'll need to add any values you need to change from the defaults
108 As a user with permission to read RT's configuration file, type:
110 make initialize-database
112 If the make fails, type:
116 and start over from step 6
118 7 If you're upgrading from RT 3.0 or newer:
120 Read through the UPGRADING document included in this distribution. If
121 you're using MySQL, read through UPGRADING.mysql as well.
123 It includes special upgrade instructions that will help you get this
124 new version of RT up and running smoothly.
126 As a user with permission to install RT in your chosen installation
131 This will install new binaries, config files and libraries without
132 overwriting your RT database.
134 Update etc/RT_SiteConfig.pm in your RT installation directory.
135 You'll need to add any new values you need to change from the defaults
138 You may also need to update RT's database. You can do this with
139 the rt-setup-database tool. Replace root with the name of the dba
140 user on your database (root is the default for MySQL).
142 You will be prompted for your previous version of RT (such as 3.6.4)
143 so that we can calculate which database updates to apply
145 You should back up your database before running this command.
147 /opt/rt3/sbin/rt-setup-database --dba root --prompt-for-dba-password --action upgrade
149 Clear mason cache dir:
151 rm -fr /opt/rt3/var/mason_data/obj
153 Stop and start web-server.
156 8 If you're upgrading from RT 2.0:
158 Read more in UPGRADING
160 9 Configure the email and web gateways, as described below.
162 NOTE: root's password for the web interface is "password"
163 (without the quotes). Not changing this is a SECURITY risk!
165 10 Set up automated recurring tasks (cronjobs):
167 To generate email digest messages, you must arrange for the provided
168 utility to be run once daily, and once weekly. You may also want to
169 arrange for the rt-email-dashboards utility to be run hourly.
170 For example, if your task scheduler is cron, you can configure it as
173 crontab -e # as the RT administrator (probably root)
174 # insert the following lines:
175 0 0 * * * /opt/rt3/sbin/rt-email-digest -m daily
176 0 0 * * 0 /opt/rt3/sbin/rt-email-digest -m weekly
177 0 * * * * /opt/rt3/sbin/rt-email-dashboards
180 11 Set up users, groups, queues, scrips and access control.
182 Until you do this, RT will not be able to send or receive email,
183 nor will it be more than marginally functional. This is not an
187 SETTING UP THE WEB INTERFACE
188 ----------------------------
190 RT's web interface is based around HTML::Mason, which works well with
191 the mod_perl perl interpreter within Apache httpd and FastCGI.
193 Once you've set up the web interface, consider setting up automatic
194 logout for inactive sessions. For more information about how to do that,
196 perldoc /path/to/rt/sbin/rt-clean-sessions
202 WARNING: mod_perl 1.99_xx is not supported.
204 See below configuration instructions for mod_perl 2.x
206 To install RT with mod_perl 1.x, you'll need to install the
207 apache database connection cache. To make sure it's installed, run
208 the following command:
210 perl -MCPAN -e'install "Apache::DBI"'
212 Next, add a few lines to your Apache 1.3.xx configuration file, so that
213 it knows where to find RT:
215 <VirtualHost your.ip.address>
216 ServerName your.rt.server.hostname
218 DocumentRoot /opt/rt3/share/html
219 AddDefaultCharset UTF-8
221 # optional apache logs for RT
222 # ErrorLog /opt/rt3/var/log/apache.error
223 # TransferLog /opt/rt3/var/log/apache.access
225 PerlModule Apache::DBI
226 PerlRequire /opt/rt3/bin/webmux.pl
228 <Location /NoAuth/images>
232 SetHandler perl-script
233 PerlHandler RT::Mason
240 WARNING: mod_perl 1.99_xx is not supported.
242 Add a few lines to your Apache 2.xx configuration file, so that
243 it knows where to find RT:
245 <VirtualHost your.ip.address>
246 ServerName your.rt.server.hostname
248 DocumentRoot /opt/rt3/share/html
249 AddDefaultCharset UTF-8
251 # optional apache logs for RT
252 # ErrorLog /opt/rt3/var/log/apache2.error
253 # TransferLog /opt/rt3/var/log/apache2.access
255 PerlRequire "/opt/rt3/bin/webmux.pl"
257 <Location /NoAuth/images>
261 SetHandler perl-script
262 PerlResponseHandler RT::Mason
269 Installation with FastCGI is a little bit more complex and is documented
270 in detail at http://wiki.bestpractical.com/index.cgi?FastCGIConfiguration
272 In the most basic configuration, you can set up your webserver to run
273 as a user who is a member of the "rt" unix group so that the FastCGI script
274 can read RT's configuration file. It's important to understand the security
275 implications of this configuration, which are discussed in the document
278 To install RT with FastCGI, you'll need to add a few lines to your
279 Apache configuration file telling it about RT:
282 # Tell FastCGI to put its temporary files somewhere sane.
285 FastCgiServer /opt/rt3/bin/mason_handler.fcgi -idle-timeout 120
287 <VirtualHost rt.example.com>
288 ServerName your.rt.server.hostname
290 # Pass through requests to display images
291 Alias /NoAuth/images/ /opt/rt3/share/html/NoAuth/images/
293 AddHandler fastcgi-script fcgi
294 ScriptAlias / /opt/rt3/bin/mason_handler.fcgi/
299 SETTING UP THE MAIL GATEWAY
300 ---------------------------
302 To let email flow to your RT server, you need to add a few lines of
303 configuration to your mail server's "aliases" file. These lines "pipe"
304 incoming email messages from your mail server to RT.
306 Add the following lines to /etc/aliases (or your local equivalent) on your mail server:
308 rt: "|/opt/rt3/bin/rt-mailgate --queue general --action correspond --url http://rt.example.com/"
309 rt-comment: "|/opt/rt3/bin/rt-mailgate --queue general --action comment --url http://rt.example.com/"
311 You'll need to add similar lines for each queue you want to be able
312 to send email to. To find out more about how to configure RT's email
315 perldoc /opt/rt3/bin/rt-mailgate
322 If RT is mission-critical for you or if you use it heavily, we recommend that
323 you purchase a commercial support contract. Details on support contracts
324 are available at http://www.bestpractical.com or by writing to
325 <sales@bestpractical.com>.
327 If you're interested in having RT extended or customized or would like more
328 information about commercial support options, please send email to
329 <sales@bestpractical.com> to discuss rates and availability.
336 For current information about RT, check out the RT website at
337 http://www.bestpractical.com/
339 You'll find screenshots, a pointer to the current version of RT, contributed
340 patches, and lots of other great stuff.
344 RT-USERS MAILING LIST
345 ---------------------
347 To keep up to date on the latest RT tips, techniques and extensions,
348 you probably want to join the rt-users mailing list. Send a message to:
350 rt-users-request@lists.bestpractical.com
352 with the body of the message consisting of only the word:
356 If you're interested in hacking on RT, you'll want to subscribe to
357 <rt-devel@lists.bestpractical.com>. Subscribe to it with instructions
358 similar to those above.
360 Address questions about the stable release to the rt-users list, and
361 questions about the development version to the rt-devel list. If you feel
362 your questions are best not asked publicly, send them personally to
363 <jesse@bestpractical.com>.
370 RT's a pretty complex application, and as you get up to speed, you might
371 run into some trouble. Generally, it's best to ask about things you
372 run into on the rt-users mailinglist (or pick up a commercial support
373 contract from Best Practical). But, sometimes people do run into bugs. In
374 the exceedingly unlikely event that you hit a bug in RT, please report
375 it! We'd love to hear about problems you have with RT, so we can fix them.
376 To report a bug, send email to rt-bugs@fsck.com.
379 # BEGIN BPS TAGGED BLOCK {{{
383 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
384 # <sales@bestpractical.com>
386 # (Except where explicitly superseded by other copyright notices)
391 # This work is made available to you under the terms of Version 2 of
392 # the GNU General Public License. A copy of that license should have
393 # been provided with this software, but in any event can be snarfed
396 # This work is distributed in the hope that it will be useful, but
397 # WITHOUT ANY WARRANTY; without even the implied warranty of
398 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
399 # General Public License for more details.
401 # You should have received a copy of the GNU General Public License
402 # along with this program; if not, write to the Free Software
403 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
404 # 02110-1301 or visit their web page on the internet at
405 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
408 # CONTRIBUTION SUBMISSION POLICY:
410 # (The following paragraph is not intended to limit the rights granted
411 # to you to modify and distribute this software under the terms of
412 # the GNU General Public License and is only of importance to you if
413 # you choose to contribute your changes and enhancements to the
414 # community by submitting them to Best Practical Solutions, LLC.)
416 # By intentionally submitting any modifications, corrections or
417 # derivatives to this work, or any other work intended for use with
418 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
419 # you are the copyright holder for those contributions and you grant
420 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
421 # royalty-free, perpetual, license to use, copy, create derivative
422 # works based on those contributions, and sublicense and distribute
423 # those contributions and any derivatives thereof.
425 # END BPS TAGGED BLOCK }}}