doc/plugins/contrib/rsync.mdwn

   1 [[!template id=plugin name=rsync core=0 author="[[schmonz]]"]]
   2
   3 [[!template id=gitbranch branch=schmonz author="[[schmonz]]"]]
   4
   5 This plugin allows ikiwiki to push generated pages to another host
   6 by running a command such as `rsync`.
   7
   8 ### Usage
   9 7. Enable automated SSH key exchange between ikiwiki and the remote
  10    host. [keychain](http://www.gentoo.org/proj/en/keychain/) makes
  11    it easy to use a passphrase-protected key for this purpose. It's
  12    also a good idea to specify the exact command line to be permitted
  13    in the remote host's `$HOME/.ssh/authorized_keys`.
  14 7. Set `rsync_command` in your setup file. If you're using a
  15    passphrase-protected key, then set `rsync_command` to a shell
  16    script which reads `keychain`'s current state before calling
  17    `rsync`.
  18
  19 ### Implementation details
  20 * The plugin relies on a new "postrefresh" hook called at the very end of
  21   `IkiWiki/Render.pm:refresh()`.