Installation

Prerequisites

Docker
Docker Compose

Installation

Docker Compose File

Create a new file called docker-compose.yml in the root of your project

Without Database

docker-compose.yml


services:
  backend:
    image: 'bshsolutions/engine:latest'
    container_name: 'engine-backend'
    ports:
      - '7071:7071'
    environment:
      - 'BSH_CONFIG={}'

With Database

docker-compose.yml


services:
  backend:
    image: 'bshsolutions/engine:latest'
    container_name: 'engine-backend'
    ports:
      - '7071:7071'
    environment:
      - 'BSH_CONFIG={}'
    depends_on:
      - postgres
    networks:
      - engine-net
 
  postgres:
    image: 'postgres:latest'
    container_name: 'engine-postgres'
    environment:
      - 'POSTGRES_DB=engine'
      - 'POSTGRES_PASSWORD=password'
      - 'PGDATA=/var/lib/postgresql/data'
      - 'POSTGRES_USER=engine'
    ports:
      - '5432:5432'
    volumes:
      - ./data/engine-postgres-data:/var/lib/postgresql/data
    networks:
      - engine-net
 
networks:
  engine-net:
    name: engine-net
    driver: bridge
 
volumes:
  engine-postgres-data:

CLI

This will generate the docker-compose.yml (including database) file and the .env file for you.


bsh docker setup
# or
npx @bshsolutions/cli docker setup

Environment Variables

The engine requires one env variable BSH_CONFIG, read this docs for more details.

Run the Engine

Run the following command to start the engine:


docker compose up -d

The engine will be available at http://localhost:7071 or any domain you configured.

Check status

After the engine is running, check its status at http://localhost:7071/status to make sure everything is well configured before you start using it.

Explore the Endpoints

After the engine is running, you can fork the BSH Engine Postman collection from the postman workspace to use the exposed endpoints. You can also import the collection into your own Postman workspace.

BSH Engine Collection

The collection is updated whenever after each release.