aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/pingee.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/pingee.mdwn')
-rw-r--r--doc/plugins/pingee.mdwn11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/plugins/pingee.mdwn b/doc/plugins/pingee.mdwn
new file mode 100644
index 000000000..6156c235f
--- /dev/null
+++ b/doc/plugins/pingee.mdwn
@@ -0,0 +1,11 @@
+[[!template id=plugin name=pingee author="[[Joey]]"]]
+[[!tag type/special-purpose]]
+
+This plugin causes ikiwiki to listen for pings, typically delivered from
+another ikiwiki instance using the [[pinger]] plugin. When a ping is
+received, ikiwiki will update the wiki, the same as if `ikiwiki --refresh`
+were ran at the command line.
+
+An url such as the following is used to trigger a ping:
+
+ http://mywiki.com/ikiwiki.cgi?do=ping