OPC Router
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
Configuration
TypeComposeopcrouter/runtime:latest49420:494208080:80808081:8081OR_I_ACCEPT_EULA=${OR_I_ACCEPT_EULA}INITIAL_USERNAME=${INITIAL_USERNAME}INITIAL_PASSWORD=${INITIAL_PASSWORD}unless-stoppedNotes
Installation
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select the app you wish to deploy, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
docker run -d --name opc-router \
-p 49420:49420 \
-p 8080:8080 \
-p 8081:8081 \
-e 'OR_I_ACCEPT_EULA=${OR_I_ACCEPT_EULA}' \
-e 'INITIAL_USERNAME=${INITIAL_USERNAME}' \
-e 'INITIAL_PASSWORD=${INITIAL_PASSWORD}' \
--restart=unless-stopped \
opcrouter/runtime:latestIf the stack expects env vars, set them or add them to a .env file first.
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, use the original compose file, straight from the template repo. Deploy with:
git clone https://github.com/portainer/templates
cd templates
docker compose -f edge/opc-router/docker-compose.yml up -dSave this file as opc-router-stack.yml, then from a manager node, run docker stack deploy -c opc-router-stack.yml opc-router
version: '3.8'
services:
opc-router:
image: opcrouter/runtime:latest
ports:
- '49420:49420'
- '8080:8080'
- '8081:8081'
environment:
OR_I_ACCEPT_EULA: ${OR_I_ACCEPT_EULA}
INITIAL_USERNAME: ${INITIAL_USERNAME}
INITIAL_PASSWORD: ${INITIAL_PASSWORD}
deploy:
restart_policy:
condition: any
Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a
persistent volume claim, and ports are exposed via a LoadBalancer service.
opc-router-deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: opc-router
labels:
app: opc-router
spec:
replicas: 1
selector:
matchLabels:
app: opc-router
template:
metadata:
labels:
app: opc-router
spec:
containers:
- name: opc-router
image: opcrouter/runtime:latest
env:
- name: OR_I_ACCEPT_EULA
value: ${OR_I_ACCEPT_EULA}
- name: INITIAL_USERNAME
value: ${INITIAL_USERNAME}
- name: INITIAL_PASSWORD
value: ${INITIAL_PASSWORD}
ports:
- containerPort: 49420
protocol: TCP
- containerPort: 8080
protocol: TCP
- containerPort: 8081
protocol: TCP
opc-router-service.yaml
apiVersion: v1
kind: Service
metadata:
name: opc-router
spec:
type: LoadBalancer
selector:
app: opc-router
ports:
- name: 49420-tcp
port: 49420
targetPort: 49420
protocol: TCP
- name: 8080-tcp
port: 8080
targetPort: 8080
protocol: TCP
- name: 8081-tcp
port: 8081
targetPort: 8081
protocol: TCP
Save this file as ~/.config/containers/systemd/opc-router.container
[Unit]
Description=OPC Router
[Container]
Image=opcrouter/runtime:latest
ContainerName=opc-router
PublishPort=49420:49420
PublishPort=8080:8080
PublishPort=8081:8081
Environment=OR_I_ACCEPT_EULA=${OR_I_ACCEPT_EULA}
Environment=INITIAL_USERNAME=${INITIAL_USERNAME}
Environment=INITIAL_PASSWORD=${INITIAL_PASSWORD}
[Service]
Restart=always
[Install]
WantedBy=default.targetThen reload systemd and start the service:
systemctl --user daemon-reload
systemctl --user start opc-routerFor a system-wide service, use /etc/containers/systemd/ and drop --user.
For more installation options, see the Documentation in our GitHub repo
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 EULASystem requirements for the OPC Router
Contact us – we are happy to help you
OPC Router documentation
System Requirements
- Runtime license
- 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:- opcrouter/runtime which comes with an embedded mongoDB
- 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:latestImage tags
| tag name | Description | | -------- | ----------- | | latest | latest released version | | latest-RC | latest release-candidate, not meant for production | | {Major}.{Minor} | the latest release / hotfix for a specific major.minor version | | {Major}.{Minor}-RC | the 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:
137means killed, usually out of memory.126or127means 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:49420only 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 loginto 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
noso 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.
- Bug within the app: Open an issue within opc-router's repo
- Template not working: Open an issue on portainer/templates
- This website not working: Open an issue on lissy93/portainer-templates