Rsync

Last modified: 21 June 2023

Required plugins: FTP/SFTP/WebDAV Connectivity

Use this page to configure the settings for Rsync, which facilitates downloading and uploading files to an SFTP server in a remote server configuration.

  • On macOS and Linux, the rsync and ssh tools are preinstalled and their paths are filled automatically.

  • On Windows, you need to manually install Cygwin with the rsync and openssh packages first. The tools' executables are commonly located in the <Cygwin installation>\bin folder.

note

Rsync is used for upload and download operations. All other deployment-related operations, including accessing files on a remote host, comparing deployed files and folders with their local versions, and so on, are performed via SFTP.

Item

Description

Rsync executable path

In this field, provide the path to the rsync executable.

Rsync options

Use this field to override the Rsync command-line parameters if necessary.

By default, the -zar options are used, so that Rsync will compress the transferred data (z), preserve permissions, ownership, and timestamps of transferred files and folders (a), and recurse into subdirectories (r).

For the complete list of available options, refer to the Rsync documentation.

Shell executable path

In this field, provide the path to the ssh executable.

Test Connection

Click this button to validate the provided settings and make sure that IntelliJ IDEA can properly communicate with Rsync.

See also

Procedures

Reference