Setting Up Polarity Community Edition

System Requirements

‌In order to run PolarityCE, there are some basic requirements that your computer will need to meet:

Windows

• 64 bit version of Microsoft® Windows® 11, 10, 8.1, or 8

• 4+ GB RAM

• 2+ GHz Quad Core CPU with Hyper-Threading

macOS

• 64 bit version of macOS 10.9 or greater

• 4+ GB of RAM

• 2+ GHz Quad Core CPU with Hyper-Threading

Linux

• 64 bit version of CentOS 7, Ubuntu 16 LTS, Ubuntu 18 LTS, or Ubuntu 20 LTS

• 4+ GB RAM

• 2+ GHz Quad Core CPU with Hyper-Threading

Client Installation‌

Prior to installation

Ensure that all system requirements are met.‌

1. Once downloaded, locate the installer file on your computer and run it. The file extension will vary depending on the OS that you are using:

   1. polarityx-community.exe (Windows)

   2. polarityx-community.dmg (macOS)

   3. polarityx-community.run (Linux)

Windows users - If you encounter this Microsoft Defender SmartScreen message there's no need to worry. Simply click More Info and then Run Anyway on the next screen that comes up to continue installation.

Linux users may need to allow the OS to execute the file as a program. To do this:

1. Right-click on the installer file

2. Select Properties

3. Under the Permissions tab, check the box for Allow executing file as program.

After Installation‌

Once the client is installed it will provide you with the option to start Polarity. Once the Start Polarity checkbox is ticked, click Finish and then the application will start.‌

If you do not start Polarity after installing go to your desktop and locate the Polarity Icon and double-click.‌

Polarity is meant to run in the background of your computer and can be accessed from the system tray or macOS menu bar.

Connecting to the Polarity Server‌

In order for Polarity to work, a connection to a Polarity Server needs to be configured. Upon first launch, Polarity will prompt you to configure your connection settings.‌

If it does not provide a prompt you can access the Connection Settings window by clicking on the Polarity Overlay dropdown menu and then clicking on Connection Settings .

Once on the Connection Settings page, following the instructions below for adding a connection.

To add a new connection:‌

1. Click on the Add new connection button

2. Populate the form with details provided from your Polarity Welcome Email.

   • Server Url - https://ce.polarity.io

   • Username - see email

   • Password - see email

3. Click Login once you have completed the sections above.

Be sure not to include any trailing whitespace if copying your password out of your welcome email.

If required, click on Advanced Options to configure proxy settings.‌

For security reasons, we will prompt you to change your password after logging in for the first time.

Determining Connection Status

‌If you have Polarity pinned to the system tray or the macOS menu bar, the Polarity icon will change appearance depending on Polarity's status.‌

Below are examples of the different icon states that you will encounter and their meanings.‌

1) Green, hollowed-out Polarity icon - On-Demand Only Mode Enabled

​‌

2) Orange Polarity icon with two arrows in the center - Not Connected to Server, Attempting to automatically Restore Connection‌

3) Red Polarity icon with red horizontal line through it - Not Connected to Server, Cannot Automatically Restore Connection‌

Start on Boot‌

After the first login to Polarity, you can set whether or not you want Polarity to start up on boot.‌

To Access the Start on Boot option navigate to the Polarity Overlay dropdown menu.

Start on Boot is enabled by default.