Orbital home page

Introduction

Getting started

Orbital automates integration for your microservices.

Get started right now, by spinning up Orbital on your machine

curl -sSL https://start.orbitalhq.com/start.sh | bash

Then visit http://localhost:9022 in your browser.

The script will set up everything you need and open Orbital automatically when it’s ready.

​
What is Orbital?

Orbital is a data gateway that automates the integration, transformation and discovery of data from data sources (API’s, databases, message brokers) across your enterprise.

Orbital integrates on-the-fly, automatically adjusting as your data sources change.

This is powered by rich semantic schemas, which infer how data across your organisation links together, and automate the integration and discovery of data.

​
Quick Links

Once you have Orbital running locally, connect your microservices, and start querying for data

Connecting data sources

Connect your APIs, Databases and Message Queues to Orbital.

Querying

Query for data through Orbital's API, and let Orbital handle the integration plumbing for you.

Follow a guide

A handful of guides to help get productive with Orbital

Head to production

Deploy Orbital on your Kubernetes cluster or using Docker Compose

​
What the install script does

The start.sh script is a small wrapper around our Docker Compose file. It handles the setup steps that would otherwise trip you up, so you can get straight to working with Orbital.

Specifically, it:

  • Detects your OS (Mac, Linux or Windows), so it can fetch the right Docker Compose file - this matters because our local testing tool, Nebula, needs OS-specific networking to launch Docker containers
  • Creates the directories Orbital writes to (config, workspace, prometheus_data) before Docker does, so that files Orbital creates are owned by you, and editable from your IDE without permission errors
  • Creates a .env file containing your UID and GID, so the Orbital container runs as you, rather than as root
  • Downloads the OS-specific docker-compose.yml from start.orbitalhq.com
  • Runs docker compose up -d, then waits for Orbital’s health endpoint to be ready before opening it in your browser

You can also pass a project to clone on first launch:

curl -sSL https://start.orbitalhq.com/start.sh | bash -s -- https://github.com/your/repo

If you’d prefer to do this yourself, you can download the docker-compose directly from start.orbitalhq.com - the script’s source has more notes on the manual setup.

​
Getting help

Stuck? Need help? Have an idea? We’d love to hear from your.

You can connect with the Orbital team in a number of ways

Next
Overview