Fetching latest commit…
Cannot retrieve the latest commit at this time
|Failed to load latest commit information.|
RT for Incident Response is an open source, industrial-grade incident-handling tool designed to provide a simple, effective workflow for members of CERT and CSIRT teams. It allows team members to track, respond to and deal with reported incidents and features a number of tools to make common operations quick and easy. RTIR is built on top of RT, which is also available for free from Best Practical Solutions at http://www.bestpractical.com/rt/. RT and RTIR are commercially-supported software. To purchase support, training, custom development, or professional services, please get in touch with us at <firstname.lastname@example.org>. REQUIRED PACKAGES: ------------------ o RT 4.0.14 or later, configured, installed and tested. o Net::Whois::RIPE 1.31 is bundled with RTIR for compatibility with the API RTIR uses and for a fix to run without warnings under perl 5.18. Upgrade instructions: ----------------------- If you've installed a prior version of RTIR, you may need to follow special steps to upgrade. See the docs/UPGRADING file for detailed information. Installation instructions: -------------------------- 1) Install RT 4.0.0 or newer following RT's regular installation instructions 2) Run "perl Makefile.PL" to generate a makefile for RTIR. 3) Install any extra Perl modules RTIR needs that aren't already installed. The output from the previous step will list new modules needed, or if existing modules need to be upgraded to a newer version. 4) Type "make install". 5a) If you are installing RTIR for the first time, initialize the RTIR database by typing "make initdb". WARNING: Do not attempt to re-initialize the database if you are upgrading. 5b) If you are UPGRADING from a previous installation, read the UPGRADING file for instructions on how to upgrade your database. 6) Activate the RTIR extension in the RT_SiteConfig.pm file: Set(@Plugins, 'RT::IR'); 7) Stop and start your web server. Additional Extensions: ---------------------- o To maintain Due date for Reports, Investigations and Blocks, install RT::Extension::SLA following the installation instructions in that extension's README file. o If you want to enable ticket/incident aging, install RT::Extension::TicketAging following the instructions in that extension's INSTALL and README files. o If you want to enable ticket locking, install RT::Extension::TicketLocking following the installation instructions in that extension's README file. Configuring RTIR ---------------- 1) Using RT's configuration interface, add the email address of the Network Operations Team (the people who will handle activating and removing Blocks) as AdminCC on the Blocks queue. RT -> Queues -> Blocks -> Watchers 2) You may want to modify the email messages that are automatically sent on the creation of Investigations and Blocks. RT -> Queues -> <Select RTIR's Queue> -> Templates. RT -> Global -> Templates. 3) By default, RT ships with a number of global Scrips. You should use RT's configuration interface to look through them, and disable any that aren't apropriate in your environment. RT -> Queues -> <Select RTIR's Queue> -> Scrips. RT -> Global -> Scrips. 4) Add staff members who handle incidents to the DutyTeam group. RT -> Configuration -> Groups -> DutyTeam -> Members. 5) You can override values in the RTIR_Config.pm in your RT_SiteConfig.pm file. Just add your customizations. SETTING UP THE MAIL GATEWAY --------------------------- An alias for the Incident Reports queue will need to be configured. Add the following lines to /etc/aliases (or your local equivalent): rtir: "|/opt/rt4/bin/rt-mailgate --queue 'Incident Reports' --action correspond --url http://localhost/" You should substitute the URL for RT's web interface for "http://localhost/". o If your webserver uses SSL, rt-mailgate will require several new Perl libraries. See the RT README for more details on this option. o See "perldoc /opt/rt4/bin/rt-mailgate" for more info about the rt-mailgate script. o If you're configuring RTIR with support for multiple constituencies, please refer to the instructions in the file lib/RT/IR/Constituencies.pod Documentation for RTIR ---------------------- * This README file * UPGRADING Instructions for users upgrading from 1.0 or 2.0 * perldoc docs/DocIndex.pod ( also at http://bestpractical.com/docs/rtir/latest/DocIndex ) Links to documentation specific to RTIR * perldoc docs/Tutorial.pod ( also at http://bestpractical.com/docs/rtir/latest/Tutorial ) Extended information about ticket merging * perldoc docs/Constituencies.pod ( also at http://bestpractical.com/docs/rtir/latest/Constituencies ) Information about setting up RTIR with multiple user constituencies * perldoc docs/AdministrationTutorial.pod ( also at http://bestpractical.com/docs/rtir/latest/AdministrationTutorial ) Information about setting up RTIR for Administrators * install extension RT-OnlineDocs to give SuperUsers access to the RT::IR and RT API documentation via the Web UI. This includes the Tutorial.pod and other .pod files mentioned above. * perldoc RT::Extension::TicketAging (also at https://metacpan.org/module/RT::Extension::TicketAging ) Information about configuring and using RT and RTIR Ticket Aging. * perldoc RT::Extension::TicketLocking (also at https://metacpan.org/module/RT::Extension::TicketLocking ) Information about configuring and using RT and RTIR Ticket Locking. * etc/RTIR_Config.pm (Contains a number of RTIR-specific configuration options and instructions for their use) * RTIR mailing list Subscribe by sending mail to email@example.com * http://wiki.bestpractical.com/view/RTIR The RTIR section of the community-developed RT wiki is still in its infancy. DEVELOPMENT ----------- If you would like to run RTIR's tests, you need to set a few environment variables: RT_DBA_USER - a user who can create a database on your RDBMS (such as root on mysql) RT_DBA_PASSWORD - the password for RT_DBA_USER To run tests: $ RTHOME=/opt/my-rt perl Makefile.PL $ RT_DBA_USER=user RT_DBA_PASSWORD=password make test These are intended to be run before installing RTIR. Like RT, RTIR expects to be able to create a new database called rt4test on your system REPORTING BUGS -------------- To report a bug, send email to firstname.lastname@example.org.