Get a Quote 408 9434100 Commercial Support
TrueNAS SCALE 22.12/SCALE Tutorials/System Settings/Services/Configuring Rsync Modules
This content follows the TrueNAS SCALE 22.12 Bluefin) releases. Use the Product and Version selectors above to view content
specific to different TrueNAS software or major version.
Configuring Rsync Modules
SCALE 22.12.3 deprecates several built-in features. SCALE 23.10 replaces deprecated features with
applications that perform their roles. See SCALE Feature Deprecations for more details about feature
deprecation and replacement.
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.
When necessary to enable an rsync server with modules, go to Apps > Available Applications and install the
new rsyncd application.
Rsync is a utility that copies data across a network. The Services > Rsync screen has two tabs: Configure and
Rsync Module. Use the Configure screen to add the TCP port number for the rsync service. Port 22 is
reserved for TrueNAS.
Use the Rsync Module screen to configure an rsync module on a TrueNAS system. You must configure at least
one rsync module for the service to function.
Adding an Rsync Module TCP Port
Go to Services and click the Configure icon for Rsync to open the Configure screen.
Figure 1 Services Rsync Configure Screen
Enter a new port number if not the default in TCP Port. This is the port the rsync server listens on.
Enter any additional parameters from [Link](5 you want to use in Auxiliary Parameters.
Click Save.
Adding an Rsync Module
To configure an rsync module click Add or Add Rsync Modules on the Services > Rsync > Rsync Module
Documentation
screen. Hub
Figure 2 Rsync Module No Rsync Module
Click either Add RSYNC Modules if a remote module does not exist, or Add to open the Add Rsync screen to
configure a module to use as the mode.
Figure 3 Services Add Rsync Module General Settings
Enter a name, and then either enter the path or use the to the left of /mnt to browse to the pool or
dataset to store received data. Click on the dataset or zvol name to populate the path field. To collapse the
dataset tree, click the to the left of /mnt again.
Select Enable to activate the module for use with the rsync service.
Documentation Hub
Figure 4 Services Add Rsync Module Access Settings
Select the permission access level in Access Mode.
Select the user and group that runs the rsync command during file transfer to and from this module.
Enter any allow and or deny hosts. Separate multiple entries by pressing Enter after each entry in Hosts Allow
and/or Hosts Deny.
When a Hosts Allow list is defined, only the IPs and hostnames on the list are able to connect to the
module.
Figure 5 Services Add Rsync Module Other Options Settingse
Enter any additional rsync configuration parameters from [Link](5 in Auxiliary Parameters.
Click Save.
Related Content
Adding SSH Credentials
Configuring Rsync Tasks
Rsync Tasks Screens
Rsync Services Screen
Rsync
Rsyncd
Documentation
Have more questions or want toHub
these resources:
discuss your specific configuration? For further discussion or assistance, see
TrueNAS Community Forum
TrueNAS Community Discord
iXsystems Enterprise Support (requires paid support contract)
Found content that needs an update? You can directly! To request changes to this content, click the Feedback
button located on the middle-right side of the page (might require disabling ad blocking plugins).
© iXsystems, Inc. 2024 All rights reserved. |
