Skip to main content

General

5-Minute Quick Start

Deploy Proxus using Docker and connect your first simulated device.

This guide will walk you through deploying the Proxus stack locally and connecting a simulated device to witness real-time data flow.

Prerequisites

Docker Engine 4GB+ RAM

Ensure you have Docker and Docker Compose v2 installed on your machine.

Deployment

The fastest way to get Proxus running is using the automated installer for your operating system:

The installer can start the stack for you. If you skipped that step, start it later with:

cd proxus-platform
docker compose up -d

Wait about 30-60 seconds for the containers to initialize. Then open the Management Console at http://localhost:8080.

Management Console overview
Management Console overview

info
Login Credentials
  • Username: Admin
  • Password: (Leave blank)
warning
License Key

Proxus requires a license to activate gateways. You can request a free demo license at proxus.io/contact.

Connecting a Simulator

Since you likely do not have a physical PLC connected to your development machine, we will use the built-in Simulator protocol to generate data.

Create a Device Profile

  1. Navigate to Data Management > Device Profiles in the sidebar.
  2. Click New.
  3. Name it Simulated Generator.
  4. Select Protocol: SIMULATOR.
  5. Add the following Tags (the Address field defines the [min,max] range):
    • Name: Temperature, Address: [20,80], Type: Double
    • Name: Vibration, Address: [0,5], Type: Double
    • Name: Status, Address: [0,1], Type: Bool
  6. Click Save.

Add the Device

  1. Navigate to Data Management > Devices.
  2. Click New.
  3. Name: Gen_01.
  4. Profile: Select Simulated Generator.
  5. Gateway: Select the default SYSTEM gateway (this is the local gateway installed with your server).
  6. Click Save.

Activate

In the devices list, find Gen_01. You will notice it is Passive by default. Check the Active box. The system will deploy the configuration to the Gateway immediately.

Verify Data Flow

To confirm that data is flowing into the platform:

  1. Click on the Gen_01 device name to open the details view.
  2. Switch to the Latest Values tab.
  3. You should see Temperature and Vibration values updating live without refreshing the page.
  4. Click a trend cell to open the fullscreen signal view if you want to inspect recent history or switch to Raw mode.

Latest Values tab with live data
Latest Values tab with live data

Congratulations! You have successfully deployed Proxus and ingested your first data stream.

Build Your First Dashboard

Now that data is flowing, let's visualize it with a simple dashboard.

Create a Dashboard

Navigate to Visualization > Dashboards and click New Dashboard. Name it Quick Start Monitor.

Add a Gauge

Drag a Gauge widget from the toolbox onto the canvas.

Bind Data

Click the Gauge, open the Data Source panel, select New SQL Query, and enter:

SELECT avg(Value) as Temperature
FROM DeviceRawData
WHERE TagName = 'Temperature'
  AND DeviceName = 'Gen_01'
  AND Time > now() - INTERVAL 5 MINUTE

Configure Appearance

Set Min to 20, Max to 80. Add color ranges: Green (20–50), Yellow (50–65), Red (65–80).

Enable Auto-Refresh

Set Auto-Refresh to 10 seconds in the toolbar. Your gauge should now show a live temperature reading.

You now have a complete pipeline: device → data collection → visualization.

Next Steps

Now that you have live data and a dashboard, explore the platform architecture or start building automation rules.

account_tree

Architecture Overview

Understand the Hub & Spoke topology and data flow.

schema

Unified Namespace

Learn how to structure your data hierarchy.

toggle_on

Create Rules

Build logic to detect anomalies in your simulated data.

← Previous
Introduction to Proxus
Next →
System Requirements