Setting Up the Submodel Registry

Setting Up the Submodel Registry#

We provide example Set-Ups to get you started with the BaSyx Go Components on our GitHub Repository. But if you need to configure the service yourself, this page will guide you through.

Using Docker Compose#

The easiest way to use and set-up the Submodel Registry is Docker Compose.

The minimal configuration includes two services:

  1. PostgreSQL (>=15)

  2. BaSyx Submodel Registry (Go)

services:
  postgres:
    image: postgres:18
    container_name: postgres_basyx
    environment:
      POSTGRES_USER: admin
      POSTGRES_PASSWORD: admin123
      POSTGRES_DB: basyxTestDB
    command: ["postgres", "-c", "listen_addresses=*"]
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U admin -d basyxTestDB"]
      interval: 10s
      timeout: 5s
      retries: 5

  submodel_registry:
    image: eclipsebasyx/submodelregistry-go:SNAPSHOT
    environment:
      - SERVER_PORT=5004
      - POSTGRES_HOST=postgres
      - POSTGRES_PORT=5432
      - POSTGRES_USER=admin
      - POSTGRES_PASSWORD=admin123
      - POSTGRES_DBNAME=basyxTestDB
    ports:
      - "YOURPORT:5004"
    depends_on:
      postgres:
        condition: service_healthy

docker-compose.yml including PostgreSQL 18 and BaSyx Go Submodel Registry

Access Rules and Trustlist Files (Secured Setup)#

For general handling of OIDC trustlist and ABAC access-rules files (config keys, env vars, startup behavior), see Security Configuration Files (Common).

For this component in Docker Compose, mount the security files into the container and configure ABAC_ENABLED=true, ABAC_MODELPATH, and OIDC_TRUSTLISTPATH if you enable ABAC.

Using BaSyx Go Components without Docker#

If you need to run the Submodel Registry without Docker, build the binary from source for your target platform.

Warning

We recommend using the Docker Images for production use-cases, as they are pre-configured and optimized for production environments.

Prerequisites#

Cloning the Repository#

git clone https://github.com/eclipse-basyx/basyx-go-components

Building the Binary#

cd basyx-go-components/cmd/submodelregistryservice
go build -o submodelregistryservice

Running the Service#

Before running the service, ensure PostgreSQL is available and configure the connection via environment variables or a config.yaml.

./submodelregistryservice -config ./config.yaml -databaseSchema ../../basyxschema.sql