Skip to main content

General

Managing Edge Gateways

How to deploy, authenticate, and monitor your Edge Gateways.

The Edge Gateway is the physical or virtual agent that runs on your factory floor. It acts as the local data collector, processor, and buffer between your industrial assets and the Central Server.

Why use Gateways?

  • Network Segmentation: Keep your OT network isolated from the cloud. The Gateway acts as a secure bridge.
  • Protocol Translation: Convert diverse industrial protocols (Siemens, Modbus, OPC UA, etc.) into a unified internal format.
  • Data Buffering: In case of network failure, the Gateway caches data locally and forwards it when the connection is restored (Store-and-Forward).

Gateway Types

Every Proxus installation starts with a default gateway, but you can scale to thousands of remote locations.

  • SYSTEM Gateway (ID 1): Created automatically during installation. It is co-located with the Central Server (running in the same Docker network). It is used for internal system tasks or local data ingestion.
  • Remote Gateways (ID 2+): These are the agents you deploy to remote industrial PCs (IPCs), servers, or VMs near your machines.

Deploying a Remote Gateway

To deploy a gateway to a remote Linux machine (with Docker installed), follow these steps:

Create Gateway Record

  1. Navigate to Data Management > Edge Gateways in the Management Console.
  2. Click New.
  3. Name it (e.g., "Factory A - Line 1") and click Save.

Configure Deployment

  1. Click on the newly created gateway to open the Detail View.
  2. Click the "Deploy to Edge" button at the top of the screen.
  3. A configuration dialog will appear. Here you can adjust parameters like:
    • Service Port: The port the gateway service will listen on (default: 8083).
    • Cluster Address: The IP address of your Central Server.
    • Target Architecture: Select based on your hardware (e.g., Amd 64 or Arm 64).

Run the Command

  1. Copy the generated Command from the dialog.
  2. Log in to your remote Linux machine (ensure Docker is installed).
  3. Paste and run the command (it starts with sudo sh -s <<'SH').
info
What this command does

The deployment script automatically:

  • Creates a Configs directory for Leaf node authentication.
  • Sets up a Leaf Node for guaranteed data delivery and offline buffering.
  • Deploys the Proxus Server container using Docker Compose.
  • Establishes a secure connection back to the Central Server.

Verify Connection

Once the script finishes, return to the Management Console. The gateway status should turn Green (Online), showing real-time CPU, memory, and disk diagnostics.

Deployment Script Example

The generated script uses a secure multi-container setup. Below is a conceptual example of the configuration it creates:

services:
  proxus-edge-leaf:
    image: nats:alpine
    restart: always
    volumes:
      - ./Configs/nats-leaf.conf:/etc/nats/nats-leaf.conf
    command: ["-c", "/etc/nats/nats-leaf.conf"]

  proxus-edge-server:
    image: proxusplatform/proxus-server:latest
    restart: always
    environment:
      ASPNETCORE_URLS: "http://+:8083"
    command:
      - /Proxus.Server
      - GatewayID=2
      - BrokerUrl=nats://proxus-edge-leaf:4222
warning
Docker Requirement

The target machine must have Docker and Docker Compose installed and the current user must have permissions to run sudo.

Having Trouble?

If your gateway is not connecting or shows unexpected behavior, see Gateway Not Connecting or MQTT Broker Issues.

← Previous
Connect OPC UA
Next →
Actions Overview