Rsync Services Screen

This service is not needed when rsync is configured externally with SSH or with the TrueNAS built-in rsync task in SSH mode. It is always recommended to use rsync with SSH as a security best practice.

Rsync is a utility that copies data across a network. This service configures and enables an rsync server that other remote systems can access as part of a remote sync operation. The Services > Rsync screen has two tabs: Configure and Rsync Module.

The Rsync > Configure screen displays the TCP Port and Auxiliary Parameters settings.

The Rsync Module screen displays a list of current rsync modules configured on the system.

Before an rsync module is configured, the No RSYNC Modules screen displays. Click Add to configure a module to use when the Rsync service is active.

Click the name of the module or the navigate_next arrow to display the details of the module.

The rsync module details screen displays connections, user, group, allow and deny host information, and any auxiliary parameters configured for that module.

Click Here for More Information expand

Edit opens the Edit Rsync Module screen. Delete opens a confirmation dialog.

Rsync > Add and Rsync > Edit screens specify the general, access and other settings for the rsync module.

Click Here for More Information expand

Setting	Description
Name	Enter a module name that matches the name requested by the rsync client.
Path	Enter or uses the arrow_right to the left of folder/mnt to browse to the pool or dataset to store received data.
Comment	Enter a description for this module.
Enabled	Select to activate this module for use with Rsync. Leave clear to deactivate the module without completely removing it.

Setting	Description
Access Mode	Select the permission level for this rsync module from the dropdown list. Options are Read Only, Write Only, or Read and Write.
Max Connections	Enter the maximum number of connections to this module. 0 is unlimited.
User	Enter or select the TrueNAS user account that runs the rsync command during file transfers to and from this module from the dropdown list.
Group	Enter or select the TrueNAS group account that runs the rsync command during file transfers to and from this module from the dropdown list.
Hosts Allow	Enter a list of patterns to match with the host name and IP address of a connecting client (from rsyncd.conf(5). The connection is rejected if no patterns match. Separate entries by pressing Enter.
Hosts Deny	Enter a list of patterns to match with the hostname and IP address of a connecting client (from rsyncd.conf(5). The connection is rejected when the patterns match. Separate entries by pressing Enter.

Setting	Description
Auxiliary Parameters	Enter any additional parameters from rsyncd.conf(5).

Related Content

• Adding SSH Credentials
• Configuring Rsync Tasks
• Rsync Tasks Screens
• Configuring Rsync Modules
• Rsync
• Rsyncd