X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/971df8889b46f314afb6d4e2e052c8ee7738b756..89fa4c9b4dcee1ce34aa95d6981f73071f6450cf:/doc/plugins/404.mdwn?ds=sidebyside diff --git a/doc/plugins/404.mdwn b/doc/plugins/404.mdwn index 8a7ccd7d6..128b26e7b 100644 --- a/doc/plugins/404.mdwn +++ b/doc/plugins/404.mdwn @@ -1,14 +1,24 @@ [[!template id=plugin name=404 author="[[Simon_McVittie|smcv]]"]] -[[!tag type/useful]] +[[!tag type/web]] This plugin lets you use the IkiWiki CGI script as an Apache 404 handler, to give the behaviour of various other wiki engines where visiting a nonexistent page provides you with a link to create it. -To achieve this, put something like this in the wiki's Apache configuration -file: +To enable the 404 handler you need to: - ErrorDocument 404 /ikiwiki.cgi +1. Edit your `.setup` file and add `404` to the `add_plugins` line. +2. Add a 404 error document handler in your Apache configuration: -(The path here needs to be whatever the path is to the ikiwiki.cgi from -the root of your web server.) + `ErrorDocument 404 /url/path/to/ikiwiki.cgi` + + Where `/url/path/to` is the path portion of the URL to the `ikiwiki.cgi` binary. + +This plugin might also be useful on non-Apache web servers, if they provide the +`REDIRECT_STATUS` and `REDIRECT_URL` environment variables to their 404 handlers. +`REDIRECT_STATUS` should be `404` and `REDIRECT_URL` should be the path +part of the URL (for instance it would be `/plugins/404/` if this page was missing). + +If you would like help with adapting this plugin for a different web server, +you will need to provide the output of +[[this 404 handler|forum/nginx:_404_plugin_not_working#comment-6b1607f7961d2873517d4780f56ac3ad]].