Help Center

Quick start


This article is a step-by-step instruction guiding you through the installation of Sync IT product and configuring it to sync data between the Management Server, OS X and Windows clients.

Let's assume that you need to:

  • Set up a folder "Updates" which will be populated on server and delivered to all clients
  • Set up a folder "Engineering documents" which will be synced between Windows machine and Server (and possibly some other computers added later in the "Engineering" group)

1. Installing Sync IT Management Server

Run the “sync-it-server-windows-x86.msi” installation package and follow installation wizard. By default Sync IT Management server is installed to "C:\Program Files (x86)\BitTorrent Sync IT Server\", registers itself as a service and runs itself after installation. You can see the service registered and running in Windows Services:

Note that installation requires admin rights.

More on this step: installing management server

 

2. Ensure your firewall allows incoming connections to Sync IT Management Server

You can add Management Server to firewall in 2 ways: as an executable (more convenient way) or using particular ports (more secure way).

Add to firewall using particular ports

  • Open your Control Panel -> Firewall -> Advanced Settings
  • Open Inbound rules -> Add new rule, rule wizard will open
  • Use the "Port" rule type and click "Next >"
  • Use TCP for protocol and click "Next >"
  • Specify local ports: 8443, 8444, 8445, 3000 (separate them with commas) and click "Next >"
  • Choose "Allow connection" and click "Next >"
  • Choose your necessary profiles (or check all if you are unsure) and click "Next >"
  • Give some name to your rule and click "Finish"

Add filrewall using application name

  • Open your Control Panel -> Firewall -> Advanced Settings
  • Open Inbound rules -> Add new rule, rule wizard will open
  • Use the "Program" rule type and click "Next >"
  • Choose "This program path", click "Browse" and pick the Management Server executable ("C:\Program Files (x86)\BitTorrent Sync IT Server\node.exe")
  • Choose "Allow connection" and click "Next >"
  • Choose your necessary profiles (or check all if you are unsure) and click "Next >"
  • Give some name to your rule and click "Finish"

More on this step: port used by Sync IT, configuring your firewall

 

3. Apply your server license and prepare config file for your clients

Open a browser and navigate to your server Web UI https://localhost:8443. Make sure to specify "https://" protocol explicitly as server rejects all plain HTTP connection attempts.

As the certificate is self-signed, you'll see a warning.

Ignore it for now and add self-signed certificate to the exception list.

On the first login Management Server will request you to specify admin login and password and agree to EULA:

After login and password, server asks for a license file.

Pick the license supplied to you by Support or Sales representative.

Once license is applied, server lets you through to its interface. Open Settings -> General and click "Download client config". You'll need to edit your config file after downloading.

Config file is in JSON format so any plain text editor will work. All you need to change is the "host" value. It is "0.0.0.0:8444" by default and need to be changed to your Management Server real address. Here is a sample of a fixed config file:

Now ensure that you deliver this fixed config file to all computers you are going to deploy Sync IT client to (including Management Server itself).

More on this step: applying license, client config

 

4. Install your clients and connect them to Management Server

Windows client

  • Get the MSI installer to your windows client
  • Put the sync.conf file that you fixed in Step 3 next to installer (it will get copied and used by client right after installation)
  • Run installer and follow the wizard.
  • Once installation is complete, you'll see your new client in the "Clients" tab on the Management Server

Client for Management Server

As Management Server does not seed any folders by default, we need to install client on it, too. Follow the same steps as for "Windows client".

If everything is done correctly, you'll see your Management Server on the list of clients in the Management Server Web UI.

OS X Client

  • Open the “BitTorrentSync.dmg” package
  • Drag the "BitTorrent Sync.app" to the "Applications" folder
  • Open Finder and navigate to the "~/Library/Application Support/" folder. The "Library" folder is a hidden folder, so you can use the Cmd+Shift+g shortcut to type in the path manually
  • Create the "BitTorrent Sync IT" folder (case sensitive!) and put the “sync.conf” file downloaded in Step 3 there
  • Open System Preferences -> Users and Groups -> Login Items. Add Sync as a login item to ensure it launches automatically.
  • Launch Sync from the Applications folder

You won't see any UI and if everything is done correctly, you'll see your Mac computer on the list of clients in the Management Server Web UI.

More on this step: installing clients

 

5. Organizing your clients and sharing folders to them

Now you should have Management Server running and 3 clients visible in the "Clients" tab. Clients can be organized in groups and get assigned folder shares.

At the very beginning of this guide we decided to setup an "Updates" folder for delivering updates to everyone and "Engineering documents" to get docs shared between clients and back them up to our server.

Open the Folders tab and create your folders:

  • Updates for distributing updates
  • Engineering Docs for sharing engineering data

Note that at this step no actual folders are created in any filesystems. It will only happen when some clients get assigned to a group having the folder.

Open the Groups tab and create your groups:

  • Servers group: only add server there, allow syncing Updates folder with RW permissions and Engineering Docs with RO permissions. Leave default profile and schedule
  • Engineering group: add the rest of clients there, allow syncing Updates with RO permissions and Engineering Docs with RW permissions. Leave default profile and schedule

If you get any more clients - you can add them to Engineering group and they'll automatically get Updates with RO and Engineering Docs with RW permissions.

At the moment you add clients to groups with some folders, these folders are going to appear on endpoint computers.

If you place some data into "Updates" folder on your server, you get it automatically distributed to your other clients. Though, it won't work with "Engineering Docs" as server has only read-only permissions and will only store data received from other clients.

More on this step: groups, users, folders