]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/plugins/pinger.mdwn
Add ikistrap plugin for ikistrap theme.
[git.ikiwiki.info.git] / doc / plugins / pinger.mdwn
1 [[!template id=plugin name=pinger author="[[Joey]]"]]
2 [[!tag type/special-purpose]]
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.
10 To configure what URLs to ping, use the [[ikiwiki/directive/ping]]
11 [[ikiwiki/directive]].
13 The [[!cpan LWPx::ParanoidAgent]] Perl module is strongly recommended.
14 The [[!cpan LWP]] module can also be used, but is susceptible
15 to server-side request forgery.
17 The [[!cpan Crypt::SSLeay]] perl module is needed to support pinging
18 "https" urls.
20 By default the pinger will try to ping a site for 15 seconds before timing
21 out. This timeout can be changed by setting the `pinger_timeout`
22 configuration setting in the setup file.