doc/tips/dot_cgi.mdwn

   1 It's common to name the [[cgi]] "ikiwiki.cgi", and put it somewhere
   2 like `~/public_html/ikiwiki.cgi`, or `/var/www/wiki/ikiwiki.cgi`.
   3
   4 If you do that, you may find that when trying to edit a page in your wiki,
   5 you see the raw contents of the ikiwiki.cgi program. Or get a permission
   6 denied problem.
   7
   8 This is because web servers are generally not configured to run cgi scripts
   9 unless they're in `/usr/lib/cgi-bin/`. While you can put ikiwiki.cgi in
  10 there if you like, it's better to configure your web server to
  11 run `.cgi`  programs from anywhere.
  12
  13 These instructions are for Debian systems, but the basic
  14 configuration changes should work anywhere.
  15
  16 ## apache 2
  17
  18 * Edit /etc/apache2/apache2.conf and add a line like this:
  19
  20         AddHandler cgi-script .cgi
  21
  22 * Find the "Options" line for the directory where you've put the
  23   ikiwiki.cgi, and add "ExecCGI" to the list of options. For example, if
  24   ikiwiki.cgi is in /var/www/, edit `/etc/apache2/sites-enabled/000-default`
  25   and add it to the "Options" line in the "Directory /var/www/" stanza.
  26   Or, if you've put it in a `~/public_html`, edit
  27   `/etc/apache2/mods-available/userdir.conf`.
  28
  29 You may also want to enable the [[plugins/apache404]]
  30 plugin. To make apache use it, the apache config file
  31 will need a further modification to make it use ikiwiki's CGI
  32 as the apache 404 handler. Something like this, with
  33 the path adjusted to where you've put the CGI:
  34
  35         ErrorDocument 404 /cgi-bin/ikiwiki.cgi
  36
  37 ## lighttpd
  38
  39 Here is how to enable cgi on [lighttpd](http://www.lighttpd.net/) and
  40 configure it in order to execute ikiwiki.cgi wherever it is located.
  41
  42 * Activate cgi by linking `/etc/lighttpd/conf-available/10-cgi.conf` into `/etc/lighttpd/conf-enabled` ([doc](http://trac.lighttpd.net/trac/wiki/Docs%3AModCGI)).
  43
  44 * Create `/etc/lighttpd/conf-available/90-ikiwiki-cgi.conf` and add a line like this:
  45
  46     cgi.assign = ( "ikiwiki.cgi"  => "", )
  47
  48 * Activate ikiwiki-cgi by linking `/etc/lighttpd/conf-available/90-ikiwiki-cgi.conf` into `/etc/lighttpd/conf-enabled`.
  49
  50 * Restart lighttpd server with something like `/etc/init.d/lighttpd restart`.
  51
  52 Note that the first part enables cgi server wide but depending on default
  53 configuration, it may be not enough. The second part creates a specific
  54 rule that allow `ikiwiki.cgi` to be executed.
  55
  56 **Warning:** I only use this on my development server (offline). I am not
  57 sure of how secure this approach is. If you have any thought about it, feel
  58 free to let me know.