Installation

Connexion uses server-side processes (managed as a Windows service) for all runtime operations, and a client-side configuration tool (UI) for management.

Prerequisites

Version 17:

.NET framework 4.8.
Postgres 17 (or higher) or Sql Server 2016 (or higher)
Any modern version of Windows

Version 16 and below [Download 16.2 releases]:

.NET framework 4.8
Sql Server 2016 (or higher)
Any modern version of Windows

For trial installations, the free Sql Server Express edition can be used. It has a maximum database size of 10GB. The Configuration Wizard which runs as part of the Connexion installation can also install LocalDb, a small non-performant database for trial usage.

Host Sizing

For simple trial installations of Connexion, we recommend a minimum of 16GB of memory and 20GB of free disk space. Production instances should consider a number of other factors when choosing an initial host size. See Host Sizing, or get in touch with Conevity.

Packages

The Connexion platform is comprised of the server-side Connexion service (which hosts channels), and the client-side management application (UI). Typically, both the service and UI are installed on the Connexion host machine. The management application can be installed on other machines and connect to the Connexion service over the network.

We recommend keeping all traffic between the management application and Connexion service on the local network. Do not expose your Connexion instances to the public internet.

See the Releases section to download installers

Install

Prior to install, we recommend having an instance of Sql Server or Postgres running and accessible.

Run the installer executable

Select the package to install, click the EULA checkbox, and then the Install button

The installer will take about two minutes to deploy the files

Once the installer has completed deploying files, the Configuration Wizard will be displayed.

The Configuration Wizard is a component installed on the Connexion host machine which is used to configure settings required for the Connexion service to run. It can be re-run in the future to make configuration changes.

You do not need to re-run the installer to make configuration changes. Run the Configuration Wizard once files have been deployed.

The first step of the configuration wizard is to gather the Hardware ID and Licensee and send this information to Conevity (info@conevity.com). A license key will be granted, which you need to paste into the License Key text box. If you are trialling Connexion, you can also follow the Get Evaluation License link.

Paste the license key into the Configuration Wizard and click the Next button.

After pasting the license key, the license information will be displayed. Click the Next button.

Input the Sql Server DNS name or IP address into the Server Name field.
Choose the authentication mechanism (Windows or Sql Auth) as well as the relevant credentials, if required for an account with SysAdmin privileges (this account will be used to create the database and schema only). Press the Next button.

If you cannot provide a user with enough credentials to create the database, you can use the Skip some Sql Server sysadmin… checkbox and follow these instructions.

Choose the account used to run the Connexion service. This should be an account with limited privileges (by default, a low privilege account will be created and used).
Choose the account used to access Sql Server at run time. This should be a low privilege account which has DbReader and DbWriter credentials. By default, access will be granted to the default Connexion account.

A summary of the required databases is shown. In this case, no databases exist, so the defaults will be created. Press the Next button.

Enter optional configuration information. If you are evaluating Connexion, you can leave all defaults and hit the Next button.

Certificate (optional): Select a certificate which will be used to verify the identity of the Connexion service to the management application. The Management application will display this certificate on first connection and allow the user to accept or reject the connection. If the certificate is a valid (3rd-party validated) certificate, the management client will not prompt for acceptance. The default self-signed certificate is considered secure as long as your management application is run within your local network.

Ports (optional): Optionally choose different ports.

Management Port: The port the management UI will use to connect to the Connexion service.
Healthcheck Port: A port on which an simple HTTP service will listen. This service indicates the active Connexion application server when Connexion is part of an Active/Passive cluster. Your upstream switch can use this service to determine which Connexion instance to route traffic to.
External Queuing Port: Connexion can receive messages from other external Connexion instances via this port.

Change Tracking (optional): When saving a channel, a prompt is displayed to enter a comment - much like a commit message.

Groups & Users: A list of Active Directory and/or Windows users and groups which will be considered administrators of Connexion.

Enter additional optional configuration options. If you are evaluating Connexion, you can leave these as default and click the Next button.

Connect to Integrator Gateway: If you’ve deployed a Gateway cluster, enter the DNS name of at least one Gateway Host. You can use the Test Gateway Connection to verify the connection can be made.

Connexion API: An API which can be used to perform specific Connexion actions programmatically.

Metrics Endpoint: If you wish to expose Connexion metrics to a Prometheus server.

Execute the configuration wizard action items.

Click the Next button to run the configuration action items

Each action item will be marked as compete (green) or failed (red). Hover your mouse over the red exception text to view any errors.

A successful configuration. Click Next to close the Configuration Wizard.

The management application will automatically launch. Shortcuts are also placed in the Start Menu as well as the Desktop.

A new/empty system should appear similar to the following. Please navigate to the Management Application Introduction to get an overview.