new RT requires Tree::Simple too
[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=Text-Wrapper">Text::Wrapper</a>
25     <li><a href="http://search.cpan.org/search?dist=Time-ParseDate">Time::ParseDate</a>
26     <li><a href="http://search.cpan.org/search?dist=Term-ReadKey">Term::ReadKey</a>
27     <li><a href="http://search.cpan.org/search?dist=Text-Autoformat">Text::Autoformat</a>
28     <li><a href="http://search.cpan.org/search?dist=Text-Quoted">Text::Quoted</a>
29     <li><a href="http://search.cpan.org/search?dist=Regexp-Common">Regexp::Common</a>
30     <li><a href="http://search.cpan.org/search?dist=HTML-Scrubber">HTML::Scrubber</a>
31     <li><a href="http://search.cpan.org/search?dist=Tree-Simple">Tree::Simple</a>
32   </ul>
33
34 <p>Create a new Unix group called 'rt'
35
36 <p>Edit the top-level Makefile, set RT_ENABLED to 1 and set the RT_DOMAIN, RT_TIMEZONE, and FREESIDE_URL variables.
37
38 <p><pre>make configure-rt
39 make create-rt
40 make install-rt
41 </pre>
42
43 <p>Add the following to your httpd.conf:
44 <pre>
45 # replace /var/www/freeside with your freeside document root
46 &lt;DirectoryMatch "^/var/www/freeside/rt/.*NoAuth"&gt;
47 &lt;Limit GET POST&gt;
48 allow from all
49 Satisfy any   
50 SetHandler perl-script
51 PerlHandler HTML::Mason
52 &lt;/Limit&gt;
53 &lt;/DirectoryMatch&gt;
54 # replace /var/www/freeside with your freeside document root
55 &lt;DirectoryMatch "^/var/www/freeside/rt/.*NoAuth/images"&gt;
56 SetHandler None
57 &lt;/DirectoryMatch&gt;
58 # replace /var/www/freeside with your freeside document root
59 &lt;Directory /var/www/freeside/rt/Ticket/Attachment&gt; 
60 SetHandler perl-script 
61 PerlHandler HTML::Mason 
62 &lt;/Directory&gt;
63 </pre>
64
65 <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.
66
67 <p>Bootstrap RT's permissions:
68   <ul>
69     <li>Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
70     <li>Run <code>freeside-adduser -h /usr/local/etc/freeside/htpasswd root</code> and set a (temporary) password
71     <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.
72     <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.
73     <li>Remove the temporary "root" user from /usr/local/etc/freeside/mapsecrets and /usr/local/etc/freeside/htpasswd
74   </ul>
75
76 <p>Follow the <A HREF="http://wiki.bestpractical.com/">regular RT documentation</A> to configure RT, setup the mailgate, etc.
77
78 </body>