update instructions to work with new debian apache packages
[ikiwiki.git] / 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 * Make sure the cgi module is loaded. (Ie, `a2enmod cgi`)
19
20 * Edit /etc/apache2/apache2.conf (or /etc/apache2/mods-available/mime.conf)
21   and add a line like this:
22
23         AddHandler cgi-script .cgi
24
25 * Find the "Options" line for the directory where you've put the
26   ikiwiki.cgi, and add "ExecCGI" to the list of options. For example, if
27   ikiwiki.cgi is in /var/www/, edit `/etc/apache2/sites-enabled/000-default`
28   and add it to the "Options" line in the "Directory /var/www/" stanza.
29   Or, if you've put it in a `~/public_html`, edit
30   `/etc/apache2/mods-available/userdir.conf`.
31
32 * If your wiki is in `~/public_html` and does not appear when you enter the URL given by the installer, check that you have 
33   the userdir mod enabled (there should be simlinks to userdir.load and userdir.conf in /etc/apache2/modes-enabled).  If not,
34   run `a2enmod userdir` and reload apache2.
35   
36 * You may also want to enable the [[plugins/404]] plugin.
37   To make apache use it, the apache config file will need a further
38   modification to make it use ikiwiki's CGI as the apache 404 handler.
39   Something like this, with the path adjusted to where you've put the CGI:
40
41         ErrorDocument 404 /cgi-bin/ikiwiki.cgi
42
43 ## lighttpd
44
45 Here is how to enable cgi on [lighttpd](http://www.lighttpd.net/) and
46 configure it in order to execute ikiwiki.cgi wherever it is located. 
47
48 * 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)). 
49
50 * Create `/etc/lighttpd/conf-available/90-ikiwiki-cgi.conf` and add a line like this:
51
52     cgi.assign = ( "ikiwiki.cgi"  => "", )
53
54 * Activate ikiwiki-cgi by linking `/etc/lighttpd/conf-available/90-ikiwiki-cgi.conf` into `/etc/lighttpd/conf-enabled`. 
55
56 * Restart lighttpd server with something like `/etc/init.d/lighttpd restart`.
57
58 Note that the first part enables cgi server wide but depending on default
59 configuration, it may be not enough. The second part creates a specific
60 rule that allow `ikiwiki.cgi` to be executed.
61
62 **Warning:** I only use this lighttpd configuration on my development
63 server (offline). I am not sure of how secure this approach is.
64 If you have any thought about it, feel free to let me know.
65
66 ## nginx
67
68 To run CGI under nginx, you need to use a FastCGI wrapper. The wrapper must be started somehow just like any other FastCGI program. You can use launchd on OSX.
69
70 In Linux, you will need the spawn-fcgi and fcgiwrap packages and start
71 them with:
72
73     spawn-fcgi -s /tmp/fcgi.socket -n -- /usr/sbin/fcgiwrap
74
75 This needs to be ran as your user. It can be added to `inittab` or
76 made into a startup script in `init.d`. You may also need to make this file writable by the webserver, if that's running as a different user, e.g.:
77
78     chmod a+w /tmp/fcgi.socket
79
80 Then you need an nginx config plugged in that wrapper. Here's an
81 example virtual host configuration:
82
83     server {
84         #listen   80; ## listen for ipv4; this line is default and implied
85         #listen   [::]:80 default_server ipv6only=on; ## listen for ipv6
86
87         root /home/anarcat/public_html/wiki.reseaulibre.ca/;
88         index index.html index.htm;
89
90         # Make site accessible from http://localhost/
91         server_name wiki.reseaulibre.ca;
92
93         location / {
94                 try_files $uri $uri/ /index.html;
95         }
96         location /ikiwiki.cgi {
97                 fastcgi_pass  unix:/tmp/fcgi.socket;
98                 fastcgi_index ikiwiki.cgi;
99                 fastcgi_param SCRIPT_FILENAME   /home/anarcat/public_html/ikiwiki.cgi;
100                 fastcgi_param  DOCUMENT_ROOT      /home/anarcat/public_html/wiki.reseaulibre.ca;
101                 include /etc/nginx/fastcgi_params;
102         }
103     }
104
105 Also, note that the `/tmp/fcgi.socket` file needs to be writable by the webserver. I am also unsure as to the security of this setup, as I am using this only on my dev server. Needless to say that [[real fastcgi support|todo/fastcgi_or_modperl_installation_instructions]] would be great. ;) --[[anarcat]]
106
107 ## boa
108
109 Edit /etc/boa/boa.conf and make sure the following line is not commented:
110
111     AddType application/x-httpd-cgi cgi