patch plugin documentation to refer to directive pages
[ikiwiki.git] / doc / plugins / pinger.mdwn
1 [[!template id=plugin name=pinger author="[[Joey]]"]]
2 [[!tag type/special-purpose]]
3
4 This plugin allows ikiwiki to be configured to hit a URL each time it
5 updates the wiki. One way to use this is in conjunction with the [[pingee]]
6 plugin to set up a loosely coupled mirror network, or a branched version of
7 a wiki. By pinging the mirror or branch each time the main wiki changes, it
8 can be kept up-to-date.
9
10 See the [[ikiwiki/directive/ping]] [[ikiwiki/directive]] page for usage details.
11
12 The [[!cpan LWP]] perl module is used for pinging. Or the [[!cpan
13 LWPx::ParanoidAgent]] perl module is used if available, for added security.
14 Finally, the [[!cpan Crypt::SSLeay]] perl module is needed to support pinging
15 "https" urls.
16
17 By default the pinger will try to ping a site for 15 seconds before timing
18 out. This timeout can be changed by setting the `pinger_timeout`
19 configuration setting in the setup file.