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

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

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.

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

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.

Helpful Tips: 

To check if your docker containers are up and running, you can run the following command:

docker ps

To stop the containers run the following command (this relies on the same docker-compose.yml file to be in the working directory):

docker-compose down

If networking errors occur within the docker containers themselves, you may see errors like "unable to resolve network address" or "trouble contacting host 'redis'". The simplest way to resolve these is to restart all of the containers and the network itself. This can be done using "docker-compose down". This should stop all of the running containers and remove the network. Verify this by running "docker ps -a". You should see nothing listed. If you do see containers that are still running, you can manually remove them by running "docker container rm [container name]". After you've removed all running containers, you can restart them by running "docker-compose up -d".

docker-compose down
docker ps -a
docker container rm clarityconnectmain
docker-compose up -d

Need Help?