There are several settings that can be adjusted. These settings are saved to a permanent storage location.
Users can access their settings by default using the shortcut ⌘,.
Rsync and Path: - Settings for rsync and path
Monitor and Log: - Settings for monitoring and logging
SSH: - Settings for SSH
Environment: - Setting environment variables for SSH. There are several variables that can be set, but RsyncUI only supports one environment variable.
The “Info” section displays the version of rsync in use and the path for storing and retrieving configurations to the permanent storage location.
1 - Monitor and log
Changes to settings are automatically saved.
Monitor Network:
Monitor network connection during task execution.
If a network connection is dropped during execution, RsyncUI sends an interrupt signal to the task, halting it with an error.
Check for Errors in Output:
If the word “error” is discovered in the output from rsync, it is notified.
Add Summary Log Record:
By default, “on,” a summary of each synchronization is added to the log records. View “Log Listings” from the Sidebar.
Confirm Execution:
See below.
The log file is stored at $HOME/.rsyncosx/macserial/rsyncui.txt. The log file can be opened from the main view.
Error Output from rsync:
Sample of an error in output from rsync. If the switch “Check for error in output” is enabled, RsyncUI writes the output to the log file and alerts the user about any errors in rsync.
Confirm Execute
This option is only available if version 3.x of rsync is enabled.
The confirm dialog appears when the number of files to synchronize is comparable to a new task. Occasionally, a remote server or local disk becomes unavailable or is forgotten to be attached. If you initiate a synchronize task without being aware that the destination resource is not available, rsync may mistakenly believe this is a new full synchronize and prompts a dialog to confirm synchronize or abort.
If a remote server is unavailable, rsync will likely complain and generate an error. If the check for error in output option is enabled in the user settings, the rsync error messages written to the log and an Alert will be displayed.
If a local disk is not attached, rsync will attempt to synchronize the data to the /Volumes/ catalog on your Mac. This catalog is typically 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, and the estimate may interpret this as a new synchronize task. If you have simply forgotten to attach the disk, you do not want RsyncUI to synchronize data to the /Volume catalog.
2 - Rsync and path
Changes to settings are automatically saved.
Version rsync
It is recommended to install the latest version of rsync using Homebrew. RsyncUI will determine the type of Mac you are using. The default path for Homebrew is:
Intel-based Mac: /usr/local/bin
Apple Silicon: /opt/homebrew/bin
Path rsync
If rsync is installed by Homebrew, the path is set to the default value or rsync if it is part of your macOS. The snapshot feature
requires version 3.2.x of rsync.
If the version of rsync is not installed by Homebrew, set the path to rsync.
If Rsync v3.x is enabled, set the optional path if not installed by Homebrew.
Any version of rsync will work, but only versions 2.6.9 and the latest release of version 3.2.x have been 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 an execution date older than the number of days are marked red.
Backup configurations
You can backup the current setup, configurations, and logs, including all profiles, at any time by clicking the wrench button.
The backup executes a copy to your Documents catalog and appends a timestamp -month-day-year/hour/minute to the copy.
The backups are located in your Documents catalog: $HOME/Documents/RsyncUIcopy-05-06-2024/08/21
3 - SSH settings
In this perspective, you can utilize RsyncUI to assist in creating an SSH key and setting up a global SSH keypath and identity file.
SSH keys are required for passwordless logins to remote servers. You can either use the default values for SSH keys or set your own.
For more information on passwordless logins, please refer to the documentation at passwordless logins.
Local SSH Key Present
If the “on” option is selected in RsyncUI, it has detected a local SSH key.
The default values for RSA-based SSH keys are ~/.ssh/id_rsa and port number 22. These values are not mandatory if you choose to
use the default settings. If you do not specify your own SSH keypath and identityfile, RsyncUI will automatically use the default values.
If a local SSH key is present, you can either leave the settings as they are or manually set your own SSH keypath and identityfile.
In this case, RsyncUI will mark the selected settings as the default.
Set SSH Keypath and Identityfile
The user can specify a selected SSH keypath and identityfile that will apply to all configurations.
SSH Keypath and Identityfile: If the user selects a different keypath or identityfile from the default, it will be used for all configurations.
Port Number: The user can specify the port number through which SSH communicates. The default port number is 22.
If global SSH parameters are set, they will apply to all configurations. It is possible to specify different SSH parameters for each task.
