rt/README

   1 $Header: /home/cvs/cvsroot/freeside/rt/README,v 1.1 2002-08-12 06:17:06 ivan Exp $
   2 RT is (c) 1996-2002 by Jesse Vincent <jesse@bestpractical.com>
   3
   4 RT is licensed to you under the terms of version 2 of the GNU General
   5 Public License.
   6
   7 If you don't have a copy of the GPL, you've been living in a cave,
   8 but one should be included in this distribution.
   9
  10
  11 INSTALLATION INSTRUCTIONS
  12 -------------------------
  13
  14 These instructions are a summary of those at http://www.fsck.com/rtfm/
  15 The docs on the web at www.fsck.com/rtfm/ are likely to be more up to
  16 date and complete than this document. You should consult them before
  17 proceeding.
  18
  19 REQUIRED PACKAGES:
  20 ------------------
  21
  22 o   Perl5.005_03 or later with support for setgid perl scripts
  23         RT's command line and mail gateway tools run setgid to the 'rt' group
  24         to protect RT's database password.  You may need to install a special
  25         "suidperl" package or reconfigure your perl setup to support
  26          "setuid scripts".
  27
  28 o   A DB backend; MySQL is recommended ( http://www.mysql.com )
  29         Currently supported:    Mysql 3.23.38 or newer.
  30                                  (Some older releases had crippling SQL bugs)
  31                                 Postgres 7.1 or newer.
  32
  33 o   Apache + mod_perl -- ( http://perl.apache.org)
  34     or A webserver with FastCGI support (www.fastcgi.com)
  35
  36         If you compile mod_perl as a DSO, you're on your own. It's known
  37         to have massive stability problems.
  38         mod_perl must be build with EVERYTHING=1
  39
  40 o    Various and sundry perl modules
  41         RT takes care of the installation of most of these automatically
  42         during the "make testdeps" and "make fixdeps" stages below
  43
  44
  45 GENERAL INSTALLATION
  46 --------------------
  47
  48 1   Unpack this distribution SOMWHERE OTHER THAN where you want to install RT
  49
  50         Granted, you've already got it open. To do this cleanly:
  51
  52                 tar xzvf rt.tar.gz -C /tmp
  53
  54 2   Check over /tmp/rt/Makefile
  55
  56         There are many variables you NEED to customize for your site.
  57         Even if you are just upgrading, you must set ALL variables.
  58
  59 3   Satisfy RT's myriad dependencies.  There's a perl script in rt/tools
  60     called testdeps that uses CPAN to automate all of this.
  61
  62 3.1   Check for compliance:
  63         make testdeps
  64
  65 3.2   If there are unsatisfied dependencies, install them by hand or run
  66         make fixdeps
  67
  68        (You may need to install Apache::Session and Apache::DBI by hand.
  69
  70         You might need to install Msql-Mysql-Modules by hand.
  71         perl -MCPAN -e'install DBD::mysql::Install' should do it for you.
  72        )
  73
  74 3.3   Check to make sure everything was installed properly:
  75         make testdeps
  76
  77 4   Create a group called 'rt'
  78
  79 5a  FOR A NEW INSTALLATION:
  80
  81         As root, type:
  82                  make install   (replace "make" with the local name for
  83                                  Make, if you need to)
  84
  85         If the make fails, type:
  86                 make dropdb
  87         and start over from step 5a
  88
  89 5b  FOR UPGRADING: (Within the RT 2.0.x series)
  90
  91         Make a backup of /path/to/rt/etc/config.pm
  92
  93         As root, type:
  94                 make upgrade     (replace "make" with the local name for
  95                                   Make, if you need to)
  96
  97         This will build new binaries, config files and libraries without
  98         overwriting your RT database.
  99
 100         WARNING: This WILL clobber your existing configuration file!
 101
 102         The install process will then instruct you to update your RT system
 103         database objects by running rt/etc/insertdata <version> where
 104         <version> is the version of RT you're upgrading from.
 105
 106
 107
 108 5c  FOR UPGRADING (From 1.0.x):
 109
 110         Follow the instructions for installing RT 2.0.
 111
 112         Once you have installed RT 2.0, download import-1.0-to-2.0
 113         from http://www.fsck.com/pub/rt/contrib/2.0/rt-addons
 114
 115         Edit the configuration defaults in import-1.0-to-2.0
 116
 117         If you don't set $DEFAULTQUEUE to the name of one of your
 118         RT 1.0 queues, THE IMPORT WILL FAIL.
 119
 120         perl ./import-1.0-to-2.0
 121
 122         The import tool will do its thing. If you're using postgres, you'll
 123         need to execute the following SQL statement within your RT2 database:
 124
 125         select setval('tickets_id_seq', (select max(id) from tickets));
 126
 127         It imports:
 128                 Queues, Areas, Users, Acls, Mailing Rules, Queue Members,
 129                 Tickets and Transactions.
 130
 131         It DOES NOT IMPORT:
 132                 Attachments removed by stripmime or Templates.
 133
 134 6   Edit etc/config.pm in your RT installation directory.  In many
 135     cases sensible defaults have been included. In others, you MUST
 136     supply a value.
 137
 138 7   Configure the email and web gateways, as described below.
 139
 140 8   Stop and start your webserver, so it picks up your configuration changes.
 141
 142     NOTE: root's password for the web interface is "password"
 143     (without the quotes.)  Not changing this is a SECURITY risk
 144
 145 9   Configure RT per the instructions at http://www.fsck.com/rtfm/
 146
 147     Until you do this, RT will not be able to send or recieve email,
 148     nor will it be more than marginally functional.  This is not an
 149     optional step.
 150
 151
 152 SETTING UP THE MAIL GATEWAY
 153 ---------------------------
 154
 155 An alias for the initial queue will need to be made in either your
 156 global mail aliases file (if you are using NIS) or locally on your
 157 machine.
 158
 159 Add the following lines to /etc/aliases (or your local equivalent) :
 160
 161 rt:         "|/path/to/rt2/bin/rt-mailgate --queue general --action correspond"
 162 rt-comment: "|/path/to/rt2/bin/rt-mailgate --queue general --action comment"
 163                                                    |                |
 164                                    <queue-name>----/                |
 165                                                                     |
 166                       <correspond or comment depending on whether   |
 167                       the mail should be resent to the requestor>---/
 168
 169
 170
 171 THE WEB UI
 172 ----------
 173
 174 RT's web ui is based around HTML::Mason, which works well with the mod_perl
 175 perl interpreter within Apache httpd as well as with a webserver which
 176 supports FastCGI. (Instructions for configuring RT for use with FastCGI
 177 are available at http://www.fsck.com/rtfm/ )
 178
 179 Apache
 180         RT Uses HTML::Mason.  You'll need to add a few lines to your
 181         httpd.conf telling it to use rt's web ui.  If you have mod-perl
 182         (you should, the perl scripts will go quite a bit faster around with
 183         it), you can do something like this:
 184
 185
 186 <VirtualHost your.ip.address>
 187 DocumentRoot /path/to/rt2/WebRT/html
 188 ServerName your.rt.server.hostname
 189 PerlModule Apache::DBI
 190 PerlFreshRestart On
 191 PerlRequire /path/to/rt2/bin/webmux.pl
 192 <Location />
 193  SetHandler perl-script
 194  PerlHandler RT::Mason
 195 </Location>
 196 </VirtualHost>
 197
 198 Additionally, you should set up a cron job to remove stale session data.
 199
 200 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 201  WARNING: Don't install this cron job or run this find command if your
 202  MASON_SESSION_PATH (known in config.pm as $MasonSessionDir)
 203  points to a directory that could  EVER contain any file that's not
 204  a Apache::Session datafile.
 205 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 206
 207 # Every hour, nuke session files and lockfiles that haven't been
 208 # touched in 10 hours
 209
 210 0 * * * * find /path/to/rt2/WebRT/sessiondata -type f -amin +600 -exec rm {} \;
 211
 212
 213 THE CLI
 214 -------
 215         Binaries for the CLI are located in rt/bin
 216         You've got:
 217
 218                 "rt" (manipulate or display requests)
 219                 "rtadmin" (modify queues, users and acls)
 220
 221         Both of these programs take --help as an option.
 222
 223
 224 BUGS
 225 ----
 226
 227 Known issues with releases of RT2 are listed at
 228 <URL:http://fsck.com/rt2/NoAuth/Errata.html>.  This includes every bug known
 229 to exist in each release of RT.  (When prompted, login as guest/guest)
 230
 231 To find out more about currently open bugs, check out the live
 232 Buglist at  <URL:http://fsck.com/rt2/NoAuth/Buglist.html>.
 233 (When prompted, login as guest/guest)
 234
 235 To report a bug, send an email to rt-2.0-bugs@fsck.com.
 236
 237 GETTING HELP
 238 ------------
 239
 240 If RT is mission-critical for you or if you use it heavily, we recommend that
 241 you purchase a commercial support contract.  Details on support contracts
 242 are available at http://www.bestpractical.com.
 243
 244 If you're interested in having RT extended or customized or would like more
 245 information about commercial support options, please send email to
 246 <sales@bestpractical.com> to discuss rates and availability.
 247
 248
 249 RT-USERS MAILINGLIST
 250 --------------------
 251
 252 To keep up to date on the latest RT tips, techniques and extections,
 253 you probably want to join the rt-users mailinglist.  Send a message to:
 254
 255          rt-users-request@lists.fsck.com
 256
 257 With the body of the message consisting of only the word:
 258
 259         subscribe
 260
 261 If you're interested in hacking on rt, you'll want to subscribe to
 262 rt-devel@lists.fsck.com.  Subscribe to it with instructions similar to
 263 those above.
 264
 265 Address questions about the stable release to the rt-users list, and
 266 questions about the development version to the rt-devel list.  If you feel
 267 your questions are best not asked publically, send them personally to
 268 <jesse@bestpractical.com>.
 269
 270 If you want to be informed of every commit to the CVS repository,
 271 subscribe to rt-commit@fsck.com using similar instructions to those above.
 272
 273
 274 RT WEBSITE
 275 ----------
 276
 277 For current information about RT, check out the RT website at
 278 http://www.bestpractical.com/rt  You'll find screenshots, a pointer
 279 to the current version of rt, contributed patches and lots of other great
 280 stuff.
 281
 282
 283 TROUBLESHOOTING
 284 ---------------
 285
 286 All errors will be appended to a logfile, which lives in /tmp/rt.log.* unless
 287 you've reconfigured it.  Check etc/config.pm for details.
 288
 289 If the solution to the problem you're running into isn't obvious and you've
 290 checked the FAQ, feel free to send mail to rt-users@fsck.com (for release
 291 versions of RT) or rt-devel@fsck.com (for development versions).
 292
 293 GIVING SOMETHING BACK
 294 ---------------------
 295
 296 RT is free software. You are not obligated to pay for it.  You should be
 297 aware, however, that bestpractical.com's sole source of revenue is commercial
 298 work related to RT. If you are able, either a contract to extend RT in some
 299 way that would be useful to your organization, a financial contribution, or
 300 even something off the author's amazon wishlist
 301         ( http://www.amazon.com/exec/obidos/wishlist/2GMHUDAFBT2XR/ )
 302 would be much appreciated.
 303
 304 Thanks!
 305
 306
 307 CREDITS
 308 -------
 309
 310 A lot of people are responsible for making RT a better program.  Many
 311 thanks to Lauren Burka, who originally tasked me with writing this beast.
 312 She forced me to use a database backend.  I've thanked her for it every
 313 day since.  Rich West rewrote this readme and did some UI hacking.  Adam
 314 Hirsch, Kit Kraysha, Robin Garner, Jens Glaser, John Adams, Trey Belew,
 315 Sean Dague, Nathan Mehl, Kee Hinckley, Rich West, Dale Bewley, Serge Zhuk,
 316 John Lengeling, Elmar Knipp, Gerald Abshez, Dave Hull, Dave Schenet,
 317 Dave Walton, Jan Okrouhly, Tobias Brox, Lamont Lucas, Charlie Brady,
 318 Robin Shostack, Eric Mumpower, Jerrod Wiesman, Adam Hammer, Ivan Kohler, Alex
 319 Pilosov, Mary Alderdice, Deborah Kaplan, Jens von Bülow, Tristan Horn,
 320 Lee Ann Goldstein, Karel P Kerezman, Feargal Reilly, Christian Steger,
 321 Christian Kurz, JD Falk, Arthur de Jong, Ben Carter, Mark Vevers
 322 and many others
 323 have all contributed bug reports, code or ideas that have helped RT along.
 324
 325 Arepa, Inc, Utopia Inc, Wesleyan University and The Leftbank Operation
 326 have paid me to maintain RT and release it to the public.  Without their
 327 support RT would not exist.
 328
 329 If I've left you out, please drop me a line ....it wasn't intentional.
 330
 331
 332         Enjoy
 333
 334         Jesse Vincent
 335         <jesse@bestpractical.com>
 336         Best Practical Solutions, LLC