Configuring Clarity Connect (On-Premises)
Learn how to set up Clarity Connect, the virtual appliance that facilitates connections between your On-Premises applications and Clarity.
Estimated time to complete: 5-30 minutes
If you run into any problems, please contact your support team or email@example.com.
Before You Begin
You'll need the following before you begin:
Docker (and Docker Compose) installed and working with network access to your desired on-prem applications.
You can check if docker compose is installed by running the command docker. This command will only work if docker is already installed.
You may need to scroll up to find the Management Commands section, compose* should be listed with a version number if it is installed.
Each Clarity Connect instance you create consists of 3 docker containers (Clarity Connect, Redis, and Watchtower).
The on-prem appliance (Clarity Connect) will need internet access to docker and AWS, so that the docker container stack can build, update etc. (all of this traffic is over port 443).
Internally, the appliance only needs to be able to contact your configured on-prem services on the various ports required for the service. LDAPS (port 636), MySQL (3306), MS-SQL (1433), etc.
Docker Host Requirements (any flavor of Linux that can run Docker on x86-64 architecture.)
Optimal: 2 CPU 4GB RAM
Minimum: 64bit kernel with virtualization enabled, 4GB RAM
How to Setup Clarity Connect
Step 1: Log in to your Clarity Security tenant
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.
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).
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.
Step 6: Run the Docker Compose Start Command
Navigate to the directory containing the docker-compose.yml file from the previous step and run the following command (depending on your Docker version the command may vary slightly, docker compose up -d vs docker-compose up -d).
docker-compose up -d
The final output should look similar to the following image if completed successfully.
To check if your docker containers are up and running, you can run the following command:
To stop the containers run the following command (this relies on the same docker-compose.yml file to be in the working directory):
docker ps -a
docker container rm clarityconnectmain
docker-compose up -d
If you have any problems, contact your customer success team. You can also get in touch with our general support via email, open a support ticket. Our general support team is available Monday - Friday from 8:00 AM - 6:30 PM CST.