This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

RsyncUI settings

There are a few settings to be tweaked. Settings are saved to permanent store. Usersettings might be opened by the default shortcut ⌘,.

  • Rsync and path - rsync and path settings
  • Monitor and log - monitor and log settings
  • ssh - ssh settings
  • Environment - set environment variables for ssh, there are a few variables to set, RsyncUI only support one environment variable

The Info shows version of rsync in use and the path for storing and reading configurations to permanent store.

1 - Monitor and log

Settings are automatically saved when changed.

Monitor network, error and log settings

  • Monitor network

    • monitor the network connection during execution of tasks
    • if a network connection is dropped during execution, RsyncUI sends an interrupt signal to the task and it halts with an error
  • Check for error in output

    • if the word error is discovered in output from rsync it is notified
    • se below
  • Add summary logrecord

    • by default on, a summary only of each synchronization is added to the logrecords, view Log Listings from Sidebar
  • Log summary logfile

    • by default off, there is also possible to add a short summary to the logfile
      • timestamp
      • last twenty lines of output from rsync which includes a summary of the task
  • Confirm execute

    • see below

The log file is stored at $HOME/.rsyncosx/macserial/rsyncui.txt. The logfile can be opened from the main view.

Error output rsync

Sample of error in output from rsync. If switch Check for error in output is on RsyncUI writes the output to logfile and Alerts the user about error in rsync.

Confirm execute

This option is only available if version 3.x of rsync is enabled.

The confirm dialog if number of files to synchronize is like a new task. Sometimes a remote server or local disk is unavailable or forgotten to attach. If you commence a synchronize task unaware of destination resource is not available, rsync might believe this is a new full synchronize and a dialog confirms synchronize or abort

  • if a remote server is unavailable rsync will most likely complain and throw an error, if check for error in output in user settings is enabled, the rsync error messages written to log and an Alert informing about it will occur
  • if a local disk is not attached rsync will try to synchronize data to /Volumes/ catalog on your mac, this catalog is normally where macOS mounts local attached disks
/dev/disk5s2 on /Volumes/Import bilder (apfs, local, nodev, nosuid, journaled, noowners)
/dev/disk6s1 on /Volumes/Backups (apfs, local, nodev, nosuid, journaled, noowners)

Below the local attached volume is not connected, the estimate may think there is a new synchronize task. If you just forgot to attach the disk you dont want RsyncUI to synchronize data to the /Volume catalog.

When the switch is on RsyncUI ask to confirm synchronize.

2 - Rsync and path

Settings are automatically saved when changed.

Version rsync

It is advised to install the latest version of rsync by Homebrew. RsyncUI discover what type of Mac you are on. The default path for Homebrew is:

  • Intel based Mac is: /usr/local/bin
  • on the Apple Silicon: /opt/homebrew/bin.

Path rsync

The path for rsync is set to default values if rsync is installed by Homebrew, using default path or rsync as part your macOS. The snapshot feature require version 3.2.x of rsync.

If version of rsync is not installed by Homebrew set path to rsync.

  • if Rsync v3.x is on - set optional path if NOT by Homebrew
  • any version of rsync should work, but only version 2.6.9 and last release of version 3.2.x are tested and verified

Path for restore

  • preset temporary path for restoring single files and catalogs
  • preset temporary path for a full restore

Mark days after

Tasks with older execute date than number of days are marked red.

Backup configurations

You can any time backup the current setup, configurations and logs including all profiles by the wrench button. The backup executes a copy to your Documents catalog and postfixes the copy with a timestamp -month-day-year/hour/minute.

The backups is located in your Documents catalog: $HOME/Documents/RsyncUIcopy-05-06-2021/08/21

3 - SSH settings

In this view you can let RsyncUI assist in creating ssh-key and setup global ssh-keypath and identityfile. ssh-key is requiered for passwordless logins to remotes servers. You can either utilizing default values for ssh-key or set your own. There is some more info about passwordless logins.

ssh keys

Local ssh-key is present

If on RsyncUI has found a local ssh-key.

Default values for RSA based ssh-key is ~/.ssh/id_rsa and portnumber 22. It is not required to set your own values for ssh-keypath and identityfile if default values are used. If there are no local ssh-key selecting the Create button will create the keys. If ssh-key is present, either default values or by the user set ssh-keypath and identityfile, RsyncUI will mark it.

Set ssh-keypath and identityfile

The user can set a selected ssh-keypath and identityfile which applies to all configurations.

  • ssh-keypath + identityfile, user selected if other than default
  • portnumber, which ssh communicates through

If global values are set, this is what the ssh parameter within the rsync command looks like

-e  "ssh -i ~/.ssh_keypath/identityfile -p NN"

where

  • -i is the ssh-keypath and identityfile
  • -p is the port number ssh communicates through, default port 22

If global ssh parameters are set, it applies to all configurations. It is possible to set other ssh values on each task. Global ssh-keypath and identityfile in use.