diff options
author | Amitai Schlair <schmonz@magnetic-babysitter.(none)> | 2009-08-30 03:02:15 -0400 |
---|---|---|
committer | Amitai Schlair <schmonz@magnetic-babysitter.(none)> | 2009-08-30 03:02:15 -0400 |
commit | c36d2fa896e9ea42c0b6b0135ba04b4f4f60950f (patch) | |
tree | 22f1314d8e974c73bde4970c97d497628f2a1465 /doc/plugins/contrib/rsync.mdwn | |
parent | 5e94e973eeb4ba75d9c37bd801278f686f0977c3 (diff) | |
parent | 517432273b96fc9e6bad9b7667ef6d1b04c699ee (diff) |
Merge branch 'master' of git://github.com/joeyh/ikiwiki
Diffstat (limited to 'doc/plugins/contrib/rsync.mdwn')
-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()`. |