preliminary RT docs
[freeside.git] / httemplate / docs / install-rt.html
1 <head>
2   <title>Installing integrated RT ticketing</title>
3 </head>
4 <body>
5 <h1>Installing integrated RT ticketing</h1>
6
7 <p><i>Integrated ticketing is an new feature and these instructinos are preliminary.  Documentation contributions are welcome.</i>
8
9 <p>Perl minimum version 5.8.3 is required.  HTML::Mason is required.
10
11 <p>Install the following perl modules:
12   <ul>
13     <li><a href="http://search.cpan.org/search?dist=Apache-Session">Apache::Session</a>
14     <li><a href="http://search.cpan.org/search?dist=HTML-TreeBuilder">HTML::TreeBuilder</a>
15     <li><a href="http://search.cpan.org/search?dist=HTML-FormatText">HTML::FormatText</a>
16     <li><a href="http://search.cpan.org/search?dist=Test-Inline">Test::Inline</a>
17     <li><a href="http://search.cpan.org/search?dist=Class-ReturnValue">Class::ReturnValue</a>
18     <li><a href="http://search.cpan.org/search?dist=DBIx-SearchBuilder">DBIx::SearchBuilder</a>
19     <li><a href="http://search.cpan.org/search?dist=Log-Dispatch">Log::Dispatch</a>
20     <li><a href="http://search.cpan.org/search?dist=Locale-Maketext-Lexicon">Locale::Maketext::Lexicon</a>
21     <li><a href="http://search.cpan.org/search?dist=Locale-Maketext-Fuzzy">Locale::Maketext::Fuzzy</a>
22     <li><a href="http://search.cpan.org/search?dist=MIME-Entity">MIME::Entity</a>
23     <li><a href="http://search.cpan.org/search?dist=Text-Wrapper">Text::Wrapper</a>
24     <li><a href="http://search.cpan.org/search?dist=Time-ParseDate">Time::ParseDate</a>
25     <li><a href="http://search.cpan.org/search?dist=Term-ReadKey">Term::ReadKey</a>
26     <li><a href="http://search.cpan.org/search?dist=Text-Autoformat">Text::Autoformat</a>
27     <li><a href="http://search.cpan.org/search?dist=Text-Quoted">Text::Quoted</a>
28     <li><a href="http://search.cpan.org/search?dist=Regexp-Common">Regexp::Common</a>
29   </ul>
30
31 <p>Create a new Unix group called 'rt'
32
33 <p><pre>make configure-rt
34 make create-rt
35 make install-rt
36 </pre>
37
38 <p>Add the following to your httpd.conf:
39 <pre>
40 &lt;DirectoryMatch "^/var/www/freeside/rt/.*NoAuth"&gt;
41 &lt;Limit GET POST&gt;
42 allow from all
43 Satisfy any   
44 SetHandler perl-script
45 PerlHandler HTML::Mason
46 &lt;/Limit&gt;
47 &lt;/DirectoryMatch&gt;
48 &lt;DirectoryMatch "^/var/www/freeside/rt/.*NoAuth/images"&gt;
49 SetHandler None
50 &lt;/DirectoryMatch&gt;
51 </pre>
52
53 <p>Set the <b>ticket_system</b> configuration value to <b>RT_Internal</b>.  You may also wish to set <b>ticket_system-default_queueid</b> once you have RT configured.
54
55 <p>Bootstrap RT's permissions:
56   <ul>
57     <li>Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
58     <li>Run <code>freeside-adduser -h /usr/local/etc/freeside/htpasswd root</code> and set a (temporary) password
59     <li>Log into your Freeside installation as the "root" user you just created, by closing your browser or using <code>https://root@yourmachone/freeside/</code> syntax.
60     <li>Click on "Ticketing Main" on the Freeside main menu.  Click on "Configuration", then "Global", and then "User Rights".  Grant the "SuperUser" right to your RT login.
61     <li>Remove the temporary "root" user from /usr/local/etc/freeside/mapsecrets and /usr/local/etc/freeside/htpasswd
62   </ul>
63
64 <p>Follow the <A HREF="http://wiki.bestpractical.com/">regular RT documentation</A> to configure RT, setup the mailgate, etc.
65
66 </body>