Installation
Detailed installation instructions for all platforms.
3 min readGetting Started
Building from Source
StreamHouse is written in Rust and can be compiled from source on any platform with a Rust toolchain.
bash
# Install Rust (if not already installed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Clone and build
git clone https://github.com/streamhouse/streamhouse.git
cd streamhouse
cargo build --release
# The binary will be at target/release/streamhouse-server
./target/release/streamhouse-server --helpDocker Image
Pre-built Docker images are available on Docker Hub for quick deployment.
bash
# Pull the latest image
docker pull streamhouse/streamhouse:latest
# Run with default configuration
docker run -p 8080:8080 -p 9092:9092 streamhouse/streamhouse:latestConfiguration
StreamHouse is configured through environment variables or a TOML configuration file. The most important settings are the metadata store connection and S3 bucket configuration.
toml
# config.toml
[server]
host = "0.0.0.0"
port = 8080
grpc_port = 9092
[metadata]
backend = "postgres"
url = "postgresql://localhost:5432/streamhouse"
[storage]
backend = "s3"
bucket = "streamhouse-data"
region = "us-east-1"
[storage.cache]
enabled = true
max_size_mb = 512Verify Installation
After installation, verify that StreamHouse is running correctly.
bash
# Check health endpoint
curl http://localhost:8080/api/health
# Expected response:
# {"status":"healthy","version":"0.1.0","uptime_seconds":42}