Resilio Sync Setup for OS X 10.8+ Clients (revised)

Intended Audience

This post will be of interest if you want to use Resilio Sync to selectively back up directories on OS X 10.8+ clients to a modern FreeNAS server (version 11.2 and above).

An earlier version of this post using a legacy FreeNAS server (version 11.1 or below) can be found here.

Assumptions

1. The reader has a working knowledge of FreeNAS.
2. The Resilio Sync plugin has been installed on the FreeNAS server. If not, refer to this post first.

Background

This post is a refresh of an earlier post that was based on the legacy FreeNAS UI (FreeNAS version 11.1 or earlier) and  Warden backend manager for jails and plugins. FreeNAS 11.2 brings with it an all-new UI and swaps iocage for Warden as the backend manager. To continue to receive plugin updates,  it’s essential to switch to iocage.

Resilio Sync was chosen as the backup tool of choice as the client is available across numerous platforms and there is also a FreeNAS plugin for the server component. At the time of writing this, I am working with FreeNAS 11.2-RELEASE-U1, Resilio Sync plugin 2.6.1 and Windows 10 Home (Build 1809). The guide below assumes the Resilio Sync server has already been set up.

The instruction here is for setting up Resilio sync client software on OS X 10.8 or later clients to selectively back up data from them on to a FreeNAS server. The app screens that follow refer to the version of the OS X sync client highlighted in the screenshot below.

Overview

The key steps to set up the Resilio OS X sync client are:

1. Install and start the sync client.
2. Add a location to backup.
3. Request a session connection with the sync server
4. Establish a session connection on the server.
5. Create a storage location for the backup.
6. Initiate the backup

Step 1: Install and start the sync client.

Download and install the Resilio Windows sync client from the Resilio website. When the client is first invoked, you will be prompted for a user name. For naming convenience, I use the sync name rslsync across all devices in the FreeNAS client-server arrangement.

If you’ve already subscribed, skip past the Sync Newsletter dialogue box at which point you’ll be presented with the client UI.

Step 2: Add a location to backup.

Click the + button in the top left corner and then select Standard folder.

Choose your location. In this example, Documents is chosen.

Step 3: Request a session connection with the sync server

Next, select a means of delivering the session request to the server.

Step 4: Establish a session connection on the server.

Log on to the sync server, click the + button in the top left corner and then select Enter a key or link.

The dialogue box below will appear. Paste the link you obtained in the previous step and then click Next.

Step 5: Create a storage location for the backup.

After clicking Next, the sync server will ask you to choose a folder.

If this is a new client to be backed up, create a backup folder under media. Name it something meaningful. If migrating an existing client to the iocage version of Resilio Sync, choose the same backup location the Warden version of Resilio Sync used.

Step 6: Initiate the backup

Click Connect.  If you’re migrating an existing client from the legacy Warden to a more current iocage version of Resilio Sync, you will probably see the dialogue box below. Click OK to continue.

The server sync dashboard should show a Pending Approval as in the example below.

A corresponding notification will be flagged on the client UI.

Click the tick to initiate a backup. Backup activity can be observed from the Folders screen of the client UI…

…and from the sync server dashboard.

References

1. Resilio Sync Setup for OS X 10.8+ Clients (legacy)