aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/pinger.mdwn
blob: f37979ac68f7d19c14699970f068f74e28b66162 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
[[!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.

To configure what URLs to ping, use the [[ikiwiki/directive/ping]]
[[ikiwiki/directive]].

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 [[!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.