aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/pinger.mdwn
blob: f9b8e7bcb4efe51774c45e4a891f28e31a4c1463 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
[[!template id=plugin name=pinger author="[[Joey]]"]]
[[!tag type/special-purpose]]

This plugin allows ikiwiki to be configured to hit a URL each time it
updates the wiki. One way to use this is in conjunction with the [[pingee]]
plugin to set up a loosely coupled mirror network, or a branched version of
a wiki. By pinging the mirror or branch each time the main wiki changes, it
can be kept up-to-date.

See the [[ikiwiki/directive/ping]] [[ikiwiki/directive]] page for usage details.

The [[!cpan LWP]] perl module is used for pinging. Or the [[!cpan
LWPx::ParanoidAgent]] perl module is used if available, for added security.
Finally, the [[!cpan Crypt::SSLeay]] perl module is needed to support pinging
"https" urls.

By default the pinger will try to ping a site for 15 seconds before timing
out. This timeout can be changed by setting the `pinger_timeout`
configuration setting in the setup file.