ikiwiki/doc/plugins/404.mdwn

[[!template id=plugin name=404 author="[[Simon_McVittie|smcv]]"]]
[[!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 enable the 404 handler you need to:

1. Edit your `.setup` file and add `404` to the `add_plugins` line.
2. Add a 404 error document handler in your Apache configuration:

    `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]].
rename apache404 -> 404 This may already work with other web servers that have copied apache's interface, and it should be easy to add support to it for web servers that use some other interface. So, make the name more general. 2009-02-01 01:26:36 +01:00			`[[!template id=plugin name=404 author="[[Simon_McVittie\|smcv]]"]]`
plugin tag reorg 2010-02-12 09:38:00 +01:00			`[[!tag type/web]]`
Add tip explaining how to use ikiwiki as a 404 handler 2009-01-31 19:27:54 +01:00
Split apache404 into an independent plugin Also make it ignore the 'do' parameter at Joey's suggestion, to have one less thing to remember when configuring. 2009-01-31 23:32:10 +01:00			`This plugin lets you use the IkiWiki CGI script as an Apache 404 handler,`
Add tip explaining how to use ikiwiki as a 404 handler 2009-01-31 19:27:54 +01:00			`to give the behaviour of various other wiki engines where visiting a`
			`nonexistent page provides you with a link to create it.`

2011-06-08 21:17:32 +02:00			`To enable the 404 handler you need to:`
Add tip explaining how to use ikiwiki as a 404 handler 2009-01-31 19:27:54 +01:00
404 automatically loads goto 2011-06-08 21:31:16 +02:00			1. Edit your `.setup` file and add `404` to the `add_plugins` line.
2011-06-08 21:17:32 +02:00			`2. Add a 404 error document handler in your Apache configuration:`
note about path 2009-02-05 21:31:37 +01:00
2011-06-08 21:17:32 +02:00			`ErrorDocument 404 /url/path/to/ikiwiki.cgi`
add instruction of lighttpd 2009-02-11 07:56:01 +01:00
2011-06-08 21:17:32 +02:00			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`
comments on interop with other servers 2011-06-04 18:18:31 +02:00			`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).
add instruction of lighttpd 2009-02-11 07:56:01 +01:00
comments on interop with other servers 2011-06-04 18:18:31 +02:00			`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]].`