Skip to content

From Source

The following instructions show how to build and install Oura from source code.

Pre-requisites

  • Rust toolchain

Procedure

git clone git@github.com:txpipe/oura.git
cd oura
cargo install --path .

This builds the same batteries-included plugin set as the pre-built releases.

Enabling the remaining integrations

A few integrations are not bundled because they need a special build environment. Enable them explicitly once their prerequisites are installed:

# example: build with the Kafka sink and the Mithril source
cargo install --path . --features kafka,mithril
FeaturePrerequisite
kafkabuilds a vendored OpenSSL (its only TLS backend): a C compiler and Perl
zeromqa system libzmq (install via your OS package manager)
mithrilnone, but builds a heavy GMP/blst C-crypto toolchain (slow build)
wasmnone (pure Rust), but adds a large WASM runtime

--all-features requires a system libzmq (for zeromq) and builds mithril’s heavy C-crypto toolchain, so it is slow and best avoided unless you need it.