Before installing and using RsyncOSX there are some important information to read and understand. The first document is how to get and install RsyncOSX. The second document is some information what RsyncOSX is and how to use the application. Please read the second document before using RsyncOSX.
This page is a short guide what to do when first start of RsyncGUI. For more details about the various functions of RsyncGUI please see the documentation (RsyncOSX) about each function. Also be sure you understand the basics (RsyncOSX) about how rsync works before using RsyncGUI and rsync.
This page is a short intro to RsyncGUI. For more details about the various functions of RsyncGUI please see the documentation (RsyncOSX) about each function. Also be sure you understand the basics (RsyncOSX) about how rsync works before using RsyncGUI and rsync.
All configurations to execute are listed in table. From the Execute view most actions (edit configurations, adding parameters to rsync, delete configurations) regarding configurations are executed.
RsyncOSX is a GUI for the rsync command-line tool. The main uses are:
The view is depended upon selecting a row in Execute view. When the view is selected the numbers of source and remote destination are automatically collected.
Snapshot is an effective method for saving changed and deleted data. Snapshot utilize hardlinks and only changed and deleted data are saved as separate files in a snapshot. Files which are not changed are hardlinks to the original file in the snapshot.
RsyncOSX and RcloneOSX are signed with my Apple ID developer certificate and notarized by Apple. This means both apps are verified and checked for not containing malicious code. It ensures the users that the apps are clean and that they are working together with Apples Gatekeeper technology. A message from Apple is issued when opening either a new or updated application the first time.
From version 5.8.6 RsyncOSX and the menu app RsyncOSXsched are prepared for localization. RsyncOSX is translated to Chinese (Simplified) and Norwegian, RsyncOSXsched is translated to Norwegian. Default language for both is English
Caution: if you already have setup ssh utilizing ssh keys there is no need to follow the instructions below. RsyncOSX is depended upon passwordless logins for synchronizing data to remote servers. The instructions below only applies if passwordless login is not setup. If utilizing RsyncOSX on local attached disks this does not apply.
RsyncOSX stores its configurations, schedules, log records and user configuration as property list files. There are three kinds of files and all are stored in the Documents/Rsync catalog. RsyncOSX evaluates the computer mac serial number at startup and all files are stored in
There are only a few parameters to choose in user configuration. Configurations are saved to permanent store.
In Execute view (which is the opening view) tasks can be executed as single- and/or batch tasks. Execute single tasks requires a couple of double clicks : one for estimation run and the second for executing the real task. The output from rsync is presented after each run.
The menu app to RsyncOSX is responsible for executing scheduled tasks. Adding and deleting scheduled tasks are done within RsyncOSX. By selecting a row and choose schedule applies a scheduled. All schedules is set to start at selected date.
RsyncOSX implements default parameters which are working fine for simple synchronize and restore tasks. The actual parameters used in tasks is depended upon executing rsync over network connection or not. Which standard parameters to use is computed during startup of application by reading the configuration file.
RsyncGUI is compiled with support for macOS El Capitan version 10.11 - macOS Mojave version 10.14. The application is implemented in Swift 5 by using Xcode 10.
A complete or full restore is commenced by selecting the task to restore. The rsync command shows either the
--dry-run backup command or the restore command to execute. You might copy the command to a terminal window to check the result of a run. It is a
--dry-run only and simulates the real run.
There are two options for executing quick synchronize tasks, either estimate and select or execute directly. In either way RsyncOSX does an estimation run and the numbers to indicate the progress of synchronizing.
Backup to offsite or remote backup locations (servers) requires some more setup. By using rsync from command-line it prompts for login ID and password. There is, as far as I know, no solution for passing login credentials to rsync command-line tool by parameter. But ssh has possibility to enable passwordless logins by using ssh generated private and public key-pair.
The website LibreByte has written an article 16 Practical examples of the rsync command. One of the examples is instructing rsync to store backups of files in a backup folder and rename old files by a date suffix. Rsync utilizes a ton of parameters. RsyncOSX has only presented a few. Parameters are normally constructed as:
This is the
menu app (RsyncOSXsched.app) for executing scheduled tasks in RsyncOSX. Scheduled tasks are added in RsyncOSX. Quit RsyncOSX and let the menu app take care of executing the scheduled tasks. RsyncOSX does not execute scheduled tasks. Scheduled tasks are only added and deleted in RsyncOSX.
Logging in RsyncOSX might be switched on/off in user configuration. All log records are listed in table within Logs tab. The log records are by default sorted with most recent log ontop. Log records can be filtered by text search by selecting the appropriate column. The direction, ascending or descending, is selected by direction of the arrow.
The MIT License (MIT)
This was some years ago, in 2016, the idea of RsyncOSX was born…
This is a short resume about my do it yourself (DIY) NAS. I do not spend much time building or maintaining my NAS. The main purposes of my NAS are:
I am using the application on a daily basis and it evolves during my own use. Suggestions for new features, enhancements and bug reports are more than welcome. Please add an Issue regarding any requests or bugs. For more information about signing and notarizing of RsyncOSX see the notarized info.
The automatic feature of RsyncOSX is triggered by
⌘B shortcut or by select the double arrow. RsyncOSX executes a
--dry-run task for all configurations and execute a backup run for all tasks with data to be transferred or files to be deleted.
Adding configurations are easy. A configuration require minimum Local catalog and Remote catalog. And they should not be equal. After entering information about a configuration select the Add button to add it to RsyncOSX. Continue adding new configurations until completed and configurations are saved to permanent storage after each entry.
This is some documentation of the design and code of RsyncOSX. The documentation is only a brief summary of some parts of RsyncOSX. The design of RsyncOSX is based upon ideas of the MVC pattern. One of the objectives in MVC is to separate the views and models.
The object Readwritefiles.swift decides if data should be read from memory or permanent storage. All data (configurations, schedules and log records, user config) is read from permanent storage utilizing the NSDictionary foundation class.
RsyncOSX utilizes the object RsyncParameters.swift to analyze and set whatever parameters to rsync the user sets. There are no check of parameters set for rsync is correct. If the user enters bad parameters RsyncOSX passes bad parameters to rsync.
Schedules including log records are loaded into a separate data structure. Schedules and log records ConfigurationSchedule are linked to Configuration by
hiddenID = Int. Schedules including log records are saved in a separate XML-file (plist).
The configurations are read from the permanent storage and kept in memory until a new profile is loaded or RsyncOSX quits. Each record (one task) are read from permanent storage as a
NSDictionary item, copied to a
Configuration and loaded into an
This is the Changelog for RcloneOSX. RcloneOSX is a port of RsyncOSX to utilize