README.markdown

   1 # Overview #
   2
   3 This is a complete nginx configuration for [Drupal](http://drupal.org) sites. It supports boost, images server and multiple sites. Configuration of generic components is encapsulated, so you only need to define the required stuff, like domain name, web root directory etc.
   4
   5 This is a complete nginx configuration that is meant to serve as a basis for your setup.
   6
   7 # Features #
   8
   9 * Drupal with clean URL's (of course!)
  10 * Multisite - to add a site, just create a short config file and reload
  11 * Multiple environments - like staging, development and production are possible (see example config file)
  12 * Images server for static files and imagecache manipulation (You would want to override theme_imagecache for this).
  13 * [Boost](http://drupal.org/project/boost) supported - if boost files exist they are used (Boost 5.x files scheme)
  14 * Gzipped static files are served if they exist (see [javascript aggregator module](http://drupal.org/project/javascript_aggregator).
  15 * Only allows to run the required PHP files (index.php, cron.php). The rest require a htpasswd. This provides a level of protection that is missing from most Drupal installations.
  16 * Large fastcgi timeout - to allow long opeartions to run on PHP, until PHP times out.
  17 * Use http://localhost/nginx_status to monitor server health, with tools like munin.
  18
  19 # Intallation #
  20
  21 * Clone this project, and point nginx conf file to nginx.conf (usually by editing  /etc/init.d/nginx, but that depends on your distribution).
  22 * Make sure you have a fastcgi server (php-cgi mostly) running and listening on port 3000 (or change the port in conf/fastcgi)
  23 * copy the file conf/example.conf to conf/yoursite.conf (must keep the .conf suffix) and edit to your needs.
  24 * Modify the files conf/production, conf/staging and conf/dev to point to the directory of each env.
  25
  26 ## Adding another site ##
  27
  28 Copy conf/example.conf and edit it to match the new site settings
  29
  30 # Troubleshooting
  31
  32 If you get an error about gzip_static line, either comment it out (and lose the automatic .gz files match) or recompile nginx with the '--with-http_gzip_static_module' configuration option.
  33
  34 If you get an error about stub_status module missing, comment those lines out, or recompile nginx with '--with-http_stub_status_module' configuration option.
  35
  36 If you want logs file not to be in the same directory as in the configuration file, create a symlink to the logs directory, something like:
  37 # ln -s /var/logs/nginx conf/logs
  38
  39 # Contribution
  40
  41   Fork this project on GitHub and send pull requests.
  42
  43 # Bugs, Features, Issues
  44
  45   File a report on the issue tracker:
  46   [http://github.com/yhager/nginx_drupal/issues/](http://github.com/yhager/nginx_drupal/issues/)
  47
  48 # Questions
  49
  50   Send me an e-mail (see LICENSE for my address).