Skip to main content

Installation

This guide will walk you through setting up the WEVA (Wago Energy Visualization App) environment, including strict dependencies like Docker and the PLC Visu runtime.

Note: These instructions are intended for Windows, Linux, or macOS users. Commands shown use Windows path conventions where applicable.


1. Install Docker Desktop

Before proceeding, you must have Docker installed and running on your machine.

  • Download: Docker Desktop Official Website
  • Install: Follow the installer instructions for your operating system.
  • Verify: Open a terminal (PowerShell or Command Prompt) and run:
    docker --version

Docker Desktop Install Placeholder (Add gif showing Docker Desktop installation process)


2. Setup PLC Visu Runtime

The PLC Visu (WDX) runtime is a prerequisite for WEVA to communicate with WAGO devices.

Download the Image

Download the plcvisu.cloud Docker image from the official source.

Download plcvisu.cloud Image (Placeholder Link)

Load the Image into Docker

Once downloaded, you need to import the image archive into your local Docker environment.

Correction: To import an image, use docker load, not docker save.

Open your terminal in the directory where you downloaded the file (e.g., nameoffile.rar or .tar) and run:

docker load -i nameoffile.rar

Note: Ensure the file matches the downloaded filename. Standard Docker archives usually end in .tar.

Docker Load Placeholder (Add gif of running the docker load command)

Run the Container

Execute the following command to start the WDX runtime. This command maps local directories to the container for persistent storage.

Tip: You can change the port mapping (-p 7081:80) if port 7081 is already in use.

docker run -d \
-p 7081:80 \
-p 7481:443 \
--name wdx-runtime \
--restart unless-stopped \
-v "C:\Users\user\Documents\WAGO\wdx-logs\data:/opt/elrest/edesign/wdx/data" \
-v "C:\Users\user\Documents\WAGO\wdx-logs\config:/opt/elrest/edesign/wdx/config" \
-v "C:\Users\user\Documents\WAGO\wdx-logs\js-storage:/opt/elrest/edesign/wdx/storage" \
wdx-runtime:4.0.1.107-X86_64-alpine

Verify PLC Visu

  1. Open Docker Desktop and ensure the wdx-runtime container status is Running (green play button).
  2. Open your web browser and go to: http://localhost:7081
  3. Confirm the PLC Visu application loads successfully.

PLC Visu Verify Placeholder (Add screenshot of the running PLC Visu app)


3. Install WEVA

Once the base runtime is active, you can deploy the WEVA application.

Download Files

Obtain the following files from the release package:

  1. weva.rar (Docker image archive)
  2. docker-compose.yaml (Configuration file)

Load WEVA Image

Similar to the step above, load the WEVA image into Docker:

docker load -i weva.rar

Configure Environment (Optional)

The docker-compose.yaml file contains environment variables that control the application's behavior.

Warning: Editing environment variables is recommended only for users familiar with Docker networking and configuration. Incorrect settings may prevent the app from connecting to the PLC Visu runtime or database.

Start the Application

Navigate to the folder containing docker-compose.yaml and run:

docker compose up -d

This will start the WEVA containers in detached mode (background).

WEVA Start Placeholder (Add gif showing the startup process)

You should now be able to access WEVA at http://localhost:3000 (or the port defined in your compose file).