# Setting Up Polarity Community Edition

## System Requirements <a href="#system-requirements" id="system-requirements"></a>

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

{% tabs %}
{% tab title="Windows" %}

* 64 bit version of Microsoft® Windows® 11, 10, 8.1, or 8
* 4+ GB RAM
* 2+ GHz Quad Core CPU with Hyper-Threading
  {% endtab %}

{% tab title="macOS" %}

* 64 bit version of macOS 10.9 or greater
* 4+ GB of RAM
* 2+ GHz Quad Core CPU with Hyper-Threading
  {% endtab %}

{% tab title="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
  {% endtab %}
  {% endtabs %}

## Client Installation‌ <a href="#client-installation" id="client-installation"></a>

### Prior to installation  <a href="#prior-to-installation" id="prior-to-installation"></a>

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:<br>
   1. polarityx-community.**exe** (Windows)
   2. polarityx-community.**dmg** (macOS)
   3. polarityx-community.**run** (Linux)

{% hint style="info" %}
**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.

<img src="https://2724948645-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MDLd7tA19QYgbVG3Unr%2F-ME4EhgyrrQoVKkfXCYw%2F-ME4K0oV7XBu-luSRZkt%2FHos8YWYl7h.png?alt=media&#x26;token=5760d366-ac4f-48ed-acc4-a29fd99476e2" alt="" data-size="original">
{% endhint %}

{% hint style="info" %}
**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`**.

<img src="https://2724948645-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MDLd7tA19QYgbVG3Unr%2F-ME4ByX--9sFNC34xk3k%2F-ME4DzvCYWmBMd6iabrw%2Flinux_installer.png?alt=media&#x26;token=9199719b-4e6d-4691-a44c-aca3b01b8203" alt="" data-size="original">
{% endhint %}

### After Installation‌ <a href="#after-installation" id="after-installation"></a>

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.‌

{% hint style="info" %}
Polarity is meant to run in the background of your computer and can be accessed from the system tray or macOS menu bar.
{% endhint %}

## Connecting to the Polarity Server‌ <a href="#connecting-to-the-polarity-server" id="connecting-to-the-polarity-server"></a>

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` .

![](https://2724948645-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MDLd7tA19QYgbVG3Unr%2F-MDvSA-PjeobmcaFBvpH%2F-MDvTBxRd3x57A1Fc_iL%2Fconnection_settings.png?alt=media\&token=6b886989-1c60-4bf1-a9bf-e1354f66ca8e)

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

![](https://2724948645-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MDLd7tA19QYgbVG3Unr%2F-ME3IbkCzS1icn2wvkHt%2F-ME3IkYrezUIP2-VuvZ2%2FConnection_Settings_not_connected.png?alt=media\&token=365a1cee-ff64-4f68-b261-a61e482e6ded)

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.

{% hint style="warning" %}
Be sure not to include any trailing whitespace if copying your password out of your welcome email.
{% endhint %}

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

{% hint style="info" %}
For security reasons, we will prompt you to change your password after logging in for the first time.
{% endhint %}

## Determining Connection Status <a href="#determining-connection-status" id="determining-connection-status"></a>

‌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

​‌

![](https://2724948645-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MDLd7tA19QYgbVG3Unr%2F-ME0P0tilRudBLULrnkM%2F-ME0QmnmNrKXDVb-jMQy%2FSnag_f3bfd56.png?alt=media\&token=1b1cfd11-c805-48ef-a029-48f159d15b74)

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

![](https://2724948645-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MDLd7tA19QYgbVG3Unr%2F-ME0P0tilRudBLULrnkM%2F-ME0SL9rR_TIv18roNEb%2FSnag_f42338c.png?alt=media\&token=c11e3dc4-8611-46d3-9bfc-3a84ccaf7a5f)

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

![](https://gblobscdn.gitbook.com/assets%2F-MCAAXaadP8o1ERJ4Z4C%2F-MDGX3bs_webyIY6EET8%2F-MDGgtJFLxYQ4a1yiiPh%2Ficon_not_connected_cannot_reconnect.png?alt=media\&token=4050cc01-98f1-4457-ad53-3a3b6a1ece17)

## Start on Boot‌ <a href="#start-on-boot" id="start-on-boot"></a>

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

![](https://2724948645-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MDLd7tA19QYgbVG3Unr%2F-MDvSA-PjeobmcaFBvpH%2F-MDvTZ5dZmOo97-5i1pD%2Fstart_on_boot.png?alt=media\&token=efd45186-ce9f-4ed3-b360-294e37d6a7af)

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

{% hint style="info" %}
Start on Boot is enabled by default.
{% endhint %}
