Difference between revisions of "Nginx"

From Joomla! Documentation

m (Deleted duplicate header and unnecessary nginx.conf outdent)
(Updated the configuration notation on where configs reside for Ubuntu given prior knowledge of the NGINX packages (member of the nginx team on Launchpad))
(13 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[http://nginx.net/ nginx] is a lightweight web server that powers 7.5% of web servers across all domains[http://en.wikipedia.org/wiki/Nginx#Usage]. Unless you have specific requirements that demand a heavy web server like Apache, you are much better off using nginx.
+
[http://nginx.net/ nginx] is a lightweight web server that powers 11.53% of web servers across all domains[http://en.wikipedia.org/wiki/Nginx#Usage]. Unless you have specific requirements that demand a heavy web server like Apache, you are much better off using nginx.
  
 
Below are instructions on how to get Joomla! running with [http://wiki.nginx.org/PHPFcgiExample nginx and PHP via FastCGI].
 
Below are instructions on how to get Joomla! running with [http://wiki.nginx.org/PHPFcgiExample nginx and PHP via FastCGI].
Line 18: Line 18:
 
== Configure Nginx ==
 
== Configure Nginx ==
 
nginx configuration files reside in:
 
nginx configuration files reside in:
* <tt>/usr/local/nginx/conf/</tt> on Ubuntu
+
* <tt>/etc/nginx/sites-available/</tt> on Ubuntu (for sites running on that nginx instance)
* <tt>/etc/nginx/nginx.conf</tt> on Gentoo
+
* <tt>/etc/nginx/nginx.conf</tt> on Gentoo and Raspbian(= Debian optimized for Raspberry Pi)
 +
 
 +
Here is an sample nginx configuration file joomla.conf that you can reuse over all your nginx enabled-sites
 +
 
  
Here is an sample nginx configuration file.
 
  
 
<pre>
 
<pre>
Line 33: Line 35:
  
 
         root PATH_ON_SERVER;
 
         root PATH_ON_SERVER;
         # Support Clean URLs (aka Search Engine Friendly)
+
        index index.php index.html index.htm default.html default.htm;
 +
         # Support Clean (aka Search Engine Friendly) URLs
 
         location / {
 
         location / {
                 try_files $uri $uri/ /index.php?q=$request_uri;
+
                 try_files $uri $uri/ /index.php?q=$uri&$args;
 
         }
 
         }
  
        index index.php index.html index.htm default.html default.htm;
 
 
         # deny running scripts inside writable directories
 
         # deny running scripts inside writable directories
 
         location ~* /(images|cache|media|logs|tmp)/.*\.(php|pl|py|jsp|asp|sh|cgi)$ {
 
         location ~* /(images|cache|media|logs|tmp)/.*\.(php|pl|py|jsp|asp|sh|cgi)$ {
Line 45: Line 47:
 
         }
 
         }
  
         location ~ .*.php$ {
+
         location ~ \.php$ {
            include /etc/nginx/fastcgi.conf;
 
 
             fastcgi_pass  127.0.0.1:9000;
 
             fastcgi_pass  127.0.0.1:9000;
 
             fastcgi_index index.php;
 
             fastcgi_index index.php;
 
             include fastcgi_params;
 
             include fastcgi_params;
 
             fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
 
             fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
 +
            include /etc/nginx/fastcgi.conf;
 
         }
 
         }
  
Line 87: Line 89:
 
* [http://wiki.nginx.org/Install#Ubuntu_PPA Nginx in Ubuntu]
 
* [http://wiki.nginx.org/Install#Ubuntu_PPA Nginx in Ubuntu]
 
* [http://www.debianadmin.com/howto-install-nginx-webserver-in-debian.html Nginx in Debian]
 
* [http://www.debianadmin.com/howto-install-nginx-webserver-in-debian.html Nginx in Debian]
* [http://www.cyberciti.biz/faq/rhel-fedora-install-configure-nginx-php5/ Nginx in RedHat/Centos]
 
 
* [http://php.net/manual/en/install.fpm.php PHP-FPM installation and configuration]
 
* [http://php.net/manual/en/install.fpm.php PHP-FPM installation and configuration]
 
* [http://wiki.nginx.org/HttpGzipModule GZip in Nginx]
 
* [http://wiki.nginx.org/HttpGzipModule GZip in Nginx]
 
* [http://wiki.nginx.org/HttpRewriteModule Rewrite in Nginx]
 
* [http://wiki.nginx.org/HttpRewriteModule Rewrite in Nginx]
 
* [http://nginx.org/en/docs/http/request_processing.html How nginx processes a request]
 
* [http://nginx.org/en/docs/http/request_processing.html How nginx processes a request]

Revision as of 19:06, 24 October 2012

nginx is a lightweight web server that powers 11.53% of web servers across all domains[1]. Unless you have specific requirements that demand a heavy web server like Apache, you are much better off using nginx.

Below are instructions on how to get Joomla! running with nginx and PHP via FastCGI.

Install nginx[edit]

For Ubuntu, run aptitude install nginx. For other distros, run the corresponding package manager, or see http://wiki.nginx.org/Install.

Install PHP FastCGI[edit]

For Ubuntu, read this excellent page on how to configure PHP and FastCGI for nginx.

For Gentoo, PHP will run as a FastCGI service (fpm), so the nginx server will run PHP asa different process:

# echo "dev-lang/php gd gd2 curl simplexml tokenizer dom tidy sqlite xml fpm cgi" >> /etc/portage/package.use
# emerge php

The default settings of php-fpm are good for most servers. For special configuration visit the PHP FPM site.

Configure Nginx[edit]

nginx configuration files reside in:

  • /etc/nginx/sites-available/ on Ubuntu (for sites running on that nginx instance)
  • /etc/nginx/nginx.conf on Gentoo and Raspbian(= Debian optimized for Raspberry Pi)

Here is an sample nginx configuration file joomla.conf that you can reuse over all your nginx enabled-sites


server {
        listen 80;
        server_name YOUR_DOMAIN;
        server_name_in_redirect off;

        access_log /var/log/nginx/localhost.access_log main;
        error_log /var/log/nginx/localhost.error_log info;

        root PATH_ON_SERVER;
        index index.php index.html index.htm default.html default.htm;
        # Support Clean (aka Search Engine Friendly) URLs
        location / {
                try_files $uri $uri/ /index.php?q=$uri&$args;
        }

        # deny running scripts inside writable directories
        location ~* /(images|cache|media|logs|tmp)/.*\.(php|pl|py|jsp|asp|sh|cgi)$ {
                return 403;
                error_page 403 /403_error.html;
        }

        location ~ \.php$ {
            fastcgi_pass  127.0.0.1:9000;
            fastcgi_index index.php;
            include fastcgi_params;
            fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
            include /etc/nginx/fastcgi.conf;
        }

        # caching of files 
        location ~* \.(ico|pdf|flv)$ {
                expires 1y;
        }

        location ~* \.(js|css|png|jpg|jpeg|gif|swf|xml|txt)$ {
                expires 14d;
        }

}

Pay attention for few things:

  1. The parameter fastcgi_pass is set to 127.0.0.1:9000, corresponding to the port that fpm is configured to listen to. This means you can run the PHP processes on separate servers. On Gentoo, you can find this configuration in /etc/php/fpm-php5.3/php-fpm.conf/
  2. Don't forget to replace YOUR_DOMAIN & PATH_ON_SERVER depend on your domain and the path of Joomla on your server.

GZip support[edit]

If you need GZip compression support, add the following section to the http section of the main nginx configuration file:

        gzip on;
        gzip_http_version 1.1;
        gzip_comp_level 6;
        gzip_min_length 1100;
        gzip_buffers 4 8k;
        gzip_types text/plain application/xhtml+xml text/css application/xml application/xml+rss text/javascript application/javascript application/x-javascr$
        gzip_proxied     any;
        gzip_disable     "MSIE [1-6]\.";

Sources[edit]