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         \[[!ping from="http://mywiki.com/"
  11         to="http://otherwiki.com/ikiwiki.cgi?do=ping"]]
  12
  13 The "from" parameter must be identical to the url of the wiki that is doing
  14 the pinging. This is used to prevent ping loops.
  15
  16 The "to" parameter is the url to ping. The example shows how to ping
  17 another ikiwiki instance.
  18
  19 The [[cpan LWP]] perl module is used for pinging. Or the [[cpan
  20 LWPx::ParanoidAgent]] perl module is used if available, for added security.
  21 Finally, the [[cpan Crypt::SSLeay]] perl module is needed to support pinging
  22 "https" urls.
  23
  24 By default the pinger will try to ping a site for 15 seconds before timing
  25 out. This timeout can be changed by setting the `pinger_timeout`
  26 configuration setting in the setup file.