Software Documentation
Reference documentation for local setup, hub architecture, configuration, authentication, RPC behavior, and connector development.
This page is generated from the Open Location Hub source documentation and should not be edited in the website repository.
Reference documentation for local setup, hub architecture, configuration, authentication, RPC behavior, and connector development.
Start here if you want the laptop-friendly local runtime:
Core hub docs:
Connector docs:
Connector demonstrators live outside the hub runtime under
connectors/.
Shared connector-agnostic utility scripts live under
scripts/.
The shared local runtime is documented in
local-hub/README.md.
Connector examples currently include
connectors/gtfs/README.md
and
connectors/opensky/README.md,
plus
connectors/replay/README.md.
API Reference
Interactive OpenAPI reference for the Open Location Hub REST contract.
Architecture
Generated documentation page for Architecture.
Authentication and Authorization
This project supports standards-based JWT bearer authentication for the REST API and an authorization model built around JWT claims plus a server-side permissions file.
Configuration
All runtime configuration is environment-driven.
Connector Guide: MQTT
Use MQTT when your deployment already centers on a broker, when trusted edge adapters naturally publish broker messages, or when broker-based routing fits better than a long-lived WebSocket client connection.
Connector Guide: WebSocket
Use WebSocket when you want the simplest connector path into the hub. It maps well to the current bundled demos, it works cleanly with the hub's auth model, and it does not require you to design topic routing beyond the OMLOX WebSocket topic names.
Connectors
This repository keeps connectors outside the hub runtime. A connector is a small process that reads data from some upstream system, maps that data to the hub's OMLOX-facing model, and submits it through the hub's supported transport surfaces.
Getting Started
If you want to try Open RTLS Hub on your laptop, start with the shared local runtime in [`local-hub/`](https://github.com/Open-Location-Stack/open-location-hub/blob/main/local-hub). That setup brings up the hub, Postgres, Mosquitto, Dex, and a ready-to-use observability stack so you can inspect what the hub is doing while you experiment.
RPC Guide
RPC is the hub's command and diagnostics interface.