Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting Started

This section covers building Meridian from source, running it with a configuration file, and a quick start example that proxies traffic to a backend service.

Requirements

  • Rust stable toolchain (edition 2021)
  • Cargo (comes with Rust)
  • Linux, macOS, or Windows (Linux recommended for production)

Quick Overview

# Build
cargo build --release

# Run with a config file
cargo run --release -p meridian-proxy -- meridian-proxy/meridian.toml

# Run tests
cargo test --workspace

Meridian reads a TOML configuration file that defines listeners (where to accept traffic), clusters (groups of backend endpoints), and routes (which paths map to which clusters).