Install & Setup

Log In to Your Zync Site

You should have received an email that looks like this:

Use the link and login info in that email to access your Zync Web Console (the address from the email).

When you first log in, you will notice a warning at the bottom of your screen:

We'll fix that in the next step.

Download and Install the Zync Client App

Visit and download the Client App installer for your Operating System.

IMPORTANT: Please upgrade your Zync client app. to v1.23 or later if you already have an older version.

Run the installer and follow the instructions there. After the install completes, launch the Zync Client App:

Follow up by clicking on "Connection settings" button which will bring up the configuration window:

Enter your Zync URL which can be found in your Welcome Email. Click "Login With Google" to log in, making sure to use the same Google account from your Welcome Email.

Should your organization use an HTTP proxy - fill in the configuration accordingly.

Once you're logged into the Client App, the red warning banner on the Web Console should disappear. This indicates that your Zync Client App session has been recognized.

Install the Zync Plugins

Zync includes native plugins for its supported host applications, which you will use to launch your Zync jobs. There are two methods for installing the Zync plugins:

Open Zync Client App and switch to the "Plugins" tab:

Click "Install plugins" button. The latest plugins will be automatically downloaded and dialog box will pop up with the list of detected host applications, offering to install Zync plugins:

After clicking "OK" Zync plugins will be configured to work with chosen host applications. That's it!

NOTE: The plugins will use the current connection settings (such as your Zync site URL and proxy setup) from the Client App configuration, but if any of these settings change after the plugins are last installed they will need to be updated. To update plugin configuration just click the "Update Plugins" button on the Plugins tab of the client app:

Option #2: Install from Github (Advanced, requires manual steps)

NOTE: This step is not needed if you have used the plugin installer (Option #1 above).

This method is useful if you want to install to a site-wide shared directory, or if you plan on making modifications to the plugin code yourself. It is recommended only if the Installer doesn't meet your needs and you have development knowledge to understand what's happening.

Instructions for this manual installation are available on Github. You need to set up both and one or more application-specific plugins, depending on what you use:

(Optional) Configure proxy for the plugin(s)

You should skip this step, unless your organization requires the use of an HTTP proxy.

The proxy connection settings in the Zync Client App are currently independent from plugins' proxy settings. We're working on unifying them, though.

The Zync Client Application allows setting proxy configuration from the user interface. These options are available on the connection dialog box, which is used to select which Zync site the client application connects to.

To use an HTTP proxy in a host application Zync plugin, you need to:

  1. Find the file in your zync-python directory (created by the plugin installer or yourself in step 3),
  2. Open that file in a text editor,
  3. Add lines such as the following (note the double-quotes on the first line):

  4. If your organization requires proxy authentication, also add settings such as the following:

  5. Save the file,

  6. Re-start your host application so it can pick up the change.


Installation is now complete. The Zync plugins should now be accessible from your host applications.