Skip to content

Latest commit

 

History

History
99 lines (76 loc) · 2.99 KB

DOCKER.md

File metadata and controls

99 lines (76 loc) · 2.99 KB

Introduction

This is a container image for client application of the Digital Twin as a Service (DTaaS) software. This image can be used for providing a React single page web application for the DTaaS.

Authorization

The react client website uses OAuth authorization. The authorization page provides details on setting up OAuth authorization for the client application.

Use in Docker Environment

Create Docker Compose File

Create an empty file named compose.client.yml and copy the following into the file:

services:
  client:
    image: intocps/dtaas-web:latest
    restart: unless-stopped
    volumes:
      - ./config.js:/dtaas/client/build/env.js
    ports:
      - "4000:4000"

Create Configuration

The client application requires configuration. See the config page for an explanation of client configuration.

The docker version of client application uses configuration saved in config.js file. Please create this file in the same file system location as that of the compose.client.yml file.

Create a file config.js with the following contents:

if (typeof window !== 'undefined') {
  window.env = {
    REACT_APP_ENVIRONMENT: 'test',
    REACT_APP_URL: 'http://localhost:4000/',
    REACT_APP_URL_BASENAME: '',
    REACT_APP_URL_DTLINK: '/lab',
    REACT_APP_URL_LIBLINK: '',
    REACT_APP_WORKBENCHLINK_VNCDESKTOP: '/tools/vnc/?password=vncpassword',
    REACT_APP_WORKBENCHLINK_VSCODE: '/tools/vscode/',
    REACT_APP_WORKBENCHLINK_JUPYTERLAB: '/lab',
    REACT_APP_WORKBENCHLINK_JUPYTERNOTEBOOK: '',

    REACT_APP_CLIENT_ID: '1be55736756190b3ace4c2c4fb19bde386d1dcc748d20b47ea8cfb5935b8446c',
    REACT_APP_AUTH_AUTHORITY: 'https://gitlab.com/',
    REACT_APP_REDIRECT_URI: 'http://localhost:4000/Library',
    REACT_APP_LOGOUT_REDIRECT_URI: 'http://localhost:4000/',
    REACT_APP_GITLAB_SCOPES: 'openid profile read_user read_repository api',
  };
};

This default configuration works well if you have an account on https://gitlab.com. If you would like to adjust the configuration, please change this file.

Run

Use the following commands to start and stop the container respectively:

docker compose -f compose.client.yml up -d
docker compose -f compose.client.yml down

The website will become available at http://localhost:4000.

Missing Workspace

The docker compose only brings up the client application. This development environment does not have user workspaces and traefik gateway running in the background. As a consequence, you will see the following error.

Unexpected Application Error!
404 Not Found

This error can be seen on the Library and Digital Twins pages. The error is expected.

If you would like to try the complete DTaaS application, please see localhost installation in docs.