path: root/ikiwiki/directive/ping.mdwn
diff options
Diffstat (limited to 'ikiwiki/directive/ping.mdwn')
1 files changed, 18 insertions, 0 deletions
diff --git a/ikiwiki/directive/ping.mdwn b/ikiwiki/directive/ping.mdwn
new file mode 100644
index 0000000..691c758
--- /dev/null
+++ b/ikiwiki/directive/ping.mdwn
@@ -0,0 +1,18 @@
+The `ping` directive is supplied by the [[!iki plugins/pinger desc=pinger]] plugin.
+This directive 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 [[!iki plugins/pingee desc=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.
+ \[[!ping from=""
+ to=""]]
+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 "to" parameter is the url to ping. The example shows how to ping
+another ikiwiki instance.
+[[!meta robots="noindex, follow"]]