X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=doc%2Fplugins%2Frsync.mdwn;h=e488861684241949dd8efa7e89ec007c3817b348;hb=45bd60365252954c31e688ce8207045730744e00;hp=e0ab96d142808a56f35691bf0db1994adca5c225;hpb=f1999df705f22638a6d9d44c728c4282e674b982;p=ikiwiki.git diff --git a/doc/plugins/rsync.mdwn b/doc/plugins/rsync.mdwn index e0ab96d14..e48886168 100644 --- a/doc/plugins/rsync.mdwn +++ b/doc/plugins/rsync.mdwn @@ -1,4 +1,5 @@ [[!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`. @@ -7,12 +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: - rsync => 'rsync -qa --delete . user@host:/path/to/docroot/', + 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`. -A typival ikiwiki configuration when using this plugin is to disable cgi +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.