Cavrnus Platform Installer

The Cavrnus Platform Installer is an administration tool that assists with installing and managing a private cloud or on-premises deployment. It deploys an opinionated containerized environment using Docker.

System Requirements

• Operating Systems

  • Linux or Windows with WSL 2 (Windows Subsystem for Linux)

  • Docker Engine or Docker Desktop

Windows Prerequisites

1. Install WSL 2 (Windows Subsystem for Linux). Our containers are Linux based and therefore require a Linux environment. For more details about configuring Windows to run Linux containers, please see Set up Linux containers on Windows

2. Install Docker engine for Windows Server or Docker Desktop for Windows 10/11.

Linux Prerequisites

1. Install Docker engine

Installation

1. Download and extract

   1. Download the installer archive and extract it to a dedicated directory. After all the files have been extracted, run the installer application. On Windows this will be named cavrnus-server-installer-win-x64.exe. On Linux it will be named cavrnus-server-installer-linux-x64.exe. If startup is successful, your browser will launch the installer interface located at http://localhost:5000. This installer interface will guide you through the steps to configure and deploy the server containers.

2. Introduction

   1. Click Next to continue

3. Installer Key

   1. Choose Create a new installer key for a new deployment and a new key will be generated.

   2. Click Next to continue

4. Configuration

   1. Enter the hostname or IP address of this host machine. This will be used by client applications to connect to platform services

   2. Enter the directory on the host machine to use as the storage path. This location is used for storing configuration files, databases, user generated assets, and log data. You can optionally create this directory ahead of time or the installer will attempt to create it for you.

   3. You may optionally enable RTC for voice and video, change network settings such ports, and SSL settings. The advanced configuration allows more control over networking and also allows you to specify specific container versions.

   4. Click Next to continue

5. Registration

   1. Enter your organization’s name

   2. Enter your domain name for this installation. This identifier is used by your applications when they connect to platform services.

   3. Enter the credentials for creating a new administrator account that will be used to sign into the management console.

   4. Click Next to continue

6. Review

   1. This step allows you to preview the deployment configuration starting the installation.

   2. Click Start Installation to continue

7. Install

   1. The installer will proceed to download containers, create configuration files in your storage path, and configure various services.

8. Dashboard

   1. After the installation is successful, you will be routed to the Dashboard page. It provides tools to reset your administrator password as well as reinstalling or uninstalling platform services.

   2. You can navigate to the Management Console with the Management Console link in the right side of the page and login with the credentials you supplied during the registration step.

9. Management Console

   1. Open the console with the Management Console link in the right side of the dashboard page or browse to http://localhost depending on the port and SSL settings you configured.

   2. Login with the credentials you supplied during the registration step

10. Activating the installation

    1. In order to create additional users and connect to spaces, you’ll need to provide a license file to activate the installation.

       1. From the Management Console’s main menu, click Subscription

       2. Copy the Installation ID and the Organization ID and send that information to us. We will provide you a license file to upload to your installation.

Network Ports

If your environment uses network firewalls, you may need to open the following ports to allow clients to connect to platform services. These ports can be overridden during installation.

 Related resources