rt/README

   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.
   4
   5 RT doesn't cost anything to use, no matter how much you use it; it is
   6 freely available under the terms of Version 2 of the GNU General Public
   7 License.
   8
   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>.
  12
  13
  14 REQUIRED PACKAGES
  15 -----------------
  16
  17 o   Perl 5.10.1 or later (http://www.perl.org).
  18
  19         RT won't start on versions of Perl older than 5.10.1.
  20
  21 o   A supported SQL database
  22
  23         Currently supported:  MySQL 5.1 or later with InnoDB support.
  24                               Postgres 8.4 or later; 9.0 or later suggested
  25                               Oracle 9iR2 or later.
  26                               SQLite 3.0 or later; for testing only, no
  27                                            upgrade path guaranteed
  28
  29 o   Apache version 1.3.x or 2.x (http://httpd.apache.org)
  30         with FastCGI -- (http://www.fastcgi.com)
  31         or mod_perl -- (http://perl.apache.org)
  32         or another webserver with FastCGI support
  33
  34         RT's FastCGI handler needs to access RT's configuration file.
  35
  36 o   Various and sundry perl modules
  37
  38         A tool included with RT takes care of the installation of most
  39         of these automatically during the install process.
  40
  41         The tool supplied with RT uses Perl's CPAN (http://www.cpan.org)
  42         to install modules. Some operating systems package all or some
  43         of the modules required, and you may be better off installing
  44         the modules that way.
  45
  46
  47 GENERAL INSTALLATION
  48 --------------------
  49
  50  1) Unpack this distribution other than where you want to install RT.
  51     To do this cleanly, run the following command:
  52
  53         tar xzvf rt.tar.gz -C /tmp
  54
  55  2) Run the "configure" script.  To see the list of options, run:
  56
  57         ./configure --help
  58
  59     Peruse the options, then rerun ./configure with the flags you want.
  60
  61     RT defaults to installing in /opt/rt4 with MySQL as its database. It
  62     tries to guess which of www-data, www, apache or nobody your
  63     webserver will run as, but you can override that behavior.  Note
  64     that the default install directory in /opt/rt4 does not work under
  65     SELinux's default configuration.
  66
  67     If you are upgrading from a previous version of RT, please review
  68     the upgrade notes for the appropriate versions, which can be found
  69     in docs/UPGRADING-* If you are coming from 4.0.x to 4.2.x you should
  70     review both the UPGRADING-4.0 and UPGRADING-4.2 files.  Similarly, if
  71     you were coming from 3.8.x, you would want to review the UPGRADING-3.8,
  72     UPGRADING-4.0 and UPGRADING-4.2 documents.
  73
  74     Any upgrade steps given in version-specific UPGRADING files should
  75     be run after the rest of the steps below; however, please read the
  76     relevant documentation before beginning the upgrade, so as to be
  77     aware of important changes.
  78
  79     RT stores the arguments given to ./configure at the top of the
  80     etc/RT_Config.pm file in case you need to recreate your previous use
  81     of ./configure.
  82
  83  3) Make sure that RT has the Perl and system libraries it needs to run.
  84     Check for missing dependencies by running:
  85
  86         make testdeps
  87
  88  4) If the script reports any missing dependencies, install them by
  89     hand, or run the following command as a user who has permission to
  90     install perl modules on your system:
  91
  92         make fixdeps
  93
  94     Some modules require user input or environment variables to install
  95     correctly, so it may be necessary to install them manually.
  96
  97     If you are having trouble installing GD, refer to "Installing GD libraries"
  98     in docs/charts.pod.  Ticket relationship graphing requires the graphviz
  99     library which you should install using your distribution's package manager.
 100
 101  5) Check to make sure everything was installed properly.
 102
 103         make testdeps
 104
 105     It might sometimes be necessary to run "make fixdeps" several times
 106     to install all necessary perl modules.
 107
 108 6a) If this is a NEW installation (not an upgrade):
 109
 110       As a user with permission to install RT in your chosen directory,
 111       type:
 112
 113           make install
 114
 115       To configure RT with the web installer, run:
 116
 117           /opt/rt4/sbin/rt-server
 118
 119       and follow the instructions.  Once completed, you should now have a
 120       working RT instance running with the standalone rt-server.  Press
 121       Ctrl-C to stop it, and proceed to Step 7 to configure a recommended
 122       deployment environment for production.
 123
 124       To configure RT manually, you must setup etc/RT_SiteConfig.pm in
 125       your RT installation directory.  You'll need to add any values you
 126       need to change from the defaults in etc/RT_Config.pm
 127
 128       As a user with permission to read RT's configuration file, type:
 129
 130           make initialize-database
 131
 132       If the make fails, type:
 133
 134           make dropdb
 135
 136       and re-run 'make initialize-database'.
 137
 138 6b) If you are UPGRADING from a previous installation:
 139
 140       Before upgrading, always ensure that you have a complete current
 141       backup. If you don't have a current backup, upgrading your database
 142       could accidentally damage it and lose data, or worse.
 143
 144       If you are using MySQL, please read the instructions in
 145       docs/UPGRADING.mysql as well to ensure that you do not corrupt
 146       existing data.
 147
 148       First, stop your webserver.  You may also wish to put incoming email
 149       into a hold queue, to avoid temporary delivery failure messages if
 150       your upgrade is expected to take several hours.
 151
 152       Next, install new binaries, config files and libraries by running:
 153
 154           make upgrade
 155
 156       This will also prompt you to upgrade your database by running:
 157
 158           make upgrade-database
 159
 160       You should back up your database before running this command.
 161       When you run it, you will be prompted for your previous version of
 162       RT (such as 4.0.23) so that the appropriate set of database
 163       upgrades can be applied.
 164
 165       If 'make upgrade-database' completes without error, your upgrade
 166       has been successful; you should now run any commands that were
 167       supplied in version-specific UPGRADING documentation.  You should
 168       then restart your webserver.
 169
 170  7) Configure the web server, as described in docs/web_deployment.pod,
 171     and the email gateway, as described below.
 172
 173     NOTE: The default credentials for RT are:
 174         User: root
 175         Pass: password
 176     Not changing the root password from the default is a SECURITY risk!
 177
 178     Once you've set up the web interface, consider setting up automatic
 179     logout for inactive sessions. For more information about how to do
 180     that, run:
 181
 182         perldoc /opt/rt4/sbin/rt-clean-sessions
 183
 184  8) Set up users, groups, queues, scrips and access control.
 185
 186     Until you do this, RT will not be able to send or receive email, nor
 187     will it be more than marginally functional.  This is not an optional
 188     step.
 189
 190  9) Set up automated recurring tasks (cronjobs):
 191
 192     To generate email digest messages, you must arrange for the provided
 193     utility to be run once daily, and once weekly. You may also want to
 194     arrange for the rt-email-dashboards utility to be run hourly.  For
 195     example, if your task scheduler is cron, you can configure it by
 196     adding the following lines as /etc/cron.d/rt:
 197
 198         0 0 * * * root /opt/rt4/sbin/rt-email-digest -m daily
 199         0 0 * * 0 root /opt/rt4/sbin/rt-email-digest -m weekly
 200         0 * * * * root /opt/rt4/sbin/rt-email-dashboards
 201
 202 10) Configure the RT email gateway.  To let email flow to your RT
 203     server, you need to add a few lines of configuration to your mail
 204     server's "aliases" file. These lines "pipe" incoming email messages
 205     from your mail server to RT.
 206
 207     Add the following lines to /etc/aliases (or your local equivalent)
 208     on your mail server:
 209
 210         rt:         "|/opt/rt4/bin/rt-mailgate --queue general --action correspond --url http://rt.example.com/"
 211         rt-comment: "|/opt/rt4/bin/rt-mailgate --queue general --action comment --url http://rt.example.com/"
 212
 213     You'll need to add similar lines for each queue you want to be able to
 214     send email to. To find out more about how to configure RT's email
 215     gateway, type:
 216
 217            perldoc /opt/rt4/bin/rt-mailgate
 218
 219 11) Set up automatic backups for RT and its data as described in
 220     the docs/backups.pod document.
 221
 222
 223 GETTING HELP
 224 ------------
 225
 226 If RT is mission-critical for you or if you use it heavily, we recommend
 227 that you purchase a commercial support contract.  Details on support
 228 contracts are available at http://www.bestpractical.com or by writing to
 229 <sales@bestpractical.com>.
 230
 231 If you're interested in having RT extended or customized or would like
 232 more information about commercial support options, please send email to
 233 <sales@bestpractical.com> to discuss rates and availability.
 234
 235
 236 MAILING LISTS AND WIKI
 237 ----------------------
 238
 239 To keep up to date on the latest RT tips, techniques and extensions, you
 240 may wish to join the rt-users mailing list.  Send a message to:
 241
 242       rt-users-request@lists.bestpractical.com
 243
 244 with the body of the message consisting of only the word:
 245
 246      subscribe
 247
 248 If you're interested in hacking on RT, you'll want to subscribe to
 249 <rt-devel@lists.bestpractical.com>.  Subscribe to it with instructions
 250 similar to those above.  Address questions about the stable release to
 251 the rt-users list, and questions about the development version to the
 252 rt-devel list.
 253
 254 The RT wiki, at http://requesttracker.wikia.com/ , is also a potential
 255 resource.
 256
 257
 258 SECURITY
 259 --------
 260
 261 If you believe you've discovered a security issue in RT, please send an
 262 email to <security@bestpractical.com> with a detailed description of the
 263 issue, and a secure means to respond to you (such as your PGP public
 264 key).  You can find our PGP key and fingerprint at
 265 http://bestpractical.com/security/
 266
 267
 268 BUGS
 269 ----
 270
 271 RT's a pretty complex application, and as you get up to speed, you might
 272 run into some trouble. Generally, it's best to ask about things you run
 273 into on the rt-users mailinglist (or pick up a commercial support
 274 contract from Best Practical). But, sometimes people do run into
 275 bugs. In the exceedingly unlikely event that you hit a bug in RT, please
 276 report it! We'd love to hear about problems you have with RT, so we can
 277 fix them.  To report a bug, send email to <rt-bugs@bestpractical.com>.
 278
 279
 280 # BEGIN BPS TAGGED BLOCK {{{
 281 #
 282 # COPYRIGHT:
 283 #
 284 # This software is Copyright (c) 1996-2016 Best Practical Solutions, LLC
 285 #                                          <sales@bestpractical.com>
 286 #
 287 # (Except where explicitly superseded by other copyright notices)
 288 #
 289 #
 290 # LICENSE:
 291 #
 292 # This work is made available to you under the terms of Version 2 of
 293 # the GNU General Public License. A copy of that license should have
 294 # been provided with this software, but in any event can be snarfed
 295 # from www.gnu.org.
 296 #
 297 # This work is distributed in the hope that it will be useful, but
 298 # WITHOUT ANY WARRANTY; without even the implied warranty of
 299 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 300 # General Public License for more details.
 301 #
 302 # You should have received a copy of the GNU General Public License
 303 # along with this program; if not, write to the Free Software
 304 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 305 # 02110-1301 or visit their web page on the internet at
 306 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
 307 #
 308 #
 309 # CONTRIBUTION SUBMISSION POLICY:
 310 #
 311 # (The following paragraph is not intended to limit the rights granted
 312 # to you to modify and distribute this software under the terms of
 313 # the GNU General Public License and is only of importance to you if
 314 # you choose to contribute your changes and enhancements to the
 315 # community by submitting them to Best Practical Solutions, LLC.)
 316 #
 317 # By intentionally submitting any modifications, corrections or
 318 # derivatives to this work, or any other work intended for use with
 319 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
 320 # you are the copyright holder for those contributions and you grant
 321 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
 322 # royalty-free, perpetual, license to use, copy, create derivative
 323 # works based on those contributions, and sublicense and distribute
 324 # those contributions and any derivatives thereof.
 325 #
 326 # END BPS TAGGED BLOCK }}}