Lighttpd

= Using Request Tracker with lighttpd (via FastCGI, using Mason) =

[http://bestpractical.com/rt/ Best Practical Solutions' Request Tracker] (RT), an enterprise-grade ticketing system which enables a group of people to intelligently and efficiently manage tasks, issues, and requests submitted by a community of users, can be used with Lighttpd.

Setting up RT3 is somewhat similar to [wiki:MasonRecipe using Mason with Lighttpd and FastCGI], apart from some minor configuration differences.

Setting up RT on Lighttpd requires the following: * Satisfy all Perl dependencies for RT * Mason handles the files ending with '/' or '.html' or '.css' or '.js'. * Mason handles 'mail-gateway', required for the RT mail gateway * Mason handles 'Search/Chart', required for charting search results * Mason handles 'Search/Results.rdf', required for RSS feed of search results * Mason handles 'Search/Results.tsv', required for spreadsheet download of search results * Other files statically served by Lighttpd * Required Perl modules load when the FastCGI process starts * Disallow access to .mhtml files

This document assumes you install your Request Tracker in /opt/rt3/

First we need a Mason handler, which is a patched version of the handler that comes with the RT installation. Lighttpd will use this handler via FastCGI. In my setup the handler is called mason_lighttpd_handler.fcgi, the handler does not need to be in any particular location.

{{{
#!perl
#!/usr/bin/perl

1. BEGIN BPS TAGGED BLOCK {{{
3. COPYRIGHT:
5. This software is Copyright (c) 1996-2006 Best Practical Solutions, LLC
6. <jesse@bestpractical.com>
8. (Except where explicitly superseded by other copyright notices)
11. LICENSE:
13. This work is made available to you under the terms of Version 2 of
14. the GNU General Public License. A copy of that license should have
15. been provided with this software, but in any event can be snarfed
16. from www.gnu.org.
18. This work is distributed in the hope that it will be useful, but
19. WITHOUT ANY WARRANTY; without even the implied warranty of
20. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21. General Public License for more details.
23. You should have received a copy of the GNU General Public License
24. along with this program; if not, write to the Free Software
25. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28. CONTRIBUTION SUBMISSION POLICY:
30. (The following paragraph is not intended to limit the rights granted
31. to you to modify and distribute this software under the terms of
32. the GNU General Public License and is only of importance to you if
33. you choose to contribute your changes and enhancements to the
34. community by submitting them to Best Practical Solutions, LLC.)
36. By intentionally submitting any modifications, corrections or
37. derivatives to this work, or any other work intended for use with
38. Request Tracker, to Best Practical Solutions, LLC, you confirm that
39. you are the copyright holder for those contributions and you grant
40. Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
41. royalty-free, perpetual, license to use, copy, create derivative
42. works based on those contributions, and sublicense and distribute
43. those contributions and any derivatives thereof.
45. END BPS TAGGED BLOCK }}}
    package RT::Mason;

use strict;
use vars '$Handler';
use File::Basename;
require ('/opt/rt3/bin/webmux.pl');

1. Enter CGI::Fast mode, which should also work as a vanilla CGI script.
   require CGI::Fast;

my $h;

RT::Init();

while ( my $cgi = CGI::Fast->new ) { # the whole point of fastcgi requires the env to get reset here.. # So we must squash it again
$ENV{'PATH'} = '/bin:/usr/bin';
$ENV{'CDPATH'} = '' if defined $ENV{'CDPATH'};
$ENV{'SHELL'} = '/bin/sh' if defined $ENV{'SHELL'};
$ENV{'ENV'} = '' if defined $ENV{'ENV'};
$ENV{'IFS'} = '' if defined $ENV{'IFS'};

my $uri = $ENV{REQUEST_URI};
    if ($uri =~ /\?/) {
      $uri =~ /^(.*?)\?(.*)/;
      $ENV{PATH_INFO} = $1;
      $ENV{QUERY_STRING} = $2;
    } else {
      $ENV{PATH_INFO} = $uri;
      $ENV{QUERY_STRING} = "";
    }

Module::Refresh->refresh if $RT::DevelMode;
    RT::ConnectToDatabase();

if ( ( !$Handler->interp->comp_exists( $cgi->path_info ) )
        && ( $Handler->interp->comp_exists( $cgi->path_info . "/index.html" ) ) ) {
        $cgi->path_info( $cgi->path_info . "/index.html" );
    }

eval { $Handler->handle_cgi_object($cgi); };
    if ($) {
        $RT::Logger->crit($);
    }
    RT::Interface::Web::Handler->CleanupRequest();

}

1;
}}}

Now we set up the host that we'll use for our RT installation, telling Lighttpd to pass all necessary requests to the site through FastCGI.

{{{
#!python
$HTTP["host"] =~ "site1\.example\.com" { # Specify the documentroot
server.document-root = "/opt/rt3/share/html"

1. Map appropriate files and extensions
   fastcgi.map-extensions = ( ".css" => ".html", ".js" => ".html", "/" => ".html", "mail-gateway" => ".html", "Search/Chart" => ".html", "Search/Results.rdf" => ".html", "Search/Results.tsv" => ".html" )

1. Set Lighttpd to check for an index.html file for each directory
   index-file.names = ( "index.html" )

1. Disallow access to .mhtml files
   url.access-deny = ( ".mhtml" )

setenv.add-environment = (
       "SCRIPT_NAME" => "/",
  )

1. Set up an alias for the /NoAuth/images location
   url.rewrite-once = (
   "^/(?!NoAuth/images/)(.*)" => "/$1",
   )

1. Add trailing slash so attachment downloads work
   url.rewrite-once = (
   "^(.*)/Ticket/Attachment/(.*)" => "/$1/Ticket/Attachment/$2/"
   )

1. Set up FastCGI handler
   fastcgi.server = ( ".html" =>
   ((
   "socket" => "/tmp/rt-fcgi.socket",
   "bin-path" => "/opt/rt3/bin/mason_lighttpd_handler.fcgi",
   "check-local" => "disable",
   "min-procs" => 2,
   "max-procs" => 2
   ))
   )
   }
   }}}

That's it!

The above Lighttpd configuration will start two instances of the Mason handler script, passing requests to them as appropriate.

= Credits =

Justin Hawkins <justin@hawkins.id.au> for the initial [wiki:MasonRecipe Using Mason with Lighttpd (via FastCGI)] write-up.