Running OpenLegacy Hub Enterprise Light

This guide explains how to run OpenLegacy Hub Enterprise Light using Docker, making deployment fast and consistent across different environments.

Prerequisites

Docker: Installed and running on your server or workstation.

Running the Hub with Docker

To launch OpenLegacy Hub Enterprise Light, use the following Docker image:

openlegacy/hub-enterprise-light:<tag>

Replace <tag> with the required version (e.g., latest or a specific version number).

Basic Command

docker run -d \
	--name ol-hub-light \
	-p 8080:8080 \
	openlegacy/hub-enterprise-light:<tag>

This command:

Runs the container in detached mode.
Names the container ol-hub-light.
Maps container port 8080 to host port 8080.
Uses the specified image tag.

Access the GUI at: http://localhost:8080

Environment Variables for External PostgreSQL Database

To use an external PostgreSQL database, set the following environment variables when running the container:

EXTERNAL_DB=true
OL_DB_PORT=<port>
OL_DB_HOST=<host>
OL_DB_USER=<username>
OL_DB_PASSWORD=<password>
OL_DB_NAME=<dbname>
OL_DB_POOL_SIZE=<poolsize>

Example:

docker run -d \
	--name ol-hub-light \
	-p 8080:8080 \
	-e EXTERNAL_DB=true \
	-e OL_DB_PORT=5432 \
	-e OL_DB_HOST=host.com \
	-e OL_DB_USER=postgres \
	-e OL_DB_PASSWORD=mypassword \
	-e OL_DB_NAME=db \
	-e OL_DB_POOL_SIZE=5 \
	openlegacy/hub-enterprise-light:<tag>

📘
By default, the container runs with an embedded, local PostgreSQL database. The external database option is only for advanced users and does not include enterprise authentication features.

Docker Compose

version: '3.7'

services:
  ol-hub-light:
    image: openlegacy/hub-enterprise-light:<tag>
    container_name: ol-hub-light
    ports:
      - "8080:8080"
    environment:
      # Uncomment and set values for external DB configuration
      # EXTERNAL_DB: "true"
      # OL_DB_PORT: "5432"
      # OL_DB_HOST: "host.com"
      # OL_DB_USER: "postgres"
      # OL_DB_PASSWORD: "mypassword"
      # OL_DB_NAME: "db"
      # OL_DB_POOL_SIZE: "5"
      restart: unless-stopped

# To use an external PostgreSQL database, uncomment the environment variables above and provide your own values.

Usage Instructions:

Replace <tag> with your required image version (e.g., latest).
Run the following command to start the container: docker compose up -d
Access the GUI at http://localhost:8080