0% found this document useful (0 votes)
39 views4 pages

Configuring Rsync Modules in TrueNAS

Uploaded by

steffen-kl
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
39 views4 pages

Configuring Rsync Modules in TrueNAS

Uploaded by

steffen-kl
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

Get a Quote 408 9434100 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. |

Common questions

Powered by AI

To configure the permission access level in a rsync module on TrueNAS SCALE, navigate to the Services > Rsync > Rsync Module screen and click Add module. Under General Settings, the Access Mode allows administrators to choose the desired permission level. They must select the respective user and group that will run the rsync command, ensuring proper access rights and security during file transfers. Consideration of host permissions, achieved via 'Hosts Allow' and 'Hosts Deny,' further enhances security by specifying permitted and restricted IPs and hostnames .

Defining an 'Allow Hosts' list when configuring an rsync module on TrueNAS significantly enhances security by restricting access to only specified IP addresses and hostnames. This reduces the attack surface by preventing unauthorized connections, even if credentials are exposed or guessed. However, it also requires precise network management as legitimate hosts must be accurately entered to maintain functionality, adding complexity to administration .

Configuring rsync modules on TrueNAS systems involves accessing the Services > Rsync screen, choosing Configure to set a TCP port number, and using the Rsync Module tab to add a module. Administrators must define a module name, designate a storage path, select permission access levels, and determine user and group permissions for the file transfer. Defining allow or deny hosts is crucial to control access. Configuring these modules is important for managing network data transfers securely and efficiently, allowing precise control over what data is transferred and who can access it .

When setting the TCP port for rsync on TrueNAS, the default port is not necessarily used; a new port number should be entered in the Configure screen under Services. It's essential to consider network policies, firewall settings, and any potential conflicts with reserved ports, such as port 22, which is dedicated to TrueNAS. Ensuring the chosen port aligns with organizational security protocols is critical to preventing unauthorized access and maintaining system integrity .

TrueNAS SCALE 23.10 replaces several deprecated features from SCALE 22.12 with applications that perform their roles, addressing obsolescence and potentially improving functionality or security. For system administrators, this means adapting to new interfaces and functionalities by installing and configuring new applications such as the rsyncd application available under Apps. It ensures continuity, enhanced performance, and security compliance but requires administrators to keep updated with the latest changes and configurations .

It is recommended to configure rsync with SSH as a security best practice. This can be done by using the TrueNAS built-in rsync task in SSH mode. The rsync service should not be enabled with modules unless necessary, and it is advised to use port 22, which is reserved for TrueNAS, or another specified TCP port if not using the default. These practices help secure data transfer over networks .

The deprecation of several built-in features in TrueNAS SCALE 22.12 affects the use of the rsync service as these features are no longer supported natively. Administrators need to transition to alternative methods, such as installing new applications or utilizing SSH for secure data transfers, which requires adjustments in configuration practices. This transition demands updated knowledge and adaptation to maintain efficient and secure workflows .

Enabling an rsync server with modules on a TrueNAS system is necessary when there is a requirement to manage data transfers in a decentralized manner, such as between different departments or locations that require separate configuration settings. Prerequisites include setting a specific TCP port for the server to listen on, configuring at least one rsync module, and determining required permissions and access control settings. While the built-in rsync task can suffice for many situations, module-based configuration is vital for complex environments needing detailed control .

Configuring additional parameters in rsyncd.conf(5) can enhance TrueNAS system functionality by allowing administrators to tailor rsync operations to specific network and security needs. This flexibility can optimize network resource usage and enhance performance by adjusting parameters like compression, data checksums, and login credentials handling. These configurations can also align data transfer operations with organizational protocols, ensuring compliance and enhancing data security .

TrueNAS users seeking assistance can access several resources: the TrueNAS Community Forum, TrueNAS Community Discord for real-time collaboration, and iXsystems Enterprise Support for those under a paid support contract. Additionally, users can provide feedback on documentation or request updates via the Documentation Hub's Feedback section. These resources provide comprehensive support for configuration and troubleshooting .

You might also like