Connect

Build or Upgrade from Source

You can build Redpanda Connect in two ways. Each build command on this page matches the Redpanda Connect release build of the same type.

  • Standard build: Suitable for most users. Builds with cgo disabled, like the standard release binaries, and leaves out the components that need cgo.

  • cgo-enabled build: Required only for the components listed below. The build needs a C compiler and the ZeroMQ development headers (libzmq).

These components are available only in the cgo-enabled build:

Each component’s reference page also notes when the component needs cgo.

Install from source

  1. Ensure you have Go installed on your system. You can download it from the official Go website.

  2. For the cgo-enabled build only, install a C compiler and the ZeroMQ library with its development headers. For example, on Debian or Ubuntu:

    sudo apt-get install build-essential libzmq3-dev

    The machine that runs a cgo-enabled build also needs the ZeroMQ shared library, because the binary links to it dynamically.

  3. Clone the Redpanda Connect repository:

    git clone https://github.com/redpanda-data/connect.git
cd connect

  4. Build the binary (choose one):

    Build type Build command

    Standard (no cgo, most users)

    		 
    CGO_ENABLED=0 go build -tags timetzdata -o redpanda-connect ./cmd/redpanda-connect

    cgo-enabled (adds the components that need cgo)

    		 
    CGO_ENABLED=1 go build -tags x_benthos_extra,timetzdata -o redpanda-connect ./cmd/redpanda-connect

    The timetzdata build tag embeds the time zone database in the binary, so time zone lookups work on systems that don’t have one installed. The x_benthos_extra build tag adds the components that link to external libraries.

  5. Move the binary to a directory in your PATH (for example, /usr/local/bin):

    sudo mv redpanda-connect /usr/local/bin/

  6. Verify the installation:

    redpanda-connect --version

You should see a version.

Upgrade a source build

  1. Navigate to your existing clone of the repository:

    cd connect

  2. Fetch the latest tags and check out the version you want:

    git fetch --all
git checkout v4.113.0

  3. Rebuild the binary (choose one):

    Build type Build command

    Standard (no cgo, most users)

    		 
    CGO_ENABLED=0 go build -tags timetzdata -o redpanda-connect ./cmd/redpanda-connect

    cgo-enabled (adds the components that need cgo)

    		 
    CGO_ENABLED=1 go build -tags x_benthos_extra,timetzdata -o redpanda-connect ./cmd/redpanda-connect

  4. Replace the previous binary and verify:

    sudo mv redpanda-connect /usr/local/bin/
redpanda-connect --version
After upgrading (or downgrading), you must restart a pipeline to use features in the Redpanda Connect version you have deployed.

Uninstall

To uninstall Redpanda Connect, remove the installed binary:

sudo rm /usr/local/bin/redpanda-connect

This removes the Redpanda Connect binary from your system.

Next steps

Explore the available connectors in the catalog.