Additional SSH Options
Used to supply a String or Array of options to be passed to the SSH command in `:ssh` and `:ssh_daemon` modes.
For example, if you need to supply a specific SSH key for the `ssh_user`, you would set this to: “-i ‘/path/to/id_rsa’”. Which would produce:
rsync -e "ssh -p 22 -i '/path/to/id_rsa'"
Arguments may be single-quoted, but should not contain any double-quotes.
Used only for `:ssh` and `:ssh_daemon` modes.
Mode of operation
Connects to the remote via SSH. Does not use an rsync daemon on the remote.
Connects to the remote via SSH. Spawns a single-use daemon on the remote, which allows certain daemon features (like modules) to be used.
Connects directly to an rsync daemon via TCP. Data transferred is not encrypted.
Path to store the synced backup package file(s) to.
If no host is specified, then path will be local, and the only other used option would be additional_rsync_options. path will be expanded, so ‘~/my_path’ will expand to ‘$HOME/my_path’.
If a host is specified, this will be a path on the host. If mode is `:ssh` (default), then any relative path, or path starting with ‘~/’ will be relative to the directory the ssh_user is logged into. For `:ssh_daemon` or `:rsync_daemon` modes, this would reference an rsync module/path.
In :ssh_daemon and :rsync_daemon modes, the files will be stored directly to the path given. The path (or path defined by your rsync module) must already exist. Note that no additional `<trigger>` directory will be added to this path.
In :ssh mode or local operation (no host specified), the actual destination path will be `<path>/<trigger>/`. This path will be created if needed - either locally, or on the remote for :ssh mode. This behavior will change in v4.0, when :ssh mode and local operations will also store the files directly in the path given.
SSH or RSync port
For `:ssh` or `:ssh_daemon` mode, this specifies the SSH port to use and defaults to 22.
For `:rsync_daemon` mode, this specifies the TCP port to use and defaults to 873.
RSync Password
If specified, Backup will write the password to a temporary file and use it with rsync’s `–password-file` option for daemon authentication.
Note that setting this will override `rsync_password_file`.
Used only for `:ssh_daemon` and `:rsync_daemon` modes.
RSync Password File
If specified, this path will be passed to rsync’s `–password-file` option for daemon authentication.
Used only for `:ssh_daemon` and `:rsync_daemon` modes.
RSync User
If the user running the backup is not the same user that needs to authenticate with the rsync daemon, specify the user here.
Used only for `:ssh_daemon` and `:rsync_daemon` modes.
SSH User
If the user running the backup is not the same user that needs to authenticate with the remote server, specify the user here.
The user must have SSH keys setup for passphrase-less access to the remote. If the SSH User does not have passphrase-less keys, or no default keys in their `~/.ssh` directory, you will need to use the `-i` option in `:additional_ssh_options` to specify the passphrase-less key to use.
Used only for `:ssh` and `:ssh_daemon` modes.
Generated with the Darkfish Rdoc Generator 2.