connect

(β˜… 8,730)

Fancy stream processing made operationally mundane

  • .codebook.toml
  • .dockerignore
  • .gitignore
  • .golangci.yml
  • .versions
  • .yamlfmt
  • CHANGELOG.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • go.mod
  • go.sum
  • Makefile
  • README-FIPS.md
  • README.md
  • SECURITY.md
  • Taskfile.yml
  • tools.go

# Installation Guide

1. Get the code
git clone https://github.com/redpanda-data/connect

Downloads the entire project code from GitHub to your computer.

cd connect

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install redpanda-data/tap/redpanda

Installs the pre-built package via Homebrew β€” no source build required.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull docker.redpanda.com/redpandadata/connect

Type this command into your terminal and run it.

docker run --rm -v /path/to/your/config.yaml:/connect.yaml docker.redpanda.com/redpandadata/connect run

Runs the built image as an actual container.

docker run --rm -p 4195:4195 docker.redpanda.com/redpandadata/connect run \

Runs the built image as an actual container.

task docker:all

Type this command into your terminal and run it.

docker run --rm \

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r resources/plugin_uploader/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

5. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go install -tags "x_benthos_extra" github.com/redpanda-data/connect/v4/cmd/redpanda-connect@latest

Type this command into your terminal and run it.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation