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

Configuring Rsync

  2 minute read.

Last Modified 2022-08-05 11:05 EDT

Rsync is an open source cross-platform file transfer and synchronization utility. It is a fast and secure way to copy data to another system for backup or to migrate data to a new system. Use the default settings unless you require a specific change. Don’t forget to click SAVE after changing any settings.

Log in to the TrueNAS web interface and go to Services > Rsync. Click the edit icon to edit the Rsync settings.

Rsync Configuration Screen

Enter the TCP Port you want Rsync to listen on, then enter any rsyncd.conf(5) Auxiliary Parameters.

RsyncConfigure

Rsync Modules

TrueNAS lists all created modules here.
Use this Rsync Modules list to EDIT or DELETE a module. Click to select a module to edit.

To create a new module, click ADD.

RsyncModule

Name the module and select a Path to store it in. Select an Access Mode and fill out the rest of the fields to your needs.

ServicesRsyncModuleAdd

General

NameDescription
NameEnter the IP address or host name of the system that will store the copy. Use the format username@remote_host if the user name differs on the remote host.
PathBrowse to pool or dataset to store received data.
CommentEnter a description for this module.
EnabledSelect to activate this rsync module. Clear to deactivate but retain module configuration.
Access ModeSelect from dropdown list. Read Only, Write Only, Read and Write.
Max ConnectionsEnter a maximum number of connections. 0 is unlimited.
UserSelect from dropdown list a user to run as during file transfers to and from this module.
GroupSelect from dropdown list a group to run as during file transfers to and from this module.
Hosts AllowEnter a value from rsyncd.conf(5). A list of patterns to match with the host name and IP address of a connecting client. Connection rejected if no patterns match. Separate entries by pressing Enter.
Hosts DenyEnter a value from rsyncd.conf(5). A list of patterns to match with the host name and IP address of a connecting client. Connection rejected when the patterns match. Separate entries by pressing Enter.
Other Options: Auxiliary ParametersEnter any additional parameters from rsyncd.conf(5).
When a Hosts Allow list is defined, only the IPs and hostnames on the list are able to connect to the module.

Related Content