X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/b144831e462e0d2ba8225f6e5f7d9138efb03c77..e112b8f385992ec4b3056d397802abe092547bb5:/doc/plugins/pinger.mdwn diff --git a/doc/plugins/pinger.mdwn b/doc/plugins/pinger.mdwn index f747a9f0b..f37979ac6 100644 --- a/doc/plugins/pinger.mdwn +++ b/doc/plugins/pinger.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=pinger author="[[Joey]]"]] -[[tag type/special-purpose]] +[[!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]] @@ -7,18 +7,14 @@ 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. - \[[!ping from="http://mywiki.com/" - to="http://otherwiki.com/ikiwiki.cgi?do=ping"]] +To configure what URLs to ping, use the [[ikiwiki/directive/ping]] +[[ikiwiki/directive]]. -The "from" parameter must be identical to the url of the wiki that is doing -the pinging. This is used to prevent ping loops. +The [[!cpan LWPx::ParanoidAgent]] Perl module is strongly recommended. +The [[!cpan LWP]] module can also be used, but is susceptible +to server-side request forgery. -The "to" parameter is the url to ping. The example shows how to ping -another ikiwiki instance. - -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 +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