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