Portainer Templates logo

Portainer Templates

Anyviz Cloud Adaptor Anyviz Cloud Adaptor

Stack

edge

The cloud adapter connects local devices via OPC-UA, Modbus, Siemens, Beckhoff ADS, EtherNet/IP, M-Bus and BACnet to the AnyViz Cloud.

Image details

Pulls: 69.1k
Architecture: amd64, arm64, arm/v7, 386, arm64/v8
Image size: 5 MB
Latest: 2.1.3.3
User: anyviz
Created: Sep 05, 2019
Updated: 4 days ago
Status: active

Configuration

Type
Compose
Platform
linux
Image
anyviz/cloudadapter
Ports
8888:8888
Volumes
/etc/anyviz : anyviz_config
Restart
always
Source
Repo

Template by portainer·Source

Standalone Install

Select an install method, to see config/commands for deploying Anyviz Cloud Adaptor

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 Anyviz Cloud Adaptor, 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:

version: "2"
services:
  cloudadapter:
    image: anyviz/cloudadapter
    restart: always
    ports:
      - "8888:8888"
    volumes:
      - anyviz_config:/etc/anyviz
    network_mode: "host"
    cap_add:
      - NET_ADMIN
    devices:
      - /dev/net/tun
volumes:
  anyviz_config:

Or deploy it directly from the source:

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

More install options in our documentation.

What is AnyViz

The AnyViz cloud solution allows you to remotely monitor, control and analyse industrial PLCs, sensors and meters.

What are the features of anyviz/cloudadapter

The cloud adapter is able to connect local devices via OPC-UA, Modbus, Siemens, Beckhoff ADS, EtherNet/IP, M-Bus and BACnet. The data is collected locally and transmitted to the AnyViz portal via an encrypted connection. If the internet connection is interrupted, the data is buffered locally. In addition, the Cloud Adapter can pass through local websites and VNC servers so that they can be embedded in the Cloud HMI.

Running AnyViz cloud adapter

~ docker run -d -p 80:8888 -p 9999:9999 anyviz/cloudadapter ~ Open your browser (port 80) and start configuring via web interface.

Running AnyViz cloud adapter including full AnyViz VPN support

~ docker run -d --net=host --cap-add=NETADMIN --device /dev/net/tun:/dev/net/tun anyviz/cloudadapter ~ The AnyViz Cloud Adapter requires some privileges to enable VPN connections.

Running AnyViz cloud adapter via docker-compose

Create a directory (e.g. ./anyvizcloudadapter) and create a file named docker-compose.yml with following content. ~ version: "2" services: cloudadapter:
image: anyviz/cloudadapter
restart: always
container_name: anyviz
ports:
  - "8888:8888"
  - "9999:9999"
volumes:
  - anyviz_config:/etc/anyviz
# required if AnyViz VPN is needed
network_mode: "host"
cap_add:
  - NET_ADMIN
devices:
  - /dev/net/tun
volumes: anyvizconfig: ~ Start AnyViz cloud adapter by typing docker-compose up -d. Web UI is listening on port 8888 in this case

Complete setup

  1. Join the AnViz portal or create a new project
  2. Enter the project ID given by AnyViz portal and enter a unique password for your cloud adapter setup project ID and password
  3. The cloud adapter should now appear in the AnyViz portal. In the configuration dialog of the Cloud Adapter the password from step 2 has to be confirmed. retype password of cloud adapter

Additional links and documentation

Serve Anyviz Cloud Adaptor 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 anyviz-cloud-adaptor.example.com to http://cloudadapter:8888

Add this to your Caddyfile

anyviz-cloud-adaptor.example.com {
	reverse_proxy http://cloudadapter:8888
}

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:8888 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8888
  • Stop the other service, or pick a different host port. In 8888:8888 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:8888. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, cloudadapter can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8888

Image won't pull

Test the pull directly on the host: docker pull anyviz/cloudadapter

  • "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, 386, arm64/v8
  • 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 always 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

Anyviz Cloud Adaptor 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 Anyviz Cloud Adaptor needs bundled into one download. This template pulls anyviz/cloudadapter, which Docker fetches once (about 5 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. Anyviz Cloud Adaptor's comes from Docker Hub, published by anyviz.

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 2.1.3.3. 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, 386, arm64/v8, 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 8888:8888 means it's reachable on port 8888 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 8888:8888

Volumes

A volume is where Anyviz Cloud Adaptor keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /etc/anyviz kept in the anyviz_config volume Docker manages

Restart policy

The restart policy here is always, so Docker brings Anyviz Cloud Adaptor back up after a crash and again when the server reboots. Good for anything you want running around the clock. 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).

Devices

Devices pass a piece of the host's hardware straight through to the container, like a graphics chip for transcoding or a USB adapter. This one gets:

  • /dev/net/tun

Networking

Nothing custom is set, so Anyviz Cloud Adaptor 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 cloudadapter. That's what you'll spot in the containers list and use in commands like docker logs cloudadapter.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

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