diff options
| author | Amitai Schlair <schmonz@magnetic-babysitter.(none)> | 2009-08-23 15:41:29 -0400 |
|---|---|---|
| committer | Amitai Schlair <schmonz@magnetic-babysitter.(none)> | 2009-08-23 15:41:29 -0400 |
| commit | 0d5a8bc3f060a26069df4c20880888303ff41d55 (patch) | |
| tree | 5c8d7ea85e2a3116ff52035fe21700997921ea36 | |
| parent | 16b0e475487911790fae1b78a89ce94477eb970a (diff) | |
new rsync plugin
| -rw-r--r-- | doc/plugins/contrib/rsync.mdwn | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/plugins/contrib/rsync.mdwn b/doc/plugins/contrib/rsync.mdwn new file mode 100644 index 000000000..71cd63947 --- /dev/null +++ b/doc/plugins/contrib/rsync.mdwn @@ -0,0 +1,21 @@ +[[!template id=plugin name=rsync core=0 author="[[schmonz]]"]] + +[[!template id=gitbranch branch=schmonz author="[[schmonz]]"]] + +This plugin allows ikiwiki to push generated pages to another host +by running a command such as `rsync`. + +### Usage +7. Enable automated SSH key exchange between ikiwiki and the remote + host. [keychain](http://www.gentoo.org/proj/en/keychain/) makes + it easy to use a passphrase-protected key for this purpose. It's + also a good idea to specify the exact command line to be permitted + in the remote host's `$HOME/.ssh/authorized_keys`. +7. Set `rsync_command` in your setup file. If you're using a + passphrase-protected key, then set `rsync_command` to a shell + script which reads `keychain`'s current state before calling + `rsync`. + +### Implementation details +* The plugin relies on a new "postrefresh" hook called at the very end of + `IkiWiki/Render.pm:refresh()`. |