Skip to main content

Installation Guide

This tutorial provides step-by-step instructions for deploying the WEVA environment on a host machine.

Prerequisites​

Ensure the following conditions are met before starting the installation:

  1. Hardware: Host machine meets System Requirements.
  2. Software: Docker Desktop or Docker Engine is installed and running.
  3. Network: Administrative access to the host machine's terminal (PowerShell or Bash).

1. Deploy WDX Runtime (PLC Visu)​

The WDX runtime is the primary communication bridge between WEVA and WAGO controllers.

Load the Image​

Import the provided WDX Docker image into your local repository.

# In PowerShell or Terminal
docker load -i wdx-runtime-image.tar

Start the Container​

Run the container using the following command. This persistent mapping ensures logs and configurations are stored on the host.

docker run -d `
  -p 7081:80 `
  -p 7481:443 `
  --name wdx-runtime `
  --restart unless-stopped `
  -v "C:\WAGO\wdx\data:/opt/elrest/edesign/wdx/data" `
  -v "C:\WAGO\wdx\config:/opt/elrest/edesign/wdx/config" `
  wdx-runtime:4.0.1

[!WARNING] Ensure the volume paths (e.g., C:\WAGO\...) exist on the host before running the command.

2. Deploy WEVA Application​

Once the WDX runtime is verified, deploy the WEVA application stack.

Load WEVA Image​

docker load -i weva-app-image.tar

Configure Docker Compose​

Create a directory for the deployment and place the docker-compose.yaml file inside it.

version: '3.8'
services:
  weva-backend:
    image: weva-app:latest
    ports:
      - "3000:3000"
    environment:
      - WDX_HOST=http://host.docker.internal:7081
      - DB_URL=postgres://user:pass@db:5432/weva
    depends_on:
      - weva-db
  weva-db:
    image: postgres:15-alpine
    volumes:
      - weva-data:/var/lib/postgresql/data

volumes:
  weva-data:

Start the Stack​

Navigate to the directory and execute:

docker compose up -d

Installation GIF Placeholder GIF: Recording showing the 'docker compose up' command and successful container startup.

3. Verification​

  1. Container Status: Run docker ps to ensure all containers (weva-backend, weva-db, wdx-runtime) are in the Up state.
  2. Web Access: Open a browser on the host and navigate to http://localhost:3000.
  3. Login: Use the default administrator credentials provided in your license documentation.

Next Step: PLC Visu Configuration