aboutsummaryrefslogtreecommitdiff
path: root/vendor/rsync_command/README.md
blob: 4b53a5c1481db26dbde2a39a2ca3cf48e0df8bf8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
RsyncCommand
==================================

The gem rsync_command provides a library wrapper around the rsync command line program, with additional support for parallel execution of rsync and configuration of OpenSSH options in the format understood by Capistrano (and Net::SSH).

Installation
------------------------------------

    gem install rsync_command

Usage
------------------------------------

    rsync   = RsyncCommand.new(:logger => logger, :ssh => {:auth_methods => 'publickey'}, :flags => '-a')
    source  = '/source/path'
    servers = ['red', 'green', 'blue']

    rsync.asynchronously(servers) do |server|
      dest = {:user => 'root', :host => server, :path => '/dest/path'}
      rsync.exec(source, dest)
    end

    if rsync.failed?
      puts rsync.failures.join
    end