related ideas

[git.ikiwiki.info.git] / doc / plugins / rsync.mdwn

diff --git a/doc/plugins/rsync.mdwn b/doc/plugins/rsync.mdwn
index 9bfe7303e451481db70d4e13d65873ac8c81379f..e488861684241949dd8efa7e89ec007c3817b348 100644 (file)
--- a/doc/plugins/rsync.mdwn
+++ b/doc/plugins/rsync.mdwn
@@ -1,4 +1,5 @@
 [[!template id=plugin name=rsync author="[[schmonz]]"]]
 [[!template id=plugin name=rsync author="[[schmonz]]"]]

+[[!tag type/special-purpose]]

 
 This plugin allows ikiwiki to push generated pages to another host
 by running a command such as `rsync`.
 
 This plugin allows ikiwiki to push generated pages to another host
 by running a command such as `rsync`.


@@ -7,11 +8,12 @@ The command to run is specified by setting `rsync_command` in your setup
 file. The command will be run in your destdir, so something like this
 is a typical command:
 
 file. The command will be run in your destdir, so something like this
 is a typical command:
 

-       rsync => 'rsync -qa --delete . user@host:/path/to/docroot/ --exclude ikiwiki.cgi',
+       rsync_command => 'rsync -qa --delete . user@host:/path/to/docroot/',

 
 If using rsync over ssh, you will need to enable noninteractive ssh login
 to the remote host. It's also a good idea to specify the exact command line
 to be permitted in the remote host's `$HOME/.ssh/authorized_keys`.
 
 
 If using rsync over ssh, you will need to enable noninteractive ssh login
 to the remote host. It's also a good idea to specify the exact command line
 to be permitted in the remote host's `$HOME/.ssh/authorized_keys`.
 

-Be sure to exclude the `ikiwiki.cgi` wrapper from being sent to the remote
-host, as in the above example.
+A typical ikiwiki configuration when using this plugin is to disable cgi
+support, so ikiwiki builds a completely static site that can be served from
+the remote host.