Skip to content

synadia-io/connect

Repository files navigation

Connect

Connect is a NATS based data pipeline that allows you to easily connect data sources and sinks to NATS. Connect is built on top of the NATS ecosystem and uses the NATS server as a message broker. Connect is designed to be easy to use and scalable, allowing you to connect multiple data sources and sinks to NATS.

Important

This project merely provides the connect CLI and SDK to interact with the connect service. The connect service is currently hosted by Synadia during a private beta, but we do want to let you all know what we are working on and get feedback. If you have any questions, feel free to reach out in the #connectors channel on the NATS slack.

Installation

Download the connect binary from the releases page and place them in your PATH.

Make sure you are using the right nats context

nats context select

To make sure your binary is correct and everything is up and running, try listing the available components:

connect library ls

Once you have the binary correctly installed, you may want to move on to create your first connector. Take a look at the getting started guide for more information on how to accomplish that.

Another useful resource is the connector specification which details the structure of a connector.

Further reference documentation can be found in the Connector Reference documentation

Usage

You can use the connect command to interact with the connect service and manage connectors or explore the library.

Take a look at the help page to see what you can do:

connect --help

Contributing

We love to get feedback, bug reports, and contributions from our community. If you have any questions or want to contribute, feel free to reach out in the #connectors channel on the NATS slack.

Take a look at the Contributing guide to get started.