---
title: "Configuring Clarity Connect"
slug: "configuring-clarity-connect"
updated: 2026-05-13T17:59:19Z
published: 2026-05-13T17:59:19Z
canonical: "help.claritysecurity.com/configuring-clarity-connect"
---

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

# Configuring Clarity Connect

Learn how to set up Clarity Connect, the virtual appliance that facilitates connections between your **On-Premises** applications and Clarity.

![](https://cdn.document360.io/2d020999-1823-4d4d-b6d2-4b52fb4a9617/Images/Documentation/image-1718727196059.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A15Z&se=2026-10-30T12%3A27%3A15Z&sr=c&sp=r&sig=bURBrcvmoeZ8Dbap9Xxobao6GPOd0Mtz%2Fm%2BOcLvCss8%3D)

## Before You Begin

> **Connection Requirements**
> 
> The on-prem appliance (Clarity Connect) will need internet access to docker and AWS, so that the docker container stack can build, update etc. This can be deployed on either a Windows or Linux Virtual Machine. The Clarity docker containers do not take up very much storage (<2GB), but keep in mind your VM will need storage for the OS and docker software installation as well.
> 
> **Docker Host Requirements:**
> 
> Optimal: 2 CPU, 4GB RAM,16GB storage
> 
> Minimum: 64bit kernel with virtualization enabled, 4GB RAM, 8GB storage **Firewall Requirements:** Internally, the appliance only needs to be able to contact your configured on-prem services on the various ports required for the service. Externally, Clarity Connect needs to be able to reach your Clarity tenant.
> 
> | Source | Destination | Direction | Port | Notes |
> | --- | --- | --- | --- | --- |
> | Clarity Connect | Clarity Tenant | Outbound | 443 |  |
> | Clarity Connect | Active Directory | Outbound | 636 | If we are connecting to AD for provisioning |
> | Clarity Connect | Active Directory | Outbound | 389 | If we are connecting to AD for read only |
> | Clarity Connect | MySQL | Outbound | 3306 |  |
> | Clarity Connect | Microsoft SQL Server | Outbound | 1433 |  |
> | Clarity Connect | LDAPS | Outbound | 636 |  |

## How to Setup Clarity Connect

### Step 1: Log in to your Clarity Security tenant

> https://your-tenant.claritysecurity.io

### Step 2: Click on Applications, then Clarity Connect

![Clarity Connect button on Applications](https://cdn.document360.io/2d020999-1823-4d4d-b6d2-4b52fb4a9617/Images/Documentation/image-1677267059766.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A15Z&se=2026-10-30T12%3A27%3A15Z&sr=c&sp=r&sig=bURBrcvmoeZ8Dbap9Xxobao6GPOd0Mtz%2Fm%2BOcLvCss8%3D)

### Step 3: Click on Get Started

Click on the Get Started button to start creating your first Clarity Connect instance. You will need to choose a name for your instance in the next step.

![Get Started button for Clarity Connect](https://cdn.document360.io/2d020999-1823-4d4d-b6d2-4b52fb4a9617/Images/Documentation/image-1677267314836.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A15Z&se=2026-10-30T12%3A27%3A15Z&sr=c&sp=r&sig=bURBrcvmoeZ8Dbap9Xxobao6GPOd0Mtz%2Fm%2BOcLvCss8%3D)

### Step 4: Name your instance

Give your Clarity Connect instance a helpful nickname. You may want to include useful information such as the application the instance will be connected to (Oracle, SQL, AD, etc.) or the infrastructure it is hosted on in your environment.

Note

*Choosing "Oracle Compatible" means other on-prem connection types may not be compatible with this container. If you have an on-premise Oracle DB and Active Directory, you will need multiple instances of Clarity Connect (one Oracle compatible, one not).*

  

Due to the nature of how docker containers are named, if you attempt to launch two or more docker-compose.yml files on one system, the names of the containers will conflict.

  

You might want to do this because you have one docker host system, but would like to have compatibility with both on-prem Active Directory and an Oracle database.

![Name your CC instance](https://cdn.document360.io/2d020999-1823-4d4d-b6d2-4b52fb4a9617/Images/Documentation/image-1677267592678.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A15Z&se=2026-10-30T12%3A27%3A15Z&sr=c&sp=r&sig=bURBrcvmoeZ8Dbap9Xxobao6GPOd0Mtz%2Fm%2BOcLvCss8%3D)

### Step 5: Copy the file

Copy this file to your system running Docker, and store it in a logical permanent location (Downloads folder is not recommended).

IMPORTANT

Your docker-compose.yml file contains sensitive data that allows Clarity Connect to make secure api calls. Do not share this file with anyone outside of your organization.

## Windows / Linux Deployment

- [If deploying Clarity Connect on Windows please follow these steps.](/home/docs/windows-deployment)
- [If deploying Clarity Connect on Linux please follow these steps.](/home/docs/linux-deployment)

### Helpful Tips & Troubleshooting

[If you are experiencing issues, we’ve documented some helpful tips and troubleshooting steps here.](/home/docs/helpful-tips-troubleshooting)

## 

Clarity Connect is a virtual appliance which establishes a connection between on-premise applications and a Clarity tenant.