search
Contact Uscybus.io

Installing Connectware (Docker)

Install Connectware on Docker using Docker Compose.

This guide walks you through installing Connectware on Docker using an installer script. The script automates the setup process and supports both interactive and silent installation modes. You can optionally configure Connectware to run as a systemd service for automatic startup.

hashtag
Prerequisites

Before installing Connectware, make sure to meet the following requirements:

  • Connectware license key is available.

  • You have an Internet connection to download Docker images from registry.cybus.io.

  • Docker and Docker Compose are installed and running on your host.

    • For more information on installing Docker, refer to the Docker documentationarrow-up-right. Docker Desktop includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.

  • You are familiar with Docker.

hashtag
Preparing the Installer Script

The installer script allows you to quickly install Connectware.

  1. Download the installer script for the Connectware version that you want to install.

wget -O ./connectware-online-installer.sh https://download.cybus.io/latest/connectware-online-installer.sh

  1. Make the script executable:

Result: You can now run the installer script to install Connectware.

You can run the installer in two modes:

hashtag
Running the Installer Script

circle-exclamation

You can run the installer script without administrator rights in most cases. However, sudo privileges are required in two scenarios:

  1. When setting up Connectware as a systemd service (recommended).

  2. When installing to a directory that needs elevated permissions.

Since this guide demonstrates installing Connectware with systemd service integration, we will use sudo in the following commands.

  1. Run the installer script:

  1. The installer displays the Connectware version. Press Enter to confirm.

  2. Enter your desired installation directory, or press Enter to use the default path: /opt/connectware

  3. The installer runs preflight checks to verify all system requirements are met. If any checks fail, review the Prerequisites section and check if your system meets all requirements.

If all requirements are met then you should see the following output.

  1. Enter your Cybus license key when prompted. If your license key is valid, you will see a success message.

  1. Enter the ingress hostnames under which you will access Connectware. You can specify multiple values by separating them with commas. This allows you to define any hostnames, wildcard domains, and IP addresses that agents use to connect to Connectware. All values are added to the certificate's SAN field, enabling secure agent connections through any of the configured access points. You can change the hostnames later by setting the CYBUS_INGRESS_DNS_NAMES environment variable.

circle-info

If you are replacing the external Connectware CA certificate chain and manage cybus_server.crt manually, ensure that any DNS name with which you address Connectware or individual components is included. You can skip adding them to CYBUS_INGRESS_DNS_NAMES.

Example

  1. Choose whether to run Connectware as a systemd service. Without this, you must start Connectware manually after each system restart. In this guide, we press Enter to confirm.

  2. Review the configuration summary and confirm your settings are correct. If you followed the steps in this guide, you should see the following output.

  1. The installer downloads the Connectware container images. After download completes, it checks for old container images from previous Connectware versions that can be safely removed ("pruned") to free disk space. The installer asks for confirmation before removing any images.

  1. After confirming, the installer displays the image removal results and shows a success message with commands to manage Connectware. In our example, you should see the following output:

hashtag
Running the Installation in Silent Mode

The installer supports an automated deployment mode that requires no manual intervention. You can activate this by using either -s or --silent when running the installation script.

For silent installations, you must provide your license key through the --license-key parameter. By default, this method installs a basic version of Connectware to /opt/connectware and skips the systemd service setup.

If you need to customize your installation, the script offers several configuration options. Run the installer with --help to view all available parameters.

hashtag
Updating SSL Certificates

When you need to update your SSL certificates (such as after a Let's Encrypt renewal via certbot or when adding self-signed certificates), follow these steps:

  1. Copy the new certificates to the container:

  1. The name of your Connectware container depends on the directory it was installed to and is rendered as <your-connectware-directory>_connectware_1. By default, Connectware is installed to /opt/connectware/ which results in the container name connectware_connectware_1.

  2. Restart the Connectware container to apply the new certificates. Replace <your-connectware-container> with the name of your Connectware container:

PreviousInstalling Connectware (Kubernetes)NextUpgrading Connectware

Last updated

Was this helpful?