C-Gate IoT Hub

First steps

The C-Gate IoT Hub is provided as software in a container format. It is recommended to install the C-Gate IoT Hub on a central server per company location. Alternatively, installation on a standard PC is also possible.

System requirements

Container runtime environment (e.g. Docker, Kubernetes, OpenShift, Podman, ...)
8 GB RAM
128 GB hard disk space
64-bit processor (4 cores recommended)
Internet connection (during installation and update)

If more than 25 controllers are connected, the requirements may be greater.

C-Gate IoT Hub Container

The C-Gate IoT Hub container is provided in the Docker Registry by CLOOS. You will receive the necessary access data when you purchase a C-Gate IoT Hub .

Registry and Image URL

docker.cloos.de/cgate

Example of a test environment with Docker

docker run -d --name cgate -p 80:8080 -p 4840:4840 docker.cloos.de/cgate

Example of a productive environment with Docker Compose

version: "3"
services:
  cgate:
    container_name: cgate
    image: docker.cloos.de/cgate:latest
    restart: always
    ports:
      - "80:8080"
      - "4840:4840"
      - "5000:5000/tcp"
      - "5000:5000/udp"
      - "5005:5005"
      - "5010:5010"
      - "5679:5679"
    environment:
      - APP_MAX_DATA_SIZE_GB=64
    volumes:
      - data:/data
    logging:
      driver: "json-file"
      options:
        max-size: "100m"
volumes:
  data:

Volumes

C-Gate stores all configurations and data in the directory /data. A volume should be used for this directory to persist the data.

Exposed Ports

4840 (OPC UA Server)
5000/tcp (Robot communication up to V6)
5000/udp (Robot communication up to V6)
5005 (Robot communication up to V6)
5010 (Robot communication up to V6)
5679 (IoT Connector RPC)
8080 (Web Interface)

Variables

APP_ADMIN_PASSWORD

Forces a password for the admin user.

Default value: Empty

APP_MAX_DATA_SIZE

Sets the maximum size of the total data stored by C-Gate in GB.

Default value: 32

Step-by-step guide

If you are not yet using a container runtime environment, the following instructions will guide you through the necessary steps for a basic container runtime environment with C-Gate. In this case, we recommend that you nevertheless get to grips with your container environment in order to be able to operate it safely.

Linux Recommendation!

Install Docker for your Linux distribution.

Execute the following commands to install and start C-Gate:

sudo mkdir -p /opt/cloos/cgate
cd /opt/cloos/cgate/
sudo curl -L https://c-gate.cloos.de/static/install/docker-compose.yml -o docker-compose.yml
sudo docker login docker.cloos.de
# Enter the access data you received from CLOOS here.
sudo docker compose up -d
# Give the application a few seconds to start.
# Read the generated password for the user admin with the following command:
sudo docker logs cgate | grep UserInitializer

Windows

We recommend an installation under a Linux operating system, as containers have already been established there for several years. Under Windows, on the other hand, containers are currently still new. You should therefore expect more frequent changes, slightly higher resource consumption and more challenges during setup and operation.

Make sure that the latest update for Windows is installed. You need at least Windows 10 from version number 2004 (Build 19041) or Windows 11.

To display the Windows version, the following command can be executed on the command line:
```
winver
```

Install WSL (Windows Subsystem for Linux) with the following commands on the command line:

wsl --set-default-version 2
# In the following, select any user name and password.
# It is not necessary to enter the CLOOS access data here.
wsl --install -d Ubuntu
wsl --set-default Ubuntu

Install C-Gate with our C-Gate IoT Hub installer for Windows.

After the installation

The next steps and further information can be found on the C-Gate web interface. You can access this after installation at http://localhost on your server or PC.

From another computer you can reach C-Gate at http://[serverip], where [serverip] is to be replaced by the IP of your server or PC on which C-Gate has been installed.

Problems with the installation?

You can find answers to frequently asked questions and further documentation at User Support.