README

   1 yhager's nginx Drupal config:
   2
   3   This is a complete nginx configuration for Drupal[1] sites. It
   4   supports boost, images server and multiple sites. Configuration of
   5   generic components is encapsulated, so you only need to define the
   6   required stuff, like domain name, web root directory etc.
   7
   8   This is a complete nginx configuration that is meant to serve as a
   9   basis for your setup.
  10
  11   [1] http://drupal.org
  12
  13
  14 Features:
  15
  16   * Drupal with clean URL's (of course!)
  17
  18   * Multisite - to add a site, just create a short config file and
  19     reload
  20
  21   * Multiple environments - like staging, development and production
  22     are possible (see example config file)
  23
  24   * Images server for static files and imagecache manipulation (You
  25     would want to override theme_imagecache for this).
  26
  27   * Boost[2] supported - if boost files exist they are used (Boost 5.x
  28     files scheme)
  29
  30   * Gzipped static files are served if they exist (see tne javascript
  31     aggregator module[3]).
  32
  33   * Only allows to run the required PHP files (index.php,
  34     cron.php). The rest require a htpasswd. This provides a level of
  35     protection that is missing from most Drupal installations.
  36
  37   * Large fastcgi timeout - to allow long opeartions to run on PHP,
  38     until PHP times out.
  39
  40   * Use http://localhost/nginx_status to monitor server health, with
  41     tools like munin.
  42
  43   [2] http://drupal.org/project/boost
  44   [3] http://drupal.org/project/javascript_aggregator
  45
  46
  47 Note:
  48
  49   These same settings and instructions would also work for mediawiki
  50   based wiki site. It can be extended to support more platforms (like
  51   wordpress).
  52
  53
  54 Intallation:
  55
  56   # clone
  57   git clone git://github.com/yhager/nginx_drupal
  58
  59   # point nginx conf file to nginx.conf
  60   vi /etc/init.d/nginx     # your distro might have different location
  61
  62   # restart nginx (distro dependant)
  63   /etc/init.d/nginx restart
  64
  65   # make sure you have a php-cgi server running on port 3000
  66   php-cgi -b 127.0.0.1:3000
  67
  68   # create a config file for your site
  69   cp conf/vhosts.d/{example,yoursite}.conf
  70   vi conf/vhosts.d/yoursite.conf
  71
  72   # edit conf/production, conf/staging and conf/dev to point to the directory of each env.
  73   vi conf/{production,staging,dev}
  74
  75
  76   * Running update.php and other protected PHP files
  77
  78     The supplied htaccess uses the user 'user' and the password
  79     'secret'. Be sure to change that using the 'htpasswd' command:
  80
  81     htpasswd -c -b conf/htpasswd user secret
  82
  83
  84   * Adding another site
  85
  86     # Copy conf/example.conf and edit it
  87     cp conf/vhosts.d/{example,anothersite}.conf
  88     vi conf/vhosts.d/anothersite.conf
  89
  90     # reload nginx
  91     /etc/init.d/nginx reload
  92
  93
  94 Troubleshooting:
  95
  96   If you get an error about gzip_static line, either comment it out
  97   (and lose the automatic .gz files match) or recompile nginx with the
  98   '--with-http_gzip_static_module' configuration option.
  99
 100   If you get an error about stub_status module missing, comment those
 101   lines out, or recompile nginx with '--with-http_stub_status_module'
 102   configuration option.
 103
 104
 105 Contribution:
 106
 107   Fork this project on GitHub and send pull requests.
 108
 109
 110 Bugs, Features, Issues:
 111
 112   File a report on the issue tracker:
 113   http://github.com/yhager/nginx_drupal/issues/
 114
 115
 116 Questions:
 117
 118   Send me an e-mail (see LICENSE for my address).