Nginx and Perl-FastCGI on Ubuntu 9.10 (Karmic)

The nginx web server is a fast, lightweight server designed to efficiently handle the needs of both low and high traffic websites. Although commonly used to serve static content, it’s quite capable of handling dynamic pages as well. This guide will help you get nginx up and running with Perl and FastCGI on your Ubuntu 9.10 (Karmic) Linode.

It is assumed that you’ve already followed the steps outlined in our getting started guide. These steps should be performed via a root login to your Linode over SSH.

Basic System Configuration

Issue the following commands to set your system hostname, substituting a unique value for “hostname.” :

echo "hostname" > /etc/hostname
hostname -F /etc/hostname

Edit your /etc/hosts file to resemble the following, substituting your Linode’s public IP address for 12.34.56.78, your hostname for “hostname,” and your primary domain name for “example.com.” :

File: /etc/hosts

1 2	127.0.0.1 localhost.localdomain localhost 12.34.56.78 hostname.example.com hostname

Install Required Packages

Make sure you have the “universe” repositories enabled in /etc/apt/sources.list. Your file should resemble the following:

File: /etc/apt/sources.list

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

## main & restricted repositories deb http://us.archive.ubuntu.com/ubuntu/ karmic main restricted deb-src http://us.archive.ubuntu.com/ubuntu/ karmic main restricted deb http://security.ubuntu.com/ubuntu karmic-security main restricted deb-src http://security.ubuntu.com/ubuntu karmic-security main restricted ## universe repositories deb http://us.archive.ubuntu.com/ubuntu/ karmic universe deb-src http://us.archive.ubuntu.com/ubuntu/ karmic universe deb http://us.archive.ubuntu.com/ubuntu/ karmic-updates universe deb-src http://us.archive.ubuntu.com/ubuntu/ karmic-updates universe deb http://security.ubuntu.com/ubuntu karmic-security universe deb-src http://security.ubuntu.com/ubuntu karmic-security universe

Issue the following commands to update your system and install the nginx web server and compiler tools (Perl should already be installed):

apt-get update
apt-get upgrade
apt-get install nginx build-essential psmisc wget libfcgi-perl curl
echo "console output" >> /etc/init.d/nginx
/etc/init.d/nginx start

Configure Your Site

In this guide, we’ll be using the domain “example.com” as our example site. You should substitute your own domain name in the configuration steps that follow. First, we’ll need to create directories to hold our content and log files:

mkdir -p /srv/www/www.example.com/public_html
mkdir /srv/www/www.example.com/logs
chown -R www-data:www-data /srv/www/www.example.com

Next, you’ll need to define the site’s virtual host file:

File: /etc/nginx/sites-available/www.example.com

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

server { listen 80; server_name www.example.com example.com; access_log /srv/www/www.example.com/logs/access.log; error_log /srv/www/www.example.com/logs/error.log; location / { root /srv/www/www.example.com/public_html; index index.html index.htm; } location ~ \.pl$ { gzip off; include /etc/nginx/fastcgi_params; fastcgi_pass 127.0.0.1:8999; fastcgi_index index.pl; fastcgi_param SCRIPT_FILENAME /srv/www/www.example.com/public_html$fastcgi_script_name; } }

Issue the following commands to enable the site:

cd /etc/nginx/sites-enabled/
ln -s /etc/nginx/sites-available/www.example.com
/etc/init.d/nginx restart

You may wish to create a test HTML page under /srv/www/www.example.com/public_html/ and view it in your browser to verify that nginx is properly serving your site (Perl will not work yet). Please note that this will require an entry in DNS pointing your domain name to your Linode’s IP address (found on the Networking tab in the Linode Cloud Manager).

Configure spawn-fcgi

Install the Perl module for FastCGI using the CPAN Minus interface for CPAN. Install CPAN Minus and FCGI by issuing the following sequence of commands:

cd /opt/
curl https://github.com/miyagawa/cpanminus/raw/master/cpanm > cpanm
chmod +x cpanm
ln -s /opt/cpanm /usr/bin/
cpanm --self-upgrade --sudo
cpanm --sudo FCGI

Issue the following command sequence to download the FastCGI wrapper script (credit: Denis S. Filimonov) and an init script to control the FastCGI process, set the permissions, launch the wrapper for the first time, and ensure that FastCGI launches at startup:

cd /opt/
wget -O fastcgi-wrapper http://www.linode.com/docs/assets/638-fastcgi-wrapper.sh
wget -O init-deb.sh http://www.linode.com/docs/assets/637-init-deb.sh
mv /opt/fastcgi-wrapper /usr/bin/fastcgi-wrapper.pl
mv /opt/init-deb.sh /etc/init.d/perl-fastcgi
chmod +x /usr/bin/fastcgi-wrapper.pl
chmod +x /etc/init.d/perl-fastcgi
update-rc.d perl-fastcgi defaults
/etc/init.d/perl-fastcgi start

Test Perl with FastCGI

Create a file called “test.pl” in your site’s “public_html” directory with the following contents:

File: /srv/www/www.example.com/public\\_html/test.pl

1 2 3 4 5 6 7 8 9 10 11 12 13 14

#!/usr/bin/perl print "Content-type:text/html\n\n"; print <<EndOfHTML; <html><head><title>Perl Environment Variables</title></head> <body> <h1>Perl Environment Variables</h1> EndOfHTML foreach $key (sort(keys %ENV)) { print "$key = $ENV{$key}<br>\n"; } print "</body></html>";

Make the script executable by issuing the following command:

chmod +x /srv/www/www.example.com/public_html/test.pl

When you visit http://www.example.com/test.pl in your browser, your Perl environment variables should be shown. Congratulations, you’ve configured the nginx web server to use Perl with FastCGI for dynamic content!

More Information

You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, please note that we cannot vouch for the accuracy or timeliness of externally hosted materials.

• The NGINX Homepage
• FastCGI Project Homepage
• Perl Documentation
• Installing NGINX on Ubuntu 9.10 (Karmic)
• Basic NGINX Configuration