Overview

This section provides instruction on how to set up local development environment for Workflow Engine module.

THe Docker Compose file to start up UCS module can be found under ucs directory in dev-containers repository. For more information on dev-containers, please refer to Local Development.

important

Before you run the docker compose command, make sure your host port 5000 is not in use. This is needed by SFU server to listen on port 5000 and client browser from ur local machine to establish webrtc connection for video/audio streaming.

To run UCS module, navigate to the dev-containers directory in your local machine and execute the following:

docker compose --env-file .env -f ucs/compose.yml --profile docker up -d

If you are using podman instead of docker, use podman compose instead of docker compose.

Accessing UCS

Once the containers are running, you can access the followings

• ucs room management - http://ucs.${DEV_DOMAIN} (for room management Rest API)
• ucs signal - http://ucs-signal.${DEV_DOMAIN} (for webRTC signaling)
• minio - http://minio.${DEV_DOMAIN} (for minio file upload/download)
• minio ui - http://minio-ui.${DEV_DOMAIN} (for minio console)

note

When prompted for user credentials in the minio console, use DEV_USER and DEV_PASSWORD value set in the .env file.