Configuring Clarity Connect
- 13 May 2026
- 2 Minutes to read
- Print
- DarkLight
- PDF
Configuring Clarity Connect
- Updated on 13 May 2026
- 2 Minutes to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Learn how to set up Clarity Connect, the virtual appliance that facilitates connections between your On-Premises applications and Clarity.
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
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.
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.
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.
If deploying Clarity Connect on Linux please follow these steps.
Helpful Tips & Troubleshooting
If you are experiencing issues, we’ve documented some helpful tips and troubleshooting steps here.
Was this article helpful?
