doc/plugins/rsync.mdwn

   1 [[!template id=plugin name=rsync author="[[schmonz]]"]]
   2
   3 This plugin allows ikiwiki to push generated pages to another host
   4 by running a command such as `rsync`.
   5
   6 The command to run is specified by setting `rsync_command` in your setup
   7 file. The command will be run in your destdir, so something like this
   8 is a typical command:
   9
  10         rsync => 'rsync -qa --delete . user@host:/path/to/docroot/',
  11
  12 If using rsync over ssh, you will need to enable noninteractive ssh login
  13 to the remote host. It's also a good idea to specify the exact command line
  14 to be permitted in the remote host's `$HOME/.ssh/authorized_keys`.
  15
  16 A typical ikiwiki configuration when using this plugin is to disable cgi
  17 support, so ikiwiki builds a completely static site that can be served from
  18 the remote host.