ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / 404.mdwn
1 [[!template id=plugin name=404 author="[[Simon_McVittie|smcv]]"]]
2 [[!tag type/web]]
3
4 This plugin lets you use the IkiWiki CGI script as an Apache 404 handler,
5 to give the behaviour of various other wiki engines where visiting a
6 nonexistent page provides you with a link to create it.
7
8 To enable the 404 handler you need to:
9
10 1. Edit your `.setup` file and add `404` to the `add_plugins` line.
11 2. Add a 404 error document handler in your Apache configuration:
12
13     `ErrorDocument 404 /url/path/to/ikiwiki.cgi`
14
15   Where `/url/path/to` is the path portion of the URL to the `ikiwiki.cgi` binary.
16
17 This plugin might also be useful on non-Apache web servers, if they provide the
18 `REDIRECT_STATUS` and `REDIRECT_URL` environment variables to their 404 handlers.
19 `REDIRECT_STATUS` should be `404` and `REDIRECT_URL` should be the path
20 part of the URL (for instance it would be `/plugins/404/` if this page was missing).
21
22 If you would like help with adapting this plugin for a different web server,
23 you will need to provide the output of
24 [[this 404 handler|forum/nginx:_404_plugin_not_working#comment-6b1607f7961d2873517d4780f56ac3ad]].