---
title: Kafka TCP Integration Guide
slug: litmusedge/how-to-guides/integration-guides/kafka-tcp
description: Learn how to set up the Kafka TCP connector. 
docTags: 
createdAt: 2022-11-24T18:25:20.000Z
---

Review the following guide for setting up an integration between Litmus Edge and a Kafka broker. 

# Before You Begin

You will need access to a Kafka-TCP broker. 

Refer to the following links to learn more:

- [Apache Kafka Download](https://kafka.apache.org/downloads) 
- [Confluent Platform Docs](https://docs.confluent.io/platform/current/overview.html)

# Step 1: Set up the Kafka-TCP server

You will need to set up the Kafka server so that it is ready to connect with Litmus Edge. 

If you are using a docker-compose yaml file, do the following:

1. Connect and log in to the Kafka-TCP broker.
2. From the command screen cursor, enter **cat docker-compose.yml**.
   The services list appears. 
3. From the cursor, enter **docker-compose up**. 
   The TCP\_Zookeeper and TCP\_Kafka start up.

# Step 2: Add Device

Follow the steps to [Connect a Device](docId:3eyAfPpweuVmBLCEy17sq). The device will be used to store tags that will be eventually used to create outbound topics in the connector. Make sure to select the **Enable Data Store** checkbox. 

# Step 3: Add Tags

After connecting the device in Litmus Edge, you can [Add Tags](docId:8sE7z3PmRfwL1nmzcwaLX) to the device. Create tags that you want to use to create outbound topics for the connector. 

# Step 4: Add the Kafka TCP Connector

Follow the steps to [Add a Connector](docId\:ytsWGWeU6H6oEUnHj5hW3) and select the **Kafka TCP **provider. 

Configure the following parameters. 

- **Name**: Enter a name for the connector. 
- **Brokers list separated by comma**: Enter the Kafka broker URL. For example: 192.168.56.1. 
- **SASL mechanism**: Select an option: NONE, SASL\_PLAINTEXT, SCRAM-SHA-256, SCRAM-SHA-512. 
- **Username **(Optional): If needed, enter the username to access the broker. 
- **Password**: (Optional): If needed, enter the password associated with the username. 
- **Topic**: Enter the name of the default topic used for publishing data. 
- **Throttling Limit**: The maximum number of messages per second to be processed. The default value is zero, which means that there is no limit. 
- **Persistent storage**: When enabled, this will cause messages to undergo a store-and-forward procedure. Messages will be stored within Litmus Edge when cloud providers are online.  
- **Queue Mode**: Select the queue mode as **lifo **(last in first out) or **fifo **(first in first out). Selecting **lifo **means that the last data entry is processed first, and selecting **fifo **means the first data entry is processed first. 

# Step 5: Enable the Connector

After adding the connector, click the toggle in the connector tile to enable it. 

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/HqToSsPP9uscm-8KNFJzO_kafkatcp.png" size="60" width="388" height="358" position="center" showCaption="false"}

If you see a *Failed *status, you can review the [Connector Logs](docId\:BEQQ0sSzwsv9v9rIF3rhk) and relevant error messages. 

# Step 6: Create Topics for Connector 

You will now need to import the tags you added in Step 3 to the connector as topics. 

:::hint{type="info"}
Topics must already exist on the Kafka server to avoid errors. Using non-existent Kafka topics will result in errors in logs, failed connection and/or persisted storage.
:::

**To create outbound topics:**

1. Click the connector tile.
   The connector *Dashboard *appears. 
2. Click the **Topics **tab. 
3. Click the **Import from DeviceHub** tags icon. 
   The *DeviceHub Import *dialog box appears.

![](https://api.main.archbee.co/api/optimize/xSuIWwMa6RnsbeD5Kdqd7-zaOGMDYbPZWYALvLBgotp-20250606-203859.png)

After adding all required topics, navigate to the Integration overview page and ensure the connector is not disabled and still shows a CONNECTED status. 

# Step 7: Enable Topics

Ensure the topics you imported are enabled by returning to the *Topics *tab and clicking the **Enable all topics** icon. 

![](https://api.main.archbee.co/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/HtkW-nbWXeAvOV8ru8B1U_image.png)

# Step 8: Verify Connection

Access the Kafka broker and verify that Litmus Edge is successfully sending data.