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 To configure what URLs to ping, use the [[ikiwiki/directive/ping]]
  11 [[ikiwiki/directive]].
  12
  13 The [[!cpan LWP]] perl module is used for pinging. Or the [[!cpan
  14 LWPx::ParanoidAgent]] perl module is used if available, for added security.
  15 Finally, the [[!cpan Crypt::SSLeay]] perl module is needed to support pinging
  16 "https" urls.
  17
  18 By default the pinger will try to ping a site for 15 seconds before timing
  19 out. This timeout can be changed by setting the `pinger_timeout`
  20 configuration setting in the setup file.