X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2FREADME;h=6581240aa9d0d175f1762b2990940f62014842ba;hp=d16100c5f4d10d5baf24fa9d24258004c3ca348d;hb=681a340f6be4184b1472a8e1fa9cd5d074f6f325;hpb=3ef62a0570055da710328937e7f65dbb2c027c62 diff --git a/rt/README b/rt/README index d16100c5f..6581240aa 100755 --- a/rt/README +++ b/rt/README @@ -1,336 +1,326 @@ -$Header: /home/cvs/cvsroot/freeside/rt/README,v 1.1 2002-08-12 06:17:06 ivan Exp $ -RT is (c) 1996-2002 by Jesse Vincent +RT is an enterprise-grade issue tracking system. It allows organizations +to keep track of what needs to get done, who is working on which tasks, +what's already been done, and when tasks were (or weren't) completed. -RT is licensed to you under the terms of version 2 of the GNU General -Public License. +RT doesn't cost anything to use, no matter how much you use it; it is +freely available under the terms of Version 2 of the GNU General Public +License. -If you don't have a copy of the GPL, you've been living in a cave, -but one should be included in this distribution. +RT is commercially-supported software. To purchase support, training, +custom development, or professional services, please get in touch with +us at . -INSTALLATION INSTRUCTIONS -------------------------- +REQUIRED PACKAGES +----------------- -These instructions are a summary of those at http://www.fsck.com/rtfm/ -The docs on the web at www.fsck.com/rtfm/ are likely to be more up to -date and complete than this document. You should consult them before -proceeding. +o Perl 5.10.1 or later (http://www.perl.org). -REQUIRED PACKAGES: ------------------- + RT won't start on versions of Perl older than 5.10.1. -o Perl5.005_03 or later with support for setgid perl scripts - RT's command line and mail gateway tools run setgid to the 'rt' group - to protect RT's database password. You may need to install a special - "suidperl" package or reconfigure your perl setup to support - "setuid scripts". +o A supported SQL database -o A DB backend; MySQL is recommended ( http://www.mysql.com ) - Currently supported: Mysql 3.23.38 or newer. - (Some older releases had crippling SQL bugs) - Postgres 7.1 or newer. + Currently supported: MySQL 5.1 or later with InnoDB support. + Postgres 8.4 or later; 9.0 or later suggested + Oracle 9iR2 or later. + SQLite 3.0 or later; for testing only, no + upgrade path guaranteed -o Apache + mod_perl -- ( http://perl.apache.org) - or A webserver with FastCGI support (www.fastcgi.com) +o Apache version 1.3.x or 2.x (http://httpd.apache.org) + with FastCGI -- (http://www.fastcgi.com) + or mod_perl -- (http://perl.apache.org) + or another webserver with FastCGI support - If you compile mod_perl as a DSO, you're on your own. It's known - to have massive stability problems. - mod_perl must be build with EVERYTHING=1 + RT's FastCGI handler needs to access RT's configuration file. -o Various and sundry perl modules - RT takes care of the installation of most of these automatically - during the "make testdeps" and "make fixdeps" stages below +o Various and sundry perl modules + + A tool included with RT takes care of the installation of most + of these automatically during the install process. + + The tool supplied with RT uses Perl's CPAN (http://www.cpan.org) + to install modules. Some operating systems package all or some + of the modules required, and you may be better off installing + the modules that way. GENERAL INSTALLATION -------------------- -1 Unpack this distribution SOMWHERE OTHER THAN where you want to install RT + 1) Unpack this distribution other than where you want to install RT. + To do this cleanly, run the following command: - Granted, you've already got it open. To do this cleanly: + tar xzvf rt.tar.gz -C /tmp - tar xzvf rt.tar.gz -C /tmp + 2) Run the "configure" script. To see the list of options, run: -2 Check over /tmp/rt/Makefile + ./configure --help - There are many variables you NEED to customize for your site. - Even if you are just upgrading, you must set ALL variables. + Peruse the options, then rerun ./configure with the flags you want. -3 Satisfy RT's myriad dependencies. There's a perl script in rt/tools - called testdeps that uses CPAN to automate all of this. + RT defaults to installing in /opt/rt4 with MySQL as its database. It + tries to guess which of www-data, www, apache or nobody your + webserver will run as, but you can override that behavior. Note + that the default install directory in /opt/rt4 does not work under + SELinux's default configuration. -3.1 Check for compliance: - make testdeps + If you are upgrading from a previous version of RT, please review + the upgrade notes for the appropriate versions, which can be found + in docs/UPGRADING-* If you are coming from 4.0.x to 4.2.x you should + review both the UPGRADING-4.0 and UPGRADING-4.2 files. Similarly, if + you were coming from 3.8.x, you would want to review the UPGRADING-3.8, + UPGRADING-4.0 and UPGRADING-4.2 documents. -3.2 If there are unsatisfied dependencies, install them by hand or run - make fixdeps - - (You may need to install Apache::Session and Apache::DBI by hand. + Any upgrade steps given in version-specific UPGRADING files should + be run after the rest of the steps below; however, please read the + relevant documentation before beginning the upgrade, so as to be + aware of important changes. - You might need to install Msql-Mysql-Modules by hand. - perl -MCPAN -e'install DBD::mysql::Install' should do it for you. - ) + RT stores the arguments given to ./configure at the top of the + etc/RT_Config.pm file in case you need to recreate your previous use + of ./configure. -3.3 Check to make sure everything was installed properly: - make testdeps + 3) Make sure that RT has the Perl and system libraries it needs to run. + Check for missing dependencies by running: -4 Create a group called 'rt' + make testdeps -5a FOR A NEW INSTALLATION: - - As root, type: - make install (replace "make" with the local name for - Make, if you need to) + 4) If the script reports any missing dependencies, install them by + hand, or run the following command as a user who has permission to + install perl modules on your system: - If the make fails, type: - make dropdb - and start over from step 5a + make fixdeps -5b FOR UPGRADING: (Within the RT 2.0.x series) + Some modules require user input or environment variables to install + correctly, so it may be necessary to install them manually. - Make a backup of /path/to/rt/etc/config.pm - - As root, type: - make upgrade (replace "make" with the local name for - Make, if you need to) + If you are having trouble installing GD, refer to "Installing GD libraries" + in docs/charts.pod. Ticket relationship graphing requires the graphviz + library which you should install using your distribution's package manager. - This will build new binaries, config files and libraries without - overwriting your RT database. + 5) Check to make sure everything was installed properly. - WARNING: This WILL clobber your existing configuration file! - - The install process will then instruct you to update your RT system - database objects by running rt/etc/insertdata where - is the version of RT you're upgrading from. + make testdeps - - -5c FOR UPGRADING (From 1.0.x): + It might sometimes be necessary to run "make fixdeps" several times + to install all necessary perl modules. - Follow the instructions for installing RT 2.0. +6a) If this is a NEW installation (not an upgrade): - Once you have installed RT 2.0, download import-1.0-to-2.0 - from http://www.fsck.com/pub/rt/contrib/2.0/rt-addons + As a user with permission to install RT in your chosen directory, + type: - Edit the configuration defaults in import-1.0-to-2.0 + make install - If you don't set $DEFAULTQUEUE to the name of one of your - RT 1.0 queues, THE IMPORT WILL FAIL. + To configure RT with the web installer, run: - perl ./import-1.0-to-2.0 + /opt/rt4/sbin/rt-server - The import tool will do its thing. If you're using postgres, you'll - need to execute the following SQL statement within your RT2 database: + and follow the instructions. Once completed, you should now have a + working RT instance running with the standalone rt-server. Press + Ctrl-C to stop it, and proceed to Step 7 to configure a recommended + deployment environment for production. - select setval('tickets_id_seq', (select max(id) from tickets)); - - It imports: - Queues, Areas, Users, Acls, Mailing Rules, Queue Members, - Tickets and Transactions. + To configure RT manually, you must setup etc/RT_SiteConfig.pm in + your RT installation directory. You'll need to add any values you + need to change from the defaults in etc/RT_Config.pm - It DOES NOT IMPORT: - Attachments removed by stripmime or Templates. - -6 Edit etc/config.pm in your RT installation directory. In many - cases sensible defaults have been included. In others, you MUST - supply a value. + As a user with permission to read RT's configuration file, type: -7 Configure the email and web gateways, as described below. + make initialize-database -8 Stop and start your webserver, so it picks up your configuration changes. + If the make fails, type: - NOTE: root's password for the web interface is "password" - (without the quotes.) Not changing this is a SECURITY risk - -9 Configure RT per the instructions at http://www.fsck.com/rtfm/ + make dropdb - Until you do this, RT will not be able to send or recieve email, - nor will it be more than marginally functional. This is not an - optional step. + and re-run 'make initialize-database'. +6b) If you are UPGRADING from a previous installation: -SETTING UP THE MAIL GATEWAY ---------------------------- + Before upgrading, always ensure that you have a complete current + backup. If you don't have a current backup, upgrading your database + could accidentally damage it and lose data, or worse. -An alias for the initial queue will need to be made in either your -global mail aliases file (if you are using NIS) or locally on your -machine. - -Add the following lines to /etc/aliases (or your local equivalent) : + If you are using MySQL, please read the instructions in + docs/UPGRADING.mysql as well to ensure that you do not corrupt + existing data. -rt: "|/path/to/rt2/bin/rt-mailgate --queue general --action correspond" -rt-comment: "|/path/to/rt2/bin/rt-mailgate --queue general --action comment" - | | - ----/ | - | - ---/ + First, stop your webserver. You may also wish to put incoming email + into a hold queue, to avoid temporary delivery failure messages if + your upgrade is expected to take several hours. + Next, install new binaries, config files and libraries by running: + make upgrade -THE WEB UI ----------- + This will also prompt you to upgrade your database by running: -RT's web ui is based around HTML::Mason, which works well with the mod_perl -perl interpreter within Apache httpd as well as with a webserver which -supports FastCGI. (Instructions for configuring RT for use with FastCGI -are available at http://www.fsck.com/rtfm/ ) + make upgrade-database -Apache - RT Uses HTML::Mason. You'll need to add a few lines to your - httpd.conf telling it to use rt's web ui. If you have mod-perl - (you should, the perl scripts will go quite a bit faster around with - it), you can do something like this: + You should back up your database before running this command. + When you run it, you will be prompted for your previous version of + RT (such as 4.0.23) so that the appropriate set of database + upgrades can be applied. + If 'make upgrade-database' completes without error, your upgrade + has been successful; you should now run any commands that were + supplied in version-specific UPGRADING documentation. You should + then restart your webserver. - -DocumentRoot /path/to/rt2/WebRT/html -ServerName your.rt.server.hostname -PerlModule Apache::DBI -PerlFreshRestart On -PerlRequire /path/to/rt2/bin/webmux.pl - - SetHandler perl-script - PerlHandler RT::Mason - - + 7) Configure the web server, as described in docs/web_deployment.pod, + and the email gateway, as described below. -Additionally, you should set up a cron job to remove stale session data. + NOTE: The default credentials for RT are: + User: root + Pass: password + Not changing the root password from the default is a SECURITY risk! -!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - WARNING: Don't install this cron job or run this find command if your - MASON_SESSION_PATH (known in config.pm as $MasonSessionDir) - points to a directory that could EVER contain any file that's not - a Apache::Session datafile. -!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + Once you've set up the web interface, consider setting up automatic + logout for inactive sessions. For more information about how to do + that, run: -# Every hour, nuke session files and lockfiles that haven't been -# touched in 10 hours + perldoc /opt/rt4/sbin/rt-clean-sessions -0 * * * * find /path/to/rt2/WebRT/sessiondata -type f -amin +600 -exec rm {} \; + 8) Set up users, groups, queues, scrips and access control. + Until you do this, RT will not be able to send or receive email, nor + will it be more than marginally functional. This is not an optional + step. -THE CLI -------- - Binaries for the CLI are located in rt/bin - You've got: + 9) Set up automated recurring tasks (cronjobs): - "rt" (manipulate or display requests) - "rtadmin" (modify queues, users and acls) + To generate email digest messages, you must arrange for the provided + utility to be run once daily, and once weekly. You may also want to + arrange for the rt-email-dashboards utility to be run hourly. For + example, if your task scheduler is cron, you can configure it by + adding the following lines as /etc/cron.d/rt: - Both of these programs take --help as an option. + 0 0 * * * root /opt/rt4/sbin/rt-email-digest -m daily + 0 0 * * 0 root /opt/rt4/sbin/rt-email-digest -m weekly + 0 * * * * root /opt/rt4/sbin/rt-email-dashboards +10) Configure the RT email gateway. To let email flow to your RT + server, you need to add a few lines of configuration to your mail + server's "aliases" file. These lines "pipe" incoming email messages + from your mail server to RT. -BUGS ----- + Add the following lines to /etc/aliases (or your local equivalent) + on your mail server: + + rt: "|/opt/rt4/bin/rt-mailgate --queue general --action correspond --url http://rt.example.com/" + rt-comment: "|/opt/rt4/bin/rt-mailgate --queue general --action comment --url http://rt.example.com/" + + You'll need to add similar lines for each queue you want to be able to + send email to. To find out more about how to configure RT's email + gateway, type: -Known issues with releases of RT2 are listed at -. This includes every bug known -to exist in each release of RT. (When prompted, login as guest/guest) + perldoc /opt/rt4/bin/rt-mailgate -To find out more about currently open bugs, check out the live -Buglist at . -(When prompted, login as guest/guest) +11) Set up automatic backups for RT and its data as described in + the docs/backups.pod document. -To report a bug, send an email to rt-2.0-bugs@fsck.com. GETTING HELP ------------ -If RT is mission-critical for you or if you use it heavily, we recommend that -you purchase a commercial support contract. Details on support contracts -are available at http://www.bestpractical.com. +If RT is mission-critical for you or if you use it heavily, we recommend +that you purchase a commercial support contract. Details on support +contracts are available at http://www.bestpractical.com or by writing to +. -If you're interested in having RT extended or customized or would like more -information about commercial support options, please send email to +If you're interested in having RT extended or customized or would like +more information about commercial support options, please send email to to discuss rates and availability. -RT-USERS MAILINGLIST --------------------- - -To keep up to date on the latest RT tips, techniques and extections, -you probably want to join the rt-users mailinglist. Send a message to: - - rt-users-request@lists.fsck.com - -With the body of the message consisting of only the word: - - subscribe +MAILING LISTS AND WIKI +---------------------- -If you're interested in hacking on rt, you'll want to subscribe to -rt-devel@lists.fsck.com. Subscribe to it with instructions similar to -those above. +To keep up to date on the latest RT tips, techniques and extensions, you +may wish to join the rt-users mailing list. Send a message to: -Address questions about the stable release to the rt-users list, and -questions about the development version to the rt-devel list. If you feel -your questions are best not asked publically, send them personally to -. + rt-users-request@lists.bestpractical.com -If you want to be informed of every commit to the CVS repository, -subscribe to rt-commit@fsck.com using similar instructions to those above. +with the body of the message consisting of only the word: + subscribe -RT WEBSITE ----------- +If you're interested in hacking on RT, you'll want to subscribe to +. Subscribe to it with instructions +similar to those above. Address questions about the stable release to +the rt-users list, and questions about the development version to the +rt-devel list. -For current information about RT, check out the RT website at -http://www.bestpractical.com/rt You'll find screenshots, a pointer -to the current version of rt, contributed patches and lots of other great -stuff. +The RT wiki, at http://requesttracker.wikia.com/ , is also a potential +resource. -TROUBLESHOOTING ---------------- +SECURITY +-------- -All errors will be appended to a logfile, which lives in /tmp/rt.log.* unless -you've reconfigured it. Check etc/config.pm for details. +If you believe you've discovered a security issue in RT, please send an +email to with a detailed description of the +issue, and a secure means to respond to you (such as your PGP public +key). You can find our PGP key and fingerprint at +http://bestpractical.com/security/ -If the solution to the problem you're running into isn't obvious and you've -checked the FAQ, feel free to send mail to rt-users@fsck.com (for release -versions of RT) or rt-devel@fsck.com (for development versions). -GIVING SOMETHING BACK ---------------------- - -RT is free software. You are not obligated to pay for it. You should be -aware, however, that bestpractical.com's sole source of revenue is commercial -work related to RT. If you are able, either a contract to extend RT in some -way that would be useful to your organization, a financial contribution, or -even something off the author's amazon wishlist - ( http://www.amazon.com/exec/obidos/wishlist/2GMHUDAFBT2XR/ ) -would be much appreciated. - -Thanks! - - -CREDITS -------- - -A lot of people are responsible for making RT a better program. Many -thanks to Lauren Burka, who originally tasked me with writing this beast. -She forced me to use a database backend. I've thanked her for it every -day since. Rich West rewrote this readme and did some UI hacking. Adam -Hirsch, Kit Kraysha, Robin Garner, Jens Glaser, John Adams, Trey Belew, -Sean Dague, Nathan Mehl, Kee Hinckley, Rich West, Dale Bewley, Serge Zhuk, -John Lengeling, Elmar Knipp, Gerald Abshez, Dave Hull, Dave Schenet, -Dave Walton, Jan Okrouhly, Tobias Brox, Lamont Lucas, Charlie Brady, -Robin Shostack, Eric Mumpower, Jerrod Wiesman, Adam Hammer, Ivan Kohler, Alex -Pilosov, Mary Alderdice, Deborah Kaplan, Jens von Bülow, Tristan Horn, -Lee Ann Goldstein, Karel P Kerezman, Feargal Reilly, Christian Steger, -Christian Kurz, JD Falk, Arthur de Jong, Ben Carter, Mark Vevers -and many others -have all contributed bug reports, code or ideas that have helped RT along. - -Arepa, Inc, Utopia Inc, Wesleyan University and The Leftbank Operation -have paid me to maintain RT and release it to the public. Without their -support RT would not exist. - -If I've left you out, please drop me a line ....it wasn't intentional. - - - Enjoy +BUGS +---- - Jesse Vincent - - Best Practical Solutions, LLC +RT's a pretty complex application, and as you get up to speed, you might +run into some trouble. Generally, it's best to ask about things you run +into on the rt-users mailinglist (or pick up a commercial support +contract from Best Practical). But, sometimes people do run into +bugs. In the exceedingly unlikely event that you hit a bug in RT, please +report it! We'd love to hear about problems you have with RT, so we can +fix them. To report a bug, send email to . + + +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2016 Best Practical Solutions, LLC +# +# +# (Except where explicitly superseded by other copyright notices) +# +# +# LICENSE: +# +# This work is made available to you under the terms of Version 2 of +# the GNU General Public License. A copy of that license should have +# been provided with this software, but in any event can be snarfed +# from www.gnu.org. +# +# This work is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301 or visit their web page on the internet at +# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html. +# +# +# CONTRIBUTION SUBMISSION POLICY: +# +# (The following paragraph is not intended to limit the rights granted +# to you to modify and distribute this software under the terms of +# the GNU General Public License and is only of importance to you if +# you choose to contribute your changes and enhancements to the +# community by submitting them to Best Practical Solutions, LLC.) +# +# By intentionally submitting any modifications, corrections or +# derivatives to this work, or any other work intended for use with +# Request Tracker, to Best Practical Solutions, LLC, you confirm that +# you are the copyright holder for those contributions and you grant +# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +# royalty-free, perpetual, license to use, copy, create derivative +# works based on those contributions, and sublicense and distribute +# those contributions and any derivatives thereof. +# +# END BPS TAGGED BLOCK }}}