How-to Guides

Steps for a task you already understand. The guides follow the life of an application: building components that use Bondy, securing who can connect and what they can reach, then installing, configuring, deploying and administering the nodes they run on.

Programming with WAMP

Write the components that register, call, publish and subscribe on a realm.

General Conventions

The conventions every WAMP component follows, whatever the pattern.

Calling and Registering Procedures

Register a procedure, call one, and choose an invocation policy.

Publishing and Subscribing

Publish to a topic and subscribe to one, including pattern matching.

Programming with HTTP and Mail

Expose HTTP APIs, call out to HTTP services, and send mail.

Loading an API Gateway Specification

Load an API Gateway specification using the HTTP Admin API.

Using the HTTP Connector

Bridge WAMP RPC calls to upstream HTTP/REST services with step-by-step examples.

Sending Email

Send email from a WAMP client, or on a published event, with idempotency and error handling.

Security

Decide who may connect, how they authenticate, and what an HTTP API or an agent may reach.

Authenticating Clients

Set up a realm so clients authenticate with cryptosign, wampcra or wamp-scram, or a ticket.

Protecting an HTTP API with OAuth2

Require a Bondy OAuth2 access token on API Gateway routes; issue, use and revoke tokens.

Configuring CORS & HTTP Security Headers

Common CORS and HTTP security header configurations for different deployment scenarios.

Giving an Agent Read-Only Access

Adopt the shipped MCP read overlay and scope an agent with a role-restricted ticket.

Installation

Bondy can be deployed anywhere from resource-constrained AMD64/ARM64 edge devices to private, hybrid and public clouds running bare metal, virtual machines and containers. Choose the option best suited to your needs.

Install from Source

Build and install Bondy from source.

Install using Docker

Use the official Docker images for AMD64 and ARM64 architectures.

Install using Kubernetes

See a starter manifest recipe and tailor it based on your needs.

Configuration

Set up the configuration file first, then the listeners and relays a particular deployment needs.

Configuration Basics

Where bondy.conf lives, its syntax, variable replacement, and the OS settings it depends on.

Configuring Network Listeners

Declare the socket inventory: terminate TLS, split audiences, budget an exposed listener, drain a node.

Configuring Mail Relays

Declare a relay, scope it to realms, wire up its credential, and verify it.

Deployment

Take a configured node into production, and move an existing deployment forward.

Running a Cluster

Configure DNS-based peer discovery and bring up a multi-node cluster — there is no join command to run.

Upgrading to 1.0.0

Migrate an existing deployment to the new storage and replication stack.

Linking an Edge Node to a Remote Router

Accept bridges on the remote router, configure the bridge on the edge with its own key and TLS, verify it, and remove it.

Administration

Keep a running deployment healthy: back it up, watch it, trace it, and keep it inside its limits.

Backup and Restore

Export and import realms and security data, or take a cold copy of the storage tree.

Monitoring with Prometheus & Grafana

Run the bundled Prometheus and Grafana stack against your cluster.

Distributed Tracing

Enable OpenTelemetry span export, point it at Tempo, and make Bondy the trace boundary.

Verifying Cluster Convergence

Establish whether replicated state has converged, and whether a cluster that has not is repairing itself or stuck.

Responding to an Alarm

From a raised alarm to its signals, its sanctioned remediation, and a confirmed clear.

Load Regulation and Rate Limiting

How Bondy protects itself from overload and from abuse, and what a client sees when either engages.

Raising Open File Limits

Raise the OS and Docker open-file limit so Bondy never runs out of file handles.

Simplifying Realm Management using Prototypes

Inherit shared configuration and RBAC across a fleet of realms from a single prototype realm.

Exposing an MCP Endpoint

Serve a realm to AI agents: declare the listener, publish interface metadata, connect a client.