Rt

<p align="center"> <a href="https://requesttracker.com/"> <img src="https://static.bestpractical.com/rt-logo.png" alt="Best Practical logo" width="500" height="200"> </a> </p> <h1 align="center">Request Tracker (RT)</h1> <p align="center"> RT is an open source, enterprise-grade issue and ticket tracking system. <br> <a href="https://docs.bestpractical.com/rt/latest/index.html"><strong>Explore RT docs »</strong></a> <br> <br> <a href="https://docs.bestpractical.com/release-notes/rt/index.html">Release Notes</a> · <a href="https://forum.bestpractical.com/">Community Forum</a> · <a href="https://rt-wiki.bestpractical.com">Public Wiki</a> · <a href="https://bestpractical.com/blog/">Blog</a> · <a href="https://bestpractical.com/pricing">Hosting & Support</a> <br /><br /> <a href="https://github.com/bestpractical/rt/releases"> <img src="https://img.shields.io/github/v/release/bestpractical/rt" alt="Latest release" /> </a> <a href="https://github.com/bestpractical/rt/actions"> <img src="https://github.com/bestpractical/rt/actions/workflows/test-all.yml/badge.svg?branch=5.0-trunk" alt="Build status" /> </a> </p> <p align="center"> RT 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. </p> <p align="center"> 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. </p> <p align="center"> RT is commercially-supported software. To purchase hosting, support, training, custom development, or professional services, please get in touch with us at <a href="mailto:sales@bestpractical.com">sales@bestpractical.com</a>. </p>

REQUIRED PACKAGES

• Perl 5.26.3 or later (http://www.perl.org).

  • RT won't start on versions of Perl older than 5.26.3.

• A supported SQL database

  • MySQL 8.0.31 or later with InnoDB support
  • MariaDB 10.6 or later with InnoDB support
  • Postgres 13 or later
  • Oracle 18c or later
  • SQLite 3.0 or later (for testing only, no upgrade path guaranteed)

• A webserver with FastCGI or mod_perl support

  • Apache version 2.x (https://httpd.apache.org)
    • with mod_fcgid -- (https://httpd.apache.org/mod_fcgid/mod/mod_fcgid.html)
    • or mod_perl -- (http://perl.apache.org)
  • nginx -- (https://nginx.org/)
  • Another webserver with FastCGI support

  RT's FastCGI handler needs to access RT's configuration file.

• Various and sundry perl modules

  • A tool included with RT takes care of the installation of most of these automatically using Perl's CPAN (http://www.cpan.org). Some operating systems package all or some of the modules required, so that can be an easier way to get all of the dependencies installed. See our perl documentation for more tips.

OPTIONAL DEPENDENCIES

• Full-text indexing support in your database

  • The databases listed above all have options for full-text indexing (excluding SQLite). See docs/full_text_indexing.pod for details.

• An external HTML converter

  • Installing an external utility to convert HTML can improve performance. See the C<$HTMLFormatter> configuration option for details.

• A TLS certificate for your web server

  • For production use, we recommend getting an SSL certificate for your web server. You can get them free from Let's Encrypt (https://letsencrypt.org/) or even create your own self-signed certificate.
  • If you are testing and want to run without a certificate, add this to your etc/RT_SiteConfig.pm file:

    Set( $WebSecureCookies, 0 );
    

  • Without this setting, your browser won't trust RT's cookies and you won't be able to log in. See etc/RT_Config.html#WebSecureCookies for more information.

GENERAL INSTALLATION

1. Unpack this distribution other than where you want to install RT. Your home directory or /usr/local/src are both fine choices. Change to that directory and run the following command:

   tar xzvf rt.tar.gz
   

2. Run the configure script. To see the list of options, run:

   ./configure --help
   

   Or review the options on our documentation page for configure.

   Then re-run ./configure with the flags you want.

   RT defaults to installing in /opt/rt6. 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/rt6 does not work under SELinux's default configuration.

   The default database type (--with-db-type) is mysql, which means MySQL version 8 and later. Starting in RT 5.0.6, use mysql5 to run MySQL 5.7 or older, and use MariaDB to run with MariaDB.

   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 upgrading from 5.0.x to 6.0.x you should review both the UPGRADING-5.0 and UPGRADING-6.0 files.

   If you are upgrading from 4.4.x, you should review UPGRADING-4.4 as well.

   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 to be aware of important changes.

   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. Make sure that RT has the Perl and system libraries it needs to run. Check for missing dependencies by running:

   make testdeps
   

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:

   make fixdeps
   

   Some modules require user input or environment variables to install correctly, so it may be necessary to install them manually. Some modules also require external source libraries, so you may need to install additional packages.

   Ticket relationship graphing requires the graphviz library which you should install using your distribution's package manager.

   Dashboard emails containing charts require a Chrome-based browser to be installed on the RT server. Most distributions have a package for "chromium".

   See docs/rt_perl.pod for additional information about installing perl and RT's dependencies.

5. Check to make sure everything was installed properly.

   make testdeps
   

   It might sometimes be necessary to run "make fixdeps" several times to install all necessary perl modules.

6a. If you are installing RT for the first time

As a user with permission to install RT in your chosen directory, type:

make install

To configure RT with the web installer, run:

/opt/rt6/sbin/rt-server

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.

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.

As a user with permission to read RT's configuration file, type:

make initialize-database

If the make fails, type:

make dropdb

and re-run make initialize-database.

6b. If you are upgrading from an older release of RT 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.

If you are using MySQL, please read the instructions in docs/UPGRADING.mysql as well to ensure that you do not corrupt existing data.

• 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.

• Back up your database, as the next step may make changes to your database's schema and data.

• Install new binaries, config files and libraries by running:

make upgrade

• This will also prompt you to upgrade your database by running:

make upgrade-database

When you run it, you will be prompted for your previous version of RT (such as 4.4.1) 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.

Depending on the size and composition of your database, some upgrade steps may run for a long time. You may also need extra disk space or other resources while running upgrade step