2.1. Installation

POLLUX Digital Twin is compiled as docker container, thus it will be easy to setup and replicate to a server (on premises or cloud). It is needed to have a basic knowledge of Docker to install this tool. Several tutorial can be found in the internet (example)

The pre-requisite software of this installation are:

docker-compose.yml (Beta Version)
 1networks:
 2    pollux:
 3
 4services:
 5    pollux_gui:
 6        image: ghcr.io/pollux-digital-twin/pollux-user-interface:beta
 7        ports:
 8            - 5445:5445
 9        environment:
10            - POLLUX_FRONTEND_PORT=5445
11            - POLLUX_MYSQLDB_URL=mysqldb
12            - POLLUX_ADMIN_EMAIL=admin@localhost
13            - POLLUX_ADMIN_PASSWORD=Admin123456!@#$
14        restart: unless-stopped
15        volumes:
16            - project-db:/opt/pollux-project
17            - doc-db:/opt/pollux-documentation
18        depends_on:
19            - mysqldb
20        networks:
21            - pollux
22
23    pollux_project:
24        image: ghcr.io/pollux-digital-twin/pollux-project:beta
25        restart: unless-stopped
26        volumes:
27            - project-db:/opt/pollux-project
28        networks:
29            - pollux
30
31    pollux_doc:
32        image: ghcr.io/pollux-digital-twin/pollux-documentation:beta
33        restart: unless-stopped
34        volumes:
35            - doc-db:/opt/pollux-documentation
36        networks:
37            - pollux
38
39    mysqldb:
40        image: mysql:8.0
41        ports:
42            - 3306:3306
43        environment:
44            - MYSQL_ROOT_PASSWORD=root
45            - MYSQL_DATABASE=polluxdb
46        volumes:
47            - mysqldb_data-storage:/data/db
48            - mysqldb_var_lib-storage:/var/lib/mysql
49        restart: unless-stopped
50        networks:
51            - pollux
52
53
54volumes:
55    mysqldb_data-storage:
56    mysqldb_var_lib-storage:
57    project-db:
58    doc-db:

There are several services in this docker-compose.yml file:

  1. POLLUX User interface (GUI)

    This container provides the web user interface of POLLUX. This container depends on MySQLDB container to access user authentication and project. The port number can be defined in POLLUX_FRONTEND_PORT environment variable. The container shares volume of project-db with other container to have a common project data and volume of doc-db to access the documentation.

  2. POLLUX Project

    This container provides the shared volume project-db that can be accessed by POLLUX Framework container and POLLUX User Interface container.

  3. POLLUX Documentation

    This container provides the web-based documentation of POLLUX. The content is shared with POLLUX User Interface container.

  4. MySQLDB

    It is an open-source relational database management system. To handle several data structured of POLLUX.