Get a Quote     (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode
TrueNAS.com Software Systems Company Community Security iX Portal Download

  1. Documentation Hub
  2. /
  3. TrueNAS SCALE
  4. /
  5. UI Reference Guide
  6. /
  7. System Settings
  8. /
  9. Services
  10. /
  11. Rsync Services Screen
Edit this page

Rsync Services Screen

  3 minute read.

Last Modified 2022-12-09 13:32 -0500

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.

ServicesRsyncConf

Setting Description
TCP Port Enter the port rsyncd listens on.
Auxiliary Parameters Enter 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 rsync mode.

Before an rsync module is configured, the No RSYNC Modules screen displays. Click Add to configure a module to use as the Rsync Mode when you create an Rsync Task.

ServicesRsyncCreateModule

ServicesRsyncModuleCreated

Click the name of the module or the navigate_next arrow 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.

AddRsyncModuleGeneral

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.

AddRsyncModuleAccess

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.

AddRsyncModuleOtherOptions

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

Related Content