---
title: "Polarity General Advanced Client Installation Guide (v5)"
slug: "polarity-advanced-client-installation"
description: "Polarity General Advanced Client Installation lets admins silently install the desktop client with command-line options, unattended mode, and proxy settings."
updated: 2025-12-02T16:09:21Z
published: 2025-12-02T16:09:21Z
canonical: "knowledge.threatconnect.com/polarity-advanced-client-installation"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.threatconnect.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Advanced Polarity Client Installation

Unattended mode is intended for administrators to silently install the software with default settings across the organization’s workstations.

The filenames in the examples should be replaced with the filenames on your system. The PolarityX version used for the examples is v5.0.4.

## Windows

Running the PolarityX installer from the command line with the `--help` parameter will display the following information:

```plaintext
.\PolarityX-5.0.4-windows-installer.exe --help
PolarityX 5.0.4
Usage:

 --help                                        Display the list of valid options

 --version                                     Display product information

 --unattendedmodeui <unattendedmodeui>         Unattended Mode UI
                                               Default: minimal
                                               Allowed: none minimal minimalWithDialogs

 --optionfile <optionfile>                     Installation option file
                                               Default: 

 --debuglevel <debuglevel>                     Debug information level of verbosity
                                               Default: 2
                                               Allowed: 0 1 2 3 4

 --mode <mode>                                 Installation mode
                                               Default: win32
                                               Allowed: win32 unattended

 --debugtrace <debugtrace>                     Debug filename
                                               Default: 

 --installer-language <installer-language>     Language selection
                                               Default: en
                                               Allowed: en

 --prefix <prefix>                             The installation directory
                                               Default:  

 --create-server-entry <create-server-entry>   Save server information to Polarity. WARNING: This will overwrite all existing entries. (yes/no)
                                               Default: 0

 --server-host <server-host>                   Hostname or IP address:
                                               Default: 

 --server-port <server-port>                   Port (typically 443):
                                               Default: 443

 --proxy-host <proxy-host>                     Proxy hostname:
                                               Default: 

 --proxy-port <proxy-port>                     Proxy port:
                                               Default: 8443

 --use-proxy <use-proxy>                       Is a proxy required for this connection? (yes/no)
                                               Default: 0

 --start_on_exit <start_on_exit>               Start Polarity
                                               Default: yes
```

#### Windows CLI Example

The following command will install the software and create the first server entry to point to a Polarity Server with a proxy configuration:

```plaintext
.\PolarityX-5.0.4-windows-installer.exe --unattendedmodeui none --mode unattended --create-server-entry yes --server-host kingsnake-api.breachintelligence.net --server-port 443 --use-proxy yes --proxy-host localhost --proxy-port 8080
```

#### Windows Configuration (Option) File Example

The installer will also accept a tag-along options file used to configure a minimal install mode.

The options file is a key value assignment that uses the same parameters as on the command line. For example:

```plaintext
unattendedmodeui=none
mode=unattended
prefix=%localappdata%\Polarity\PolarityX
create-server-entry=yes
server-host=kingsnake-api.breachintelligence.net
server-port=443
use-proxy=yes
proxy-host=localhost
proxy-port=8080
```

Execution provides the path to the file with the `--optionfile` parameter:

```plaintext
.\PolarityX-5.0.4-windows-installer.exe --optionfile .\install-options.txt
```

---

## Linux

Running the PolarityX installer from the command line with the `--help` parameter will display the following information:

```plaintext
.\polarity-5.0-linux-x64-installer.run --help
PolarityX 5.0.4
Usage:

 --help                                        Display the list of valid options

 --version                                     Display product information

 --unattendedmodeui <unattendedmodeui>         Unattended Mode UI
                                               Default: minimal
                                               Allowed: none minimal minimalWithDialogs

 --optionfile <optionfile>                     Installation option file
                                               Default: 

 --debuglevel <debuglevel>                     Debug information level of verbosity
                                               Default: 2
                                               Allowed: 0 1 2 3 4

 --mode <mode>                                 Installation mode
                                               Default: gtk
                                               Allowed: gtk xwindow text unattended

 --debugtrace <debugtrace>                     Debug filename
                                               Default: 

 --installer-language <installer-language>     Language selection
                                               Default: en
                                               Allowed: en

 --prefix <prefix>                             The installation directory
                                               Default:  

 --create-server-entry <create-server-entry>   Save server information to Polarity. WARNING: This will overwrite all existing entries. (yes/no)
                                               Default: 0

 --server-host <server-host>                   Hostname or IP address:
                                               Default: 

 --server-port <server-port>                   Port (typically 443):
                                               Default: 443

 --proxy-host <proxy-host>                     Proxy hostname:
                                               Default: 

 --proxy-port <proxy-port>                     Proxy port:
                                               Default: 8443

 --use-proxy <use-proxy>                       Is a proxy required for this connection? (yes/no)
                                               Default: 0

 --start_on_exit <start_on_exit>               Start Polarity
                                               Default: yes

--errortrace <errortrace>                      Error trace filename
                                               Default:
```

#### Linux CLI Example

The following command will install the software and create the first server entry to point to a Polarity Server with a proxy configuration:

```plaintext
.\polarity-5.0-linux-x64-installer.run --unattendedmodeui none --mode unattended --create-server-entry yes --server-host kingsnake-api.breachintelligence.net --server-port 443 --use-proxy yes --proxy-host localhost --proxy-port 8080
```

#### Linux Configuration (Option) File Example

The installer will also accept a tag-along options file used to configure a minimal install mode.

The options file is a key value assignment that uses the same parameters as on the command line. For example:

```plaintext
unattendedmodeui=none
mode=unattended
prefix=~/bin/Polarity/PolarityX
create-server-entry=yes
server-host=kingsnake-api.breachintelligence.net
server-port=443
use-proxy=yes
proxy-host=localhost
proxy-port=8080
```

Execution provides the path to the file with the `--optionfile` parameter:

```plaintext
.\polarity-5.0-linux-x64-installer.run --optionfile .\install-options.txt
```

---

## Advanced Uninstallation

The method for silent uninstallation of the Polarity Desktop Client is simillar in execution, with fewer options available.

```plaintext
/opt/PolarityX/Uninstall_PolarityX --help
PolarityX 5.0.4
Usage:

 --help                                        Display the list of valid options

 --version                                     Display product information

 --debuglevel <debuglevel>                     Debug information level of verbosity
                                               Default: 2
                                               Allowed: 0 1 2 3 4

 --mode <mode>                                 Installation mode
                                               Default: gtk
                                               Allowed: gtk xwindow text unattended

 --debugtrace <debugtrace>                     Debug filename
                                               Default: 

 --installer-language <installer-language>     Language selection
                                               Default: en
                                               Allowed: en
```

#### Example Linux Uninstall

```plaintext
/opt/PolarityX/Uninstall_PolarityX --mode unattended
```