ikiwiki/doc/plugins/pinger.mdwn

21 lines
915 B
Plaintext
Raw Normal View History

[[!template id=plugin name=pinger author="[[Joey]]"]]
[[!tag type/special-purpose]]
2008-05-07 01:06:53 +02:00
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.
2008-09-12 00:29:07 +02:00
To configure what URLs to ping, use the [[ikiwiki/directive/ping]]
[[ikiwiki/directive]].
2008-05-07 01:06:53 +02:00
The [[!cpan LWP]] perl module is used for pinging. Or the [[!cpan
2008-05-07 01:06:53 +02:00
LWPx::ParanoidAgent]] perl module is used if available, for added security.
Finally, the [[!cpan Crypt::SSLeay]] perl module is needed to support pinging
2008-05-07 01:06:53 +02:00
"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.