Portainer Templates logo

Portainer Templates

OPC Router OPC Router

Stack

edge

No-code middleware for industrial applications The OPC Router connects PLCs, PCS, SCADA, MES, SQL databases and servers, label printers, e-mail servers and erp-systems via OPC UA, MQTT, REST, CSV and many others without any programming effort

Image details

Pulls: 94.0k
Architecture: amd64, arm64, arm/v7
Image size: 476 MB
Latest: 5.5-ferretdb
User: opcrouter
Created: Jan 19, 2021
Updated: 11 days ago
Status: active

Configuration

Type
Compose
Image
opcrouter/runtime:latest
Ports
49420:494208080:80808081:8081
Env vars
OR_I_ACCEPT_EULA=${OR_I_ACCEPT_EULA}INITIAL_USERNAME=${INITIAL_USERNAME}INITIAL_PASSWORD=${INITIAL_PASSWORD}
Restart
unless-stopped
Source
Repo

Template by portainer·Source

Notes

More information about the EULA.

Standalone Install

Select an install method, to see config/commands for deploying OPC Router

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select OPC Router, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  opc-router:
    image: opcrouter/runtime:latest
    restart: unless-stopped
    ports:
      - "49420:49420"
      - "8080:8080"
      - "8081:8081"
    environment:
      - OR_I_ACCEPT_EULA=${OR_I_ACCEPT_EULA}
      - INITIAL_USERNAME=${INITIAL_USERNAME}
      - INITIAL_PASSWORD=${INITIAL_PASSWORD}
    volumes:
      - type: volume
        source: opcrouter-configdb
        target: /data/database
      - type: volume
        source: opcrouter-inray
        target: /inray
      - type: volume
        source: opcrouter-logs
        target: /var/log/opcrouter
volumes:
  opcrouter-configdb:
  opcrouter-inray:
  opcrouter-logs:

Or deploy it directly from the source:

git clone https://github.com/portainer/templates
cd templates
docker compose -f edge/opc-router/docker-compose.yml up -d

More install options in our documentation.

Introduction

The central Industry 4.0 platform enables data exchange in your networked production processes to be automated and optimised. The OPC Router connects systems vertically and horizontally, from sensors and controls to ERP and the cloud, from printers and scales to MES, SCADA or LIMS. Find the solution for your connectivity project from the multitude of plug-ins and request your personal download.

End-User Licence Agreement, System requirements, Support and Documentation

Terms of Use and EULA
System requirements for the OPC Router
Contact us – we are happy to help you
OPC Router documentation

System Requirements

  1. Runtime license
  2. To configure the OPC Router runtime / service you can use the included webinterface. For OPC Router version 4.28 and below no webinterface is available and the OPC Router Management is required (download OPC Router Management)

OPC Router Docker image

There are two images available:
  1. opcrouter/runtime which comes with an embedded mongoDB
  2. opcrouter/service which requires an external mongoDB

For deploying onto a Kubernetes cluster, it is recommended to use the OPC Router Helm Chart instead of manually creating deployments for those images.

Documentation

Information for deploying and configuring OPC Router containers can be found under the official OPC Router documentation.

opcrouter/runtime

The OPC Router runtime image has a mongoDB embedded and runs on 64bit systems (x64 & arm64)

quick start opcrouter-runtime

docker run -d -p 51515:8080 -e OR_DISABLE_AUTH=true -e OR_I_ACCEPT_EULA=true -v opc-router-data:/data --name opc-router opcrouter/runtime:latest

Image tags

tag nameDescription
latestlatest released version
latest-RClatest release-candidate, not meant for production
{Major}.{Minor}the latest release / hotfix for a specific major.minor version
{Major}.{Minor}-RCthe latest release-candidate for a specific version
{Major}.{Minor}.{Rev}.{Build}a specific version

Serve OPC Router on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying opc-router.example.com to http://opc-router:8080

Add this to your Caddyfile

opc-router.example.com {
	reverse_proxy http://opc-router:8080
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:49420 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :49420
  • Stop the other service, or pick a different host port. In 49420:49420 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8080. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, opc-router can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8080

Image won't pull

Test the pull directly on the host: docker pull opcrouter/runtime:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

OPC Router is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything OPC Router needs bundled into one download. This template pulls opcrouter/runtime:latest, which Docker fetches once (about 476 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. OPC Router's comes from Docker Hub, published by opcrouter.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 5.5-ferretdb. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 49420:49420 means it's reachable on port 49420 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8080 in a browser. It opens:

  • 49420:49420
  • 8080:8080, likely the web interface
  • 8081:8081

No stored data

This template doesn't mount any storage, so whatever OPC Router writes stays inside the container and is wiped if it's recreated or updated. That's fine for something stateless, but add a volume before trusting it with anything you want to keep.

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. OPC Router takes 3 of them, all with defaults you can leave alone or tweak:

  • OR_I_ACCEPT_EULA, pick one of true. Accept EULA
  • INITIAL_USERNAME, pulled from your own environment. Initial Admin User user
  • INITIAL_PASSWORD, pulled from your own environment. Inital Admin User Password

Restart policy

The restart policy here is unless-stopped, so Docker restarts OPC Router after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so OPC Router sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container opc-router. That's what you'll spot in the containers list and use in commands like docker logs opc-router.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set OPC Router up. Add the template list to Portainer once, then deploying OPC Router is a click rather than a wall of config.