README.md

OADA DooD Image

A "single image" (using DooD) version of the OADA reference API server.

This is only meant for testing and development purposes, DO NOT USE THIS IN PRODUCTION.

Usage

This image can be used to boostrap an OADA instance on your local machine. The only requirement is Docker.

# Must volume mount docker socket for DooD
# $PORT is the host port to bind for OADA HTTP
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -p $PORT:80 \
  ghcr.io/qlever-llc/oada

GitHub Actions

The image can also be used to deploy an oada service in GitHub Actions.

services:
  oada:
    image: ghcr.io/qlever-llc/oada
    # API exposes HTTP on port 80
    ports:
      - 80
    # Needed for DooD
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock"

You can then access OADA at its randomly assigned host port with

http://localhost:${{ job.services.oada.ports['80'] }}

or at http://oada from inside a container.