Skip to main content

Quickstart

The fastest way to get started and experiment with Snowbridge is to run it via the command line:

  1. Download the pre-compiled ZIP from the releases
  2. Unzip and run the binary with eg. echo "hello world" | ./snowbridge

The defaults for the app are stdin source, no transformations, and stdout target - so this should print the message 'hello world' along with some logging data to the console.

Next, the app can be configured using HCL - simply create a configuration file, and provide the path to it using the SNOWBRIDGE_CONFIG_FILE environment variable.

You can find a guide to configuration in the configuration section, and a guide to deployment in the deployment page.

Telemetry notice

By default, Snowplow collects telemetry data for Snowbridge (since version 1.0.0). Telemetry allows us to understand how our applications are used and helps us build a better product for our users (including you!).

This data is anonymous and minimal, and since our code is open source, you can inspect what’s collected.

If you wish to help us further, you can optionally provide your email (or just a UUID) in the user_provided_id configuration setting.

If you wish to disable telemetry, you can do so by setting disable_telemetry to true.

See our telemetry principles for more information.