Freeside:3:Documentation:RT Installation

2015-01-20T23:30:59Z

Alex: Including Debian 7's setup of the pg_hba.conf file.

== Introduction ==

These instructions document installation of the integrated internal RT ticketing system.

There is also support for running this integration against an external RT installation, but it is not (yet) documented.

Documentation contributions are welcome.

== Prerequisites ==

* [http://search.cpan.org/dist/Apache-Session Apache::Session]
* [http://search.cpan.org/dist/HTML-Tree HTML::TreeBuilder]
* [http://search.cpan.org/dist/HTML-Format HTML-Format] (CPAN: "install HTML::FormatText")
* [http://search.cpan.org/dist/Test-Inline Test::Inline]
* [http://search.cpan.org/dist/Class-ReturnValue Class::ReturnValue]
* [http://search.cpan.org/dist/DBIx-SearchBuilder DBIx::SearchBuilder]
* [http://search.cpan.org/dist/Log-Dispatch Log::Dispatch]
* [http://search.cpan.org/dist/Locale-Maketext-Lexicon Locale::Maketext::Lexicon]
* [http://search.cpan.org/dist/Locale-Maketext-Fuzzy Locale::Maketext::Fuzzy]
* [http://search.cpan.org/dist/Text-Wrapper Text::Wrapper]
* [http://search.cpan.org/dist/Time-modules Time-modules] (CPAN: "install Time::ParseDate")
* [http://search.cpan.org/dist/TermReadKey Term::ReadKey]
* [http://search.cpan.org/dist/Text-Autoformat Text::Autoformat]
* [http://search.cpan.org/dist/Text-Quoted Text::Quoted]
* [http://search.cpan.org/dist/Regexp-Common Regexp::Common]
* [http://search.cpan.org/dist/HTML-Scrubber HTML::Scrubber]
* [http://search.cpan.org/dist/Tree-Simple Tree::Simple]
* [http://search.cpan.org/dist/Crypt-SSLeay Crypt::SSLeay]
* [http://search.cpan.org/dist/GDGraph GD::Graph]
* [http://search.cpan.org/dist/UNIVERSAL-Require UNIVERSAL::require]
* [http://search.cpan.org/dist/XML-RSS XML::RSS]
* [http://search.cpan.org/dist/Calendar-Simple Calendar::Simple]
* [http://search.cpan.org/dist/GD-Graph GD::Graph]
* [http://search.cpan.org/dist/GD-Text GD::Text]
* [http://search.cpan.org/dist/CSS-Squish CSS::Squish]
* [http://search.cpan.org/dist/HTML-Element-Extended HTML::ElementTable]

Missing prerequisites? Please add them.

== Installation ==

* Create a new Unix group called 'rt'
<pre>
addgroup rt
</pre>
* Edit the top-level Makefile (within the freeside source directory - NOT rt directory), set RT_ENABLED to 1 and set the RT_DOMAIN, RT_TIMEZONE, and FREESIDE_URL variables.
<pre>
cd freeside-X.X/
nano Makefile
</pre>

* <pre><nowiki>$ make configure-rt</nowiki></pre>
* If your database is not on the local machine you will need to edit /opt/rt3/etc/RT_SiteConfig.pm and set the DatabaseHost value
* <pre><nowiki># make create-rt</nowiki></pre>
** ''Authentication errors?''
*** ''Edit <code>pg_hba.conf</code>, change "<code>ident sameuser</code>" auth to "<code>trust</code>" for the line starting with "<code>local all all</code>" (Debian 7.x has a METHOD column that is set to <code>peer</code>, this needs to be set to <code>trust</code>)''
*** ''Restart Pg''
*** ''Revert the change back and restart Pg after this installation step''
* <pre><nowiki>make install-rt</nowiki></pre>
* Configure Apache: make sure APACHE_CONF and FREESIDE_DOCUMENT_ROOT are set correctly in the Makefile, then run:
<pre>
make install-apache
</pre>

* Restart Apache (httpd) and log into the Freeside web interface using the username and password you created during the first part of the installation.

* Set the '''ticket_system''' configuration value to <code>RT_Internal</code>. (You may also wish to set '''ticket_system-default_queueid''' once you have RT configured.)

=== Bootstrap RT's permissions ===
*Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
*From "Billing Main", go to Configuration > Employees > View/Edit employees and add a temporary "root" user. Note: the user name must be "root" (without the quotes).
* Log into your Freeside installation as the "root" user you just created, by closing all of your browser windows, or by using <code><nowiki>https://root@yourmachone/freeside/</nowiki></code> syntax if your browser supports it.
* Click on "Ticketing Main" on the Freeside main menu. Go to Configuration > Ticketing > Ticketing Global, and then "User Rights". Grant the "SuperUser" right to your normal RT/Freeside login.
* Go back to the freeside employee list and disable the temporary "root" user.

== Futher Reading ==
* Follow the [http://wiki.bestpractical.com/ regular RT documentation] to configure RT, setup the mailgate, etc.

Freeside - User contributions [en]

Freeside:3:Documentation:RT Installation