Install

🎉 Thank you for downloading Digital Twin as a Service.

This README provides a quick-start installation guide for DTaaS on localhost over HTTP with a single user workspace.

For HTTP localhost deployment, use deploy/dtaas/docker/localhost.

For detailed configuration reference, see config.md.

Design

An illustration of the docker containers used in this package is shown here.

Requirements

The installation requirements to run this package are:

• Docker Engine with Compose plugin
• GitLab account for OAuth sign-in

Quick Start

1. Create Configuration Files

cp config/.env.example config/.env
cp config/client.js.example config/client.js

2. Create User Workspace Directory

Edit config/.env and set DEFAULT_USER, then create a matching workspace:

cp -R files/template files/<DEFAULT_USER>
sudo chown -R 1000:100 files/*

3. Start Services

docker compose --env-file config/.env up -d

4. Open DTaaS

• http://localhost

Sign in using the configured OAuth provider in config/client.js (default authority is https://gitlab.com/).

Run

The commands to start and stop the application are:

docker compose --env-file config/.env up -d
docker compose --env-file config/.env down

Notes

• This package does not include libms or backend forward-auth.
• For secure production deployments, see deploy/dtaas/docker/secure-server_with_integrated-gitlab.

Documentation

See https://into-cps-association.github.io/DTaaS/development/index.html for complete documentation.

References

Image sources: Traefik logo, gitlab