Get a Quote   (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

Rsync Services Screen

  3 minute read.

Last Modified 2022-09-20 13:05 EDT

Rsync is a utility that copies data across a network. The Services > Rsync screen has two tabs: Configure and Rsync Module.

Configure Screen

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

ServicesRsyncConfigureScreen

SettingDescription
TCP PortEnter the port rsyncd listens on.
Auxiliary ParametersEnter any additional parameters from rsyncd.conf(5).

Rsync Module Screen

The Rsync Module screen displays a list of current rsync modules configured on the system. When setting up an rsync task you have the option to use either SSH or an rsync module as the

ServicesRsyncModuleScreen

Before an rsync module is configured the Modules screen displays the No RSYNC Modules screen displays with Add RSYNC Modules in the center of the screen. Use either Add RSYNC Modules or Add to configure a module to use as the mode (when you select Module in Rsync Mode).

ServicesNoRsyncModuleScreen

The name of the module or the navigate_next arrow expand the module to display the details of the module.

Rsync Module Details Screen

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

ServicesRsyncModuleDetails

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

Add or Edit Rsync Module Screens

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

ServicesAddRsyncModuleGeneral

SettingDescription
NameEnter a module name that matches the name requested by the rsync client.
PathEnter or uses the arrow_right to the left of folder/mnt to browse to the pool or dataset to store received data.
CommentEnter a description for this module.
EnabledSelect to activate this module for use with Rsync. Leave clear to deactivate the module without completely removing it.

ServicesAddRsyncModuleAccess

SettingDescription
Access ModeSelect the permission level for this rsync module from the dropdown list. Options are Read Only, Write Only, or Read and Write.
Max ConnectionsEnter the maximum number of connections to this module. 0 is unlimited.
UserEnter or select the TrueNAS user account that runs the rsync command during file transfers to and from this module from the dropdown list.
GroupEnter or select the TrueNAS group account that runs the rsync command during file transfers to and from this module from the dropdown list.
Hosts AllowEnter 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 DenyEnter 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.

ServicesAddRsyncModuleOtherOptions

SettingDescription
Auxiliary ParametersEnter any additional parameters from rsyncd.conf(5).

Related Content