User Tools

Site Tools


documentation:setup_and_user_guide:rsync

Table of Contents

RSYNC

Terms as used in XigmaNAS rsync Graphical User Interface (GUI):

  • rsync - unless specifically mentioned, this is purely in reference to how XigmaNAS GUI uses rsync (in other words, the rsync GUI in the XigmaNAS GUI) and NOT the rsync executable itself (which is still accessible through the Command Line Interface (CLI)).
  • Local - your XigmaNAS system. If you have more than one XigmaNAS system, it's the one you are reading the word “local” on.
  • Remote - any other system but your local system.
  • Source - where the files you wish to rsync are coming FROM. TYPICALLY but not always it's the local system you wish to backup files to (it's the NAS after all).
  • Destination - where the files you wish to rsync are going TO. TYPICALLY but not always it's the remote system files you wish to backup.
  • Server tab - the place where the rsync “service” (not deamon(? Need help with this)) is started with the accompanying port as well as the place to create modules.
  • Modules tab - they are destination folder(s) complete with access controls. TYPICALLY but not always they are on the local system.
  • Client tab - the place to create rsync jobs.
  • Local tab - the place to create rsync jobs within the local system.

It's confusing as chaos what the rsync (the executable, not the rsync GUI in the XigmaNAS GUI) server and client is. As pertaining to rsync itself (not the rsync GUI in the XigmaNAS GUI), a server and client can be both sender (source of files) and receiver (destination of files). In XigmaNAS this is locked down a bit:

  • Under the server tab, there is a “service” to enable which must be done to link remote rsyncs to the expected port. Obviously the ports must match between the local and remote rsyncs that are used. There is also the modules tab.
  • Under the modules tab, there are modules (destination folder(s)) to add. Overall this kind of defines the rsync server GUI is used to enable and create local destination folder(s).
  • Under the client tab, there are rsync jobs to create. Here you can create rsync jobs with local destinations and remote sources. NOTE: Although the words local and destination are linked as well as remote and source are linked in the GUI, any paths can be entered in these text boxes that could make a local and remote either source or destination. Also there is a reverse direction option. I suggest NOT utilizing these configurations (unless you specifically know what you are doing) as XigmaNAS rsync GUI would be even more confusing.
  • Under the local tab, there are more rsync jobs to create. Here you can create rsync jobs with local destinations and sources. Almost the same options as in the client tab, the same NOTE applies except there is no reverse direction option.

Hope this helps!

Server

RSYNC is a multi-platform incremental copy over network utility that can be used for backup. If you want to backup some of your files regularly, it’s the protocol to use: The incremental sync process permits a copy of the differences in the files across the link, from the last backup.

There are some tools under windows that support RSYNC:

Services|RSYNC|Server

Client

This option permits you to synchronize files between a XigmaNAS ‘server” and one or more NAS4Free ‘client’.

On the XigmaNAS ‘server’, you must just enable RSYNCD Server (with ‘read only’ box to “No”).

On the XigmaNAS ‘client’: Click on the icon for add a new client entry and:

  1. Select your local configured share. Warning it will be the ‘destination’ share
  2. Enter the Remote Share name configured on the RSYNCD Server
  3. Enter the IP address of the RSYNCD Server
  4. Set the synchronisation time

At the given time, the XigmaNAS ‘client’ will do a rsync (incremental copy) from the NAS4Free ‘client’ share to the XigmaNAS ‘server’ share. You can check the detected share name of the RSYNCD Server configured by using the Diagnostics: Information: RSYNC Client page.

Services|RSYNC|Client

Local

It’s the same as ‘client’ but with local share only. Very useful for local backup “drive to drive” can be an alternative solution for drives mirroring.

If you change the rsync user on Web GUI you must restart(disable/enable) this service for changes to take effect.

Services|RSYNC|Local

documentation/setup_and_user_guide/rsync.txt · Last modified: 2018/10/01 22:38 by zoon01