Server

Orbit Server can be run right out of the box, with several easy ways to get started.

Docker container

The simplest way to start an Orbit Server for development is in a Docker container from the Docker Hub image.

> docker run -it -p 50056:50056 orbitframework/orbit:2.0.0-alpha.108

Kubernetes

Orbit Server comes packaged as a helm chart hosted on Github. Include Orbit Server as a dependency in your application’s helm charts.

dependencies:
- name: orbit
  version: 2.0.0-alpha.108
  repository: https://www.orbit.cloud/orbit
  condition: enabled

To configure Orbit, set overrides in a values.yaml file or use the –setValues switches when running helm install.

orbit:
  url: localhost
  node:
    replicas: 1
    containerPort: 50056
  addressableDirectory:
    replicas: 1
  nodeDirectory:
    replicas: 1

Hosted

Most scenarios are supported with the turnkey methods above. For some advanced situations, it may be preferred to host the Orbit Server runtime within an existing server application.

For help on hosting Orbit Server, check out the Hosting page.

The best example of hosting the Orbit Server components can be found in the orbit-application module.