Runbeam logo
Quick Start Guide

Getting Started with Runbeam

Start building secure interoperability across trust boundaries in minutes. Register your account and deploy the Harmony proxy to enable cross-organisation data exchange.

Simple Setup

Two steps to secure data exchange

Runbeam combines cloud-based orchestration with distributed gateway instances. Follow these two simple steps to get started.

Step 1

Register Your Account

Create your Runbeam account to access the cloud control plane. You'll be able to manage policies, monitor gateway instances, and configure secure data exchange across your organisation.

Cloud-based policy management
Centralised audit and monitoring
Gateway orchestration dashboard
Create Account
Step 2

Download Harmony Proxy

Deploy the Harmony proxy on-premises, at the edge, or in your cloud environment. The proxy handles protocol transformation, secure connectivity, and data routing under Runbeam's centralised control.

Deploy behind your firewall
Zero inbound network access required
HTTP/3 secure connectivity
Download Harmony Proxy
Platform Capabilities

What you get with Runbeam

Secure by Default

Zero-trust architecture with HTTP/3 connectivity, TLS 1.3 encryption, and policy-controlled ingress and egress for regulated environments.

Protocol Agnostic

Support for FHIR, HL7, DICOM, REST APIs, and custom protocols. Transform and route data across legacy and modern systems.

Cloud Control Plane

Centralised orchestration, policy management, and monitoring for all distributed gateway instances across your infrastructure.

Compliance Ready

Audit trails, encryption, and policy enforcement designed for HIPAA, GDPR, and other regulatory frameworks in healthcare, government, and critical infrastructure.

Hybrid Deployment

Deploy gateways on-premises, at the edge, or in the cloud. Manage everything from the Runbeam cloud control plane without exposing internal networks.

Developer Friendly

RESTful APIs, extensive documentation, and pre-built workload templates. Customise transformations, routing, and middleware with code.

Installation Guide

Deploy in minutes

Once you've registered and downloaded the Harmony proxy, follow these steps to connect your first gateway instance.

1

Install the Harmony proxy

Deploy using Docker, pre-built binaries, or build from source. The proxy runs on-premises or in your cloud environment.

Docker (Recommended)
docker pull ghcr.io/aurabx/harmony:latest
Linux/macOS Binary
curl -LO https://github.com/aurabx/harmony/releases/latest/download/harmony-[platform].tar.gz

See the installation guide for detailed platform-specific instructions.

2

Create a configuration file

Define your pipelines, data sources, and targets in a TOML configuration file. Start with an example configuration or create your own.

Example Configuration
git clone https://github.com/aurabx/harmony.git
cp harmony/examples/basic-echo/config.toml my-config.toml

Browse workload templates for pre-built pipeline configurations.

3

Run Harmony with your configuration

Start the Harmony proxy with your configuration file. The proxy will listen for incoming requests and route data according to your pipeline definitions.

Start Harmony
harmony --config /path/to/config.toml
4

Connect to Runbeam cloud (optional)

For centralised orchestration, connect your gateway to the Runbeam cloud control plane. This enables policy management, monitoring, and audit trails across multiple gateway instances.

See the authentication guide for connecting to Runbeam cloud.

Common Applications

Built for regulated industries

Runbeam is a secure interoperability platform used across healthcare, government, and critical infrastructure to enable cross-organisation data exchange without exposing internal networks.

Healthcare Interoperability

Connect EMR systems, PACS archives, and health information exchanges using FHIR, HL7, and DICOM protocols. One example of Runbeam's multi-vertical platform capabilities.

Government Data Exchange

Securely share data across agencies with policy-controlled access, audit trails, and compliance enforcement for sensitive government workloads.

Cross-Organisational Integration

Enable secure data exchange with partners, suppliers, and customers using Data Mesh networking without VPN sprawl.

AI Model Deployment

Move data and AI models between on-premises systems and cloud platforms securely, enabling regulated AI deployment behind firewalls.

Resources

Ready to get started?

Register your account and download the Harmony proxy to start building secure interoperability across trust boundaries.

Documentation

Complete guides, API references, and tutorials for building with Runbeam.

View docs →

Workload Templates

Pre-built pipeline templates for common integration scenarios.

Browse templates →

Prefer a Call?

Get in touch with our team for personalised guidance and support.

Contact us →