Install User Sync

Previous Section | Back to Contents | Next Section

Once you have access to the server where User Sync will run, pick a directory where you will install and operate User Sync.

On Windows, you will need to install Python. As of this writing, version 3.6.x is recommended. Windows and Python need to be 64 bit versions.

On Windows, you also are very likely to need to set an environment variable PEX_ROOT to C:\pex. This is needed to work around Windows pathname length limits.

Note: Setting PEX_ROOT may not be necessary if:

  • You are running Windows 10
  • You are running Python 3.6 or later, 64 bit version (also called X86-64, for AMD64), and
  • You have enabled the long pathname support in Windows 10 as described in the Maximum Path Length Limitation section of this Microsoft Dev Note. You can also enable long pathname support by pressing the button in the Python Windows executable installer (in the final dialog box, when installation finishes) that performs this action.

If these conditions are met, you can run without setting PEX_ROOT.

Initial steps:

☐ Setup a user and file directory for installing and running sync. For example, we’ll create a folder /home/user_sync/user_sync_tool and a user user_sync. On Windows an example would be C:\Users\user_sync\user_sync_tool.

☐ Windows only: set the environment variable PEX_ROOT to C:\pex. (But see note above.)

☐ Windows only: Install python 3.6.2 (or later in the 3.6 series), 64 bit.

The next few sections show the installation process.

To find the latest release: Start here:


Select “release”


☐ Download the example-configurations.tar.gz, User Sync Guide, and build for your platform, osx, ubuntu, windows, or centos.

☐ Decide whether you will run Python 2.x or 3.x (recommended) and download that version of User Sync. You need to install the corresponding version of Python on your server.

☐ Extract the user-sync (or user-sync.pex) file from the archive and place the file for your OS in the folder. In our example, this would be /home/user_sync/user_sync_tool/user-sync or C:\Users\user_sync\user_sync_tool\user-sync.pex.

☐ In the example-configurations.tar.gz file there is a directory config files - basic. From this folder extract the first 3 files and place in the user_sync_tool folder.

☐ Next, rename the 3 config example files by removing the leading “1 “, “2 “, and “3 “ from the names. We will edit these files to create the real User Sync configuration files.


Previous Section | Back to Contents | Next Section