note about RT_External
[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><i>There is also support for running this integration against an external RT installation, but it is not (yet) documented.</i>
10
11 <p>Perl minimum version 5.8.3 is required.  HTML::Mason is required.
12
13 <p>Install the following perl modules:
14   <ul>
15     <li><a href="http://search.cpan.org/search?dist=Apache-Session">Apache::Session</a>
16     <li><a href="http://search.cpan.org/search?dist=HTML-TreeBuilder">HTML::TreeBuilder</a>
17     <li><a href="http://search.cpan.org/search?dist=HTML-FormatText">HTML::FormatText</a>
18     <li><a href="http://search.cpan.org/search?dist=Test-Inline">Test::Inline</a>
19     <li><a href="http://search.cpan.org/search?dist=Class-ReturnValue">Class::ReturnValue</a>
20     <li><a href="http://search.cpan.org/search?dist=DBIx-SearchBuilder">DBIx::SearchBuilder</a>
21     <li><a href="http://search.cpan.org/search?dist=Log-Dispatch">Log::Dispatch</a>
22     <li><a href="http://search.cpan.org/search?dist=Locale-Maketext-Lexicon">Locale::Maketext::Lexicon</a>
23     <li><a href="http://search.cpan.org/search?dist=Locale-Maketext-Fuzzy">Locale::Maketext::Fuzzy</a>
24     <li><a href="http://search.cpan.org/search?dist=MIME-Entity">MIME::Entity</a>
25     <li><a href="http://search.cpan.org/search?dist=Text-Wrapper">Text::Wrapper</a>
26     <li><a href="http://search.cpan.org/search?dist=Time-ParseDate">Time::ParseDate</a>
27     <li><a href="http://search.cpan.org/search?dist=Term-ReadKey">Term::ReadKey</a>
28     <li><a href="http://search.cpan.org/search?dist=Text-Autoformat">Text::Autoformat</a>
29     <li><a href="http://search.cpan.org/search?dist=Text-Quoted">Text::Quoted</a>
30     <li><a href="http://search.cpan.org/search?dist=Regexp-Common">Regexp::Common</a>
31   </ul>
32
33 <p>Create a new Unix group called 'rt'
34
35 <p><pre>make configure-rt
36 make create-rt
37 make install-rt
38 </pre>
39
40 <p>Add the following to your httpd.conf:
41 <pre>
42 # replace /var/www/freeside with your freeside document root
43 &lt;DirectoryMatch "^/var/www/freeside/rt/.*NoAuth"&gt;
44 &lt;Limit GET POST&gt;
45 allow from all
46 Satisfy any   
47 SetHandler perl-script
48 PerlHandler HTML::Mason
49 &lt;/Limit&gt;
50 &lt;/DirectoryMatch&gt;
51 # replace /var/www/freeside with your freeside document root
52 &lt;DirectoryMatch "^/var/www/freeside/rt/.*NoAuth/images"&gt;
53 SetHandler None
54 &lt;/DirectoryMatch&gt;
55 # replace /var/www/freeside with your freeside document root
56 &lt;Directory /var/www/freeside/rt/Ticket/Attachment&gt; 
57 SetHandler perl-script 
58 PerlHandler HTML::Mason 
59 &lt;/Directory&gt;
60 </pre>
61
62 <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.
63
64 <p>Bootstrap RT's permissions:
65   <ul>
66     <li>Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
67     <li>Run <code>freeside-adduser -h /usr/local/etc/freeside/htpasswd root</code> and set a (temporary) password
68     <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.
69     <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.
70     <li>Remove the temporary "root" user from /usr/local/etc/freeside/mapsecrets and /usr/local/etc/freeside/htpasswd
71   </ul>
72
73 <p>Follow the <A HREF="http://wiki.bestpractical.com/">regular RT documentation</A> to configure RT, setup the mailgate, etc.
74
75 </body>