preliminary RT docs
authorivan <ivan>
Wed, 9 Mar 2005 08:18:57 +0000 (08:18 +0000)
committerivan <ivan>
Wed, 9 Mar 2005 08:18:57 +0000 (08:18 +0000)
ANNOUNCE.1.5
httemplate/docs/index.html
httemplate/docs/install-rt.html [new file with mode: 0644]
httemplate/docs/install.html

index c8143a8..0be1a93 100644 (file)
@@ -25,7 +25,8 @@
 - historical late notice viewing in web interface
 - VoIP billing for CDRs from RADIUS
 - promotional codes for signup
-- lots of RT integration, integrated RT upgraded to 3.2.2
+- lots of RT integration, integrated RT upgraded to 3.2.2, preliminary RT 
+  add-on docs
 - one-time referral credits
 - invoices now use history records (don't lose details)
 - option to credit for remaining service upon package cancel/change
index d0151ed..4a58441 100644 (file)
@@ -7,6 +7,7 @@
 <h3>Installation and upgrades</h3>
 <ul>
   <li><a href="install.html">New Installation</a>
+  <li><a href="install-rt.html">Installing integrated RT ticketing</a>
   <li><a href="upgrade7.html">Upgrading from 1.3.0 to 1.3.1</a>
   <li><a href="upgrade8.html">Upgrading from 1.3.1 to 1.4.0</a>
   <li><a href="upgrade9.html">Upgrading from 1.4.0 to 1.4.1</a>
diff --git a/httemplate/docs/install-rt.html b/httemplate/docs/install-rt.html
new file mode 100644 (file)
index 0000000..0a82ff5
--- /dev/null
@@ -0,0 +1,66 @@
+<head>
+  <title>Installing integrated RT ticketing</title>
+</head>
+<body>
+<h1>Installing integrated RT ticketing</h1>
+
+<p><i>Integrated ticketing is an new feature and these instructinos are preliminary.  Documentation contributions are welcome.</i>
+
+<p>Perl minimum version 5.8.3 is required.  HTML::Mason is required.
+
+<p>Install the following perl modules:
+  <ul>
+    <li><a href="http://search.cpan.org/search?dist=Apache-Session">Apache::Session</a>
+    <li><a href="http://search.cpan.org/search?dist=HTML-TreeBuilder">HTML::TreeBuilder</a>
+    <li><a href="http://search.cpan.org/search?dist=HTML-FormatText">HTML::FormatText</a>
+    <li><a href="http://search.cpan.org/search?dist=Test-Inline">Test::Inline</a>
+    <li><a href="http://search.cpan.org/search?dist=Class-ReturnValue">Class::ReturnValue</a>
+    <li><a href="http://search.cpan.org/search?dist=DBIx-SearchBuilder">DBIx::SearchBuilder</a>
+    <li><a href="http://search.cpan.org/search?dist=Log-Dispatch">Log::Dispatch</a>
+    <li><a href="http://search.cpan.org/search?dist=Locale-Maketext-Lexicon">Locale::Maketext::Lexicon</a>
+    <li><a href="http://search.cpan.org/search?dist=Locale-Maketext-Fuzzy">Locale::Maketext::Fuzzy</a>
+    <li><a href="http://search.cpan.org/search?dist=MIME-Entity">MIME::Entity</a>
+    <li><a href="http://search.cpan.org/search?dist=Text-Wrapper">Text::Wrapper</a>
+    <li><a href="http://search.cpan.org/search?dist=Time-ParseDate">Time::ParseDate</a>
+    <li><a href="http://search.cpan.org/search?dist=Term-ReadKey">Term::ReadKey</a>
+    <li><a href="http://search.cpan.org/search?dist=Text-Autoformat">Text::Autoformat</a>
+    <li><a href="http://search.cpan.org/search?dist=Text-Quoted">Text::Quoted</a>
+    <li><a href="http://search.cpan.org/search?dist=Regexp-Common">Regexp::Common</a>
+  </ul>
+
+<p>Create a new Unix group called 'rt'
+
+<p><pre>make configure-rt
+make create-rt
+make install-rt
+</pre>
+
+<p>Add the following to your httpd.conf:
+<pre>
+&lt;DirectoryMatch "^/var/www/freeside/rt/.*NoAuth"&gt;
+&lt;Limit GET POST&gt;
+allow from all
+Satisfy any   
+SetHandler perl-script
+PerlHandler HTML::Mason
+&lt;/Limit&gt;
+&lt;/DirectoryMatch&gt;
+&lt;DirectoryMatch "^/var/www/freeside/rt/.*NoAuth/images"&gt;
+SetHandler None
+&lt;/DirectoryMatch&gt;
+</pre>
+
+<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.
+
+<p>Bootstrap RT's permissions:
+  <ul>
+    <li>Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
+    <li>Run <code>freeside-adduser -h /usr/local/etc/freeside/htpasswd root</code> and set a (temporary) password
+    <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.
+    <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.
+    <li>Remove the temporary "root" user from /usr/local/etc/freeside/mapsecrets and /usr/local/etc/freeside/htpasswd
+  </ul>
+
+<p>Follow the <A HREF="http://wiki.bestpractical.com/">regular RT documentation</A> to configure RT, setup the mailgate, etc.
+
+</body>
index 4a89ab3..b7802b9 100644 (file)
@@ -119,46 +119,49 @@ $ su
 </ul>
 <table>
   <tr>
-    <th>Apache::ASP</th><th>Mason</th>
+    <th>Mason (recommended)</th><th>Apache::ASP (deprecated)</th>
   </tr>
   <tr>
+
     <td valign="top"><ul>
       <li>Configure Apache:
 <font size="-1"><pre>
-PerlModule Apache::ASP
-# your freeside document root
+PerlModule HTML::Mason
+# your freeside docuemnt root
 &lt;Directory&nbsp;/var/www/freeside&gt;
 &lt;Files ~ (\.cgi|\.html)&gt;
 AddHandler perl-script .cgi .html
-PerlHandler Apache::ASP
+PerlHandler HTML::Mason
 &lt;/Files&gt;
 &lt;Perl&gt;
-$MLDBM::RemoveTaint = 1;
+require&nbsp;"/usr/local/etc/freeside/handler.pl";
 &lt;/Perl&gt;
-PerlSetVar&nbsp;Global&nbsp;/usr/local/etc/freeside/asp-global/
-PerlSetVar&nbsp;Debug&nbsp;2
-PerlSetVar&nbsp;RequestBinaryRead&nbsp;Off
-# your freeside document root
-PerlSetVar&nbsp;IncludesDir&nbsp;/var/www/freeside
 &lt;/Directory&gt;
 </pre></font>
     </ul></td>
+
     <td valign="top"><ul>
       <li>Configure Apache:
 <font size="-1"><pre>
-PerlModule HTML::Mason
-# your freeside docuemnt root
+PerlModule Apache::ASP
+# your freeside document root
 &lt;Directory&nbsp;/var/www/freeside&gt;
 &lt;Files ~ (\.cgi|\.html)&gt;
 AddHandler perl-script .cgi .html
-PerlHandler HTML::Mason
+PerlHandler Apache::ASP
 &lt;/Files&gt;
 &lt;Perl&gt;
-require&nbsp;"/usr/local/etc/freeside/handler.pl";
+$MLDBM::RemoveTaint = 1;
 &lt;/Perl&gt;
+PerlSetVar&nbsp;Global&nbsp;/usr/local/etc/freeside/asp-global/
+PerlSetVar&nbsp;Debug&nbsp;2
+PerlSetVar&nbsp;RequestBinaryRead&nbsp;Off
+# your freeside document root
+PerlSetVar&nbsp;IncludesDir&nbsp;/var/www/freeside
 &lt;/Directory&gt;
 </pre></font>
     </ul></td>
+
   </tr>
 </table>
 <ul>