LogoLogo
Contact Uscybus.io
Connectware 1.11.0
Connectware 1.11.0
  • Getting Started
    • Introduction
    • System Requirements
    • Connectware Admin UI
    • Basic Components of Connectware
    • Connecting your First Machine
      • Your First Service Commissioning File
  • Documentation
    • Installation and Upgrades
      • Installing Connectware
        • Installing Connectware (Kubernetes)
        • Installing Connectware (Docker)
      • Upgrading Connectware
        • Upgrading Connectware (Kubernetes)
          • Version-Specific Upgrades (Kubernetes)
        • Upgrading Connectware (Docker)
          • Version-Specific Upgrades (Docker)
      • Uninstalling Connectware
        • Uninstalling Connectware (Kubernetes)
        • Uninstalling Connectware (Docker)
      • Licensing
      • Restarting Connectware
    • User Management
      • Users and Roles View
      • Users
      • Roles
      • Permissions
      • Password Policy Rules
      • Default Admin User
      • MQTT Users
      • Adding a MQTT Publish Prefix for Users
      • Multi-Factor Authentication
      • Single Sign-On (SS0)
        • Single Sign-On with Microsoft Entra ID
        • Single Sign-On with LDAP
      • JSON Web Tokens
      • Access Permissions for Admin-UI
        • UI Access
        • Minimum Access Role Pages
    • Services
      • Service Overview
      • Service Resources View
        • Service Links View
        • Servers View
        • Containers View
        • Volumes View
        • Connections View
        • Endpoints View
        • Mappings View
      • Service Details View
      • Service Commissioning Files
        • Version
        • Description
        • Metadata
        • Parameters
        • Definitions
        • Resources
          • Cybus::Connection
          • Cybus::Container
            • Docker Problem with Network Changes
          • Cybus::Endpoint
          • Cybus::File
          • Cybus::IngressRoute
          • Cybus::Link
          • Cybus:Mapping
          • Cybus::Node
          • Cybus::Role
          • Cybus::Server
          • Cybus::User
          • Cybus::Volume
      • Setting Up and Configuring Services
        • Installing Services
        • Enabling Services
        • Updating Services
        • Disabling Services
        • Deleting Services
      • FlowSync
        • Example 1 - Node with Transaction Mode (HTTP)
        • Example 2 - Node Responds (HTTP)
        • Example 3 - Node with Error (HTTP)
        • Example 4 - Node with Timeout Error Code and Error Message (HTTP)
        • Example 5 - Full Transactional Data Flow (HTTP)
        • Example 6 - Full Transactional Data Flow (OPC UA)
      • ServiceID
      • Inter-Service Referencing
      • Deviations
      • Service Logs
        • Logs of Individual Services
        • Logs of All Services
      • Rule Engine
        • Data Processing Rules
        • Rule Sandbox
      • Shared Subscriptions
        • Setting Up Shared Subscriptions
    • Agents
      • Agents View
      • Installing Agents
        • Installing Agents via Docker
        • Installing Agents via Docker Compose
        • Installing Agents via Kubernetes
        • Using Mutual TLS for Agents
      • Registering Agents in Connectware
      • Using Agents
      • Monitoring Agents
      • Agents in Kubernetes
        • Adding Agents Inside your Connectware Installation
        • Remote Agents with the connectware-agent Helm Chart
        • Kubernetes Cluster Requirements for the connectware-agent Helm Chart
        • Installing Connectware Agents using the connectware-agent Helm Chart
        • Installing Connectware Agents without a License Key Using the connectware-agent Helm Chart
        • Upgrading the connectware-agent Helm Chart
        • Uninstalling Connectware agents with the connectware-agent Helm chart
        • Configuration Principles for the connectware-agent Helm Chart
        • Configuring Agents with the connectware-agent Helm Chart
          • Configuring Target Connectware for the connectware-agent Helm Chart
          • Configuring Agent Persistence for the connectware-agent Helm Chart
          • Configuring Compute Resources for the connectware-agent Helm Chart
          • Using a Custom Image Registry for the connectware-agent Helm Chart
          • Configuring Image Pull Policy for the connectware-agent Helm Chart
          • Using Mutual Transport Layer Security (mTLS) for agents with the connectware-agent Helm chart
          • Configuring image name and version for the connectware-agent Helm chart
          • Configuring Environment Variables for the connectware-agent Helm Chart
          • Configuring Labels and Annotations for the connectware-agent Helm Chart
          • Configuring podAntiAffinity for the connectware-agent Helm Chart
          • Assigning Agents to Kubernetes Nodes for the connectware-agent Helm Chart
          • Configuring Security Context for the connectware-agent Helm Chart
          • Controlling the Name of Kubernetes Objects for the connectware-agent Helm Chart
      • Troubleshooting Agents
    • Client Registry
      • Implicit Flow
      • Explicit Flow
      • Granting Access
    • Certificates
      • Certificates View
      • Adding Certificates
      • Removing Certificates
    • Monitoring
      • Data Explorer
      • Live Data
    • Node-RED Workbench
    • System Status
      • System Container Status
      • Internet Connectivity Status
      • Metrics (Data Points and Messages)
      • Agents Status
      • License Information
      • System Information
    • Backup and Restore
      • Volumes
      • User Database
    • CybusMQ
      • Configuring CybusMQ
    • Connectware on Kubernetes
      • Connectware Helm Chart
      • Resizing Broker Volumes in Kubernetes
      • Configuring Core Services
      • LDAP Authentication
        • Configuring LDAP Authentication
        • Enabling TLS for LDAP Authentication
        • Manual Kubernetes Secret for LDAP Authentication Bind User
        • Customizing the Search Filter for LDAP Authentication
        • Customizing the User RDN for LDAP Authentication
      • Troubleshooting Connectware on Kubernetes
    • Environment Variables
    • Industry Protocol Details
      • ADS
        • ADS Connection Properties
        • ADS Endpoint Properties
      • BACnet
        • BACnet Connection Properties
        • BACnet Endpoint Properties
      • Custom Connectors
        • Developing Custom Connectors
        • Deploying Custom Connectors
        • Using Custom Connectors
      • EtherNet/IP
        • EtherNet/Ip Connection Properties
        • EtherNet/Ip Endpoint Properties
      • FOCAS
        • FOCAS Connection Properties
        • FOCAS Endpoint Properties
      • Hottinger Baldwin Messtechnik (HBM)
        • HBM Connection Properties
        • HBM Endpoint Properties
      • Heidenhain DNC
        • Heidenhain DNC Connection Properties
        • Heidenhain DNC Endpoint Properties
      • HTTP/REST
        • HTTP/REST Connection Properties
        • HTTP/REST Endpoint Properties
      • HTTP Server/Node
        • HTTP Server Properties
        • HTTP Node Properties
      • InfluxDB
        • InfluxDB Connection Properties
        • InfluxDB Endpoint Properties
      • Kafka
        • Kafka Connection Properties
        • Kafka Endpoint Properties
      • Modbus/TCP
        • Modbus/TCP Connection Properties
        • Modbus/TCP Endpoint Properties
      • MQTT
        • MQTT Connection Properties
        • MQTT Endpoint Properties
      • MSSQL
        • Mssql Connection Properties
        • Mssql Endpoint Properties
      • OPC DA
        • OPC DA Connection Properties
        • OPC DA Endpoint Properties
      • OPC UA
        • OPC UA Client
          • OPC UA Client Connection Properties
          • OPC UA Client Endpoint Properties
        • OPC UA Server
          • OPC UA Server Properties
          • OPC UA Node Properties
        • OPC UA Object Types
        • OPC UA Server References
          • OPC UA Reference Node
          • OPC UA Object Node
      • Siemens SIMATIC S7
        • Siemens S7 Connection Properties
        • Siemens S7 Endpoint Properties
      • Shdr
        • Shdr Connection Properties
        • Shdr Endpoint Properties
      • SINUMERIK
        • SINUMERIK Connection Properties
        • SINUMERIK Endpoint Properties
      • SOPAS
        • SOPAS Connection Properties
        • SOPAS Endpoint Properties
      • SQL
        • SQL Connection Properties
        • SQL Endpoint Properties
      • Werma WIN Ethernet
        • Werma WIN Ethernet Connection Properties
        • Werma WIN Ethernet Endpoint Properties
      • Systemstate
        • Systemstate Endpoint Properties
    • API Reference
      • User Management (API)
      • Client Registry (API)
      • Services (API)
      • Resources (API)
      • System Status (API)
      • Resource Status Tracking (HTTP API)
      • Industry Protocol Details (API)
    • Changelog
Powered by GitBook
LogoLogo

Cybus

  • Terms and Condition
  • Imprint
  • Data Privacy

© Copyright 2025, Cybus GmbH

On this page
  • License View
  • Acquiring License Keys
  • Online License Validation
  • Offline License Activation
  • Downloading License Files
  • Uploading License Files to Connectware
  • Manually Refreshing Licenses in Connectware
  • License Information via REST API

Was this helpful?

  1. Documentation
  2. Installation and Upgrades

Licensing

Connectware operates based on your license specifications, which determine available features and validity period.

PreviousUninstalling Connectware (Docker)NextRestarting Connectware

Last updated 4 days ago

Was this helpful?

Connectware requires a valid license key to operate. Each license key is uniquely tied to your instance and enables specific features based on your subscription. This section covers everything you need to know about obtaining, managing, and implementing your Connectware license.

For more information about available Connectware licenses, visit the .

License View

The License View displays information of your active Connectware license. Each time you start Connectware, the license is automatically validated over the Internet. If your Connectware installation does not have Internet access, you can upload a valid license file manually.

  • To open the License View, select System > System Status, and click the License tab.

The following information are available:

  • License Name

  • License Account

  • Expiration Date

  • License Class

  • License ID

  • License Status

Acquiring License Keys

Prerequisites

Procedure

  1. Enter your Username and Password, and click Sign in.

  2. Click Licenses in the menu to view all your available Connectware licenses.

  1. To obtain a new license key, click a license. We recommend to look for licenses marked as No license key created yet. You can use the No license key filter option to show only licenses without keys.

  1. Click Download License Key in the upper right corner.

  1. Add a description for your license and click Generate License Key.

Your new license key will appear on screen. Make sure to copy and save it somewhere secure, as you won't be able to view it again after closing this window. If you lose the key, you'll need to generate a new one, which will invalidate the previous key - even if it's already in use.

Result: Once you have your license key safely stored, you can proceed with Connectware installation.

Online License Validation

Offline License Activation

If Connectware is not connected to the Internet, you must activate your license manually through an offline process. This requires:

  1. Uploading the license file into your offline Connectware installation.

Downloading License Files

Downloading License Files via Installer Script

If you installed Connectware using the connectware-online-installer.sh script, you can use the same script to download your license file by adding the --download-license-file command.

To download the license file, you'll need either:

  1. Your original license key, which can be passed directly as a command-line option.

  2. The path to your existing Connectware installation directory.

Once executed, the script will download your license file and display its filename. You can then use this file to activate your offline Connectware installation.

Procedure

  • To download the license via the script with the license key (e.g. ABCABCABC,), do the following:

./connectware-online-installer.sh --download-license-file -k ABCABCABC
  • To download the license via the script using the Connectware installation directory (e.g. /opt/connectware), do the following:

./connectware-online-installer.sh --download-license-file -d /opt/connectware

Downloading License Files via the Cybus Portal

Prerequisites

  • A running instance of Connectware that you want to activate.

  • A valid license key that matches the one used during installation.

Procedure

  1. Click Licenses and select your license.

  2. Click the Download License File icon.

  1. In the Download License File dialog, do the following:

    1. In the Connectware License Key field, enter the license key of your Connectware instance.

    2. Click Download License File.

Uploading License Files to Connectware

You can activate your Connectware installation by uploading your license file through either:

  1. The Cybus Connectware License Check dialog at Connectware startup

  2. The Upload License File option in Connectware

  3. A REST endpoint with a command line client

  4. Adding the license file via the CYBUS_LICENSE_FILE environment variable

Uploading License Files at the First Connectware Startup

When you first access a not yet activated Connectware through your web browser, the Cybus Connectware License Check dialog opens.

  1. In the Cybus Connectware License Check dialog, click Upload License File.

Result: After a refresh the license file has been uploaded and validated. Your Connectware is now ready for productive use.

Updating your Connectware License

If your Connectware instance has already a running license that you want to update, you can do this via the Connectware user interface.

  1. On the navigation panel, click System.

  2. On the System Status View, click the License tab.

  1. Click Upload License File and select the license file that you want to upload.

Result: After a refresh the license file has been uploaded and validated. Your Connectware is now ready for productive use.

Uploading Licenses via REST API

You can upload your license using a REST API call from the command line. This method requires a REST client - we recommend using curl.

Here's how to make the request:

curl -X PUT --insecure -u <USERNAME>:<PASSWORD> -d 'payload=<LICENSE-FILE-CONTENT>' https://<HOSTNAME>:443/api/system/licensefile

Key details for the request:

  • Replace <USERNAME>:<PASSWORD> with your credentials

  • Insert your license file content as the payload value

  • Update <HOSTNAME> to your server's address

  • The endpoint is available at /api/system/licensefile

You can use this method both for initial license activation and for subsequent license updates.

Setting Up Your License Using Environment Variables

You can configure your license by setting the CYBUS_LICENSE_FILE environment variable in the system-control-server service.

Example

Here's how to configure your docker-compose.yml file:

# [...]
system-control-server:
environment:
    CYBUS_LICENSE_FILE: 'Zm9vYmFyZm9vYmFyZm9vYmFyZm9vYmFyZm9vYmFyZm9v...'
    CYBUS_REGISTRY_PASS: ${CYBUS_REGISTRY_PASS}
    NODE_ENV: production
hostname: system-control-server
image: registry.cybus.io/cybus/system-control-server:1.0.58
# [...]

Manually Refreshing Licenses in Connectware

Prerequisites

  • Internet connectivity is required for both automatic and manual license management.

Procedure

  1. On the navigation panel, click System.

  2. On the System Status View, click the License tab.

  1. Click Refresh License to sync with the Cybus Portal.

License Information via REST API

You can manually via the Refresh License button. You can via the Upload License File button.

The allows you to generate and manage license keys for your Connectware installations. This guide walks you through accessing the portal and generating new license keys. Once generated, you'll use this key during the Connectware installation process.

Access to the Cybus Portal. Contact our to obtain portal credentials if needed.

Go to the .

Connectware automatically validates your license during startup if it can reach the ) backend (graphql-server.cybus.io). When this connection is available, license updates occur automatically in the background. If the server cannot be reached, you must your Connectware license by uploading a new license file.

Downloading a license file from the via one of the following options:

You can download license files via the installer script or via the .

Next step: Transfer the downloaded license file to your Connectware host machine for activation. See .

Login credentials for the .

Log in to portal.cybus.io. If you don't have login credentials, contact .

Next step: Transfer the downloaded license file to your Connectware host machine for activation. See .

Select the license file you .

To do this, you need the license file that you have downloaded via .

You may need to manually refresh if your license has been upgraded on the but the changes are not reflected in Connectware.

The system status API allows you to retrieve information about your license. For more information, see .

Cybus Portal
Sales team
Cybus Portal
Cybus Portal
Cybus Portal
Cybus Portal
sales@cybus.io
Cybus Portal
System Status (API)
refresh your license
upload a new license file
Cybus Portal
manually update
Downloading License Files via Installer Script
Downloading License File via Cybus Portal Website
Uploading License Files to Connectware
Uploading License Files to Connectware
downloaded earlier
one of these options
Cybus website
Download License Key Button
Description of License Connectware
Download License Key Button
Generate License Key Connectware
Select Licenses Connectware
No License Key Connectware
Available Connectware Licenses
Output of License Key Connectware