Linux Deployment (Debian)

To deploy Clarity Connect on Linux, you will use the native Docker Engine. This guide is optimized for Debian-based distributions (Debian, Ubuntu) which provide the highest stability for the Clarity stack.

Prerequisites
Operating System: Debian 11/12 or Ubuntu 22.04/24.04 LTS.

Hardware: Minimum 64-bit kernel with virtualization enabled.

Optimal Resources: 2 CPU, 4GB RAM, 16GB storage.

Permissions: All commands must be run with sudo privileges.

Step 1: Update System and Install Dependencies

Before installing Docker, ensure your package database is up to date and that the required transport tools are installed.

sudo apt-get update
sudo apt-get install curl

Step 2: Install Docker Engine

We recommend using the official Docker convenience script to ensure the correct Community Edition (CE) version is installed.

curl -fsSL [https://get.docker.com](https://get.docker.com) -o get-docker.sh
sudo sh get-docker.sh

Step 3: Configure User and Permissions

By default, Docker requires root privileges. To allow Clarity Connect to run securely, add your current user to the docker group and start the service.

sudo usermod -aG docker $USER
sudo service docker start

Note: You may need to log out and back in for the group membership to take effect.

Step 4: Install Docker Compose Plugin

Clarity Connect uses a multi-container stack. You must install the Compose plugin to manage these services together.

sudo apt-get install docker-compose-plugin

Step 5: Verify Installation

Confirm that the Docker engine and the Compose plugin are communicating correctly with the system.

docker version
docker compose version

Step 6: Deploying Clarity Connect

1. Create a permanent directory for your configuration (e.g., /opt/clarity/).

2. Place your downloaded docker-compose.yml file into that directory.

3. Open a terminal in that directory and start the appliance:

   sudo docker compose up -d

The final output should look similar to the following image if completed successfully: