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 a containerized environment using Docker.

System Requirements

• Operating Systems

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

  • Docker Engine or Docker Desktop

• A Docker personal access token with Read-only privileges.

Windows Instructions

Prerequisites

1. Install WSL 2 (Windows Subsystem for Linux)

2. Install Docker engine for Windows Server or Docker Desktop for Windows Workstation

3. Create a classic Docker personal access token with Read-only privileges.

Installation

1. Open command prompt or PowerShell prompt with Administrator privileges. From the prompt, run the following commands:

   1. Create a directory that will be your deployment’s storage path. All configuration, database, user generated content and log data will be stored here. For example:
      mkdir C:\YourStoragePath

   2. Download the Platform Installer Container
      docker pull cavrnus/installer

   3. Create a Docker container network for the deployment
      docker network create cavrnus

   4. Run the Platform Installer with a volume pointing to your storage path
      docker run --rm -v /c/YourStoragePath:/var/cavrnus -v /var/run/docker.sock:/var/run/docker.sock -p 5000:8080 --network cavrnus --name cavrnus-installer cavrnus/installer
      Make sure your volume mount option points to the same drive and path as your storage path

2. Open a browser to http://localhost:5000 to start the installer

Linux Instructions

Prerequisites

1. Install Docker engine

2. Create a classic Docker personal access token with Read-only privileges.

Installation

1. From a shell command prompt, run the following commands:

   1. Create a directory that will be your deployment’s storage path. All configuration, database, and log data will be stored here. For example:
      sudo mkdir /var/cavrnus

   2. Download the Platform Installer Container
      sudo docker pull cavrnus/installer

   3. Create a Docker container network for the deployment
      sudo docker network create cavrnus

   4. Run the Platform Installer with a volume pointing to your storage path
      sudo docker run --rm -v /var/cavrnus:/var/cavrnus -v /var/run/docker.sock:/var/run/docker.sock -p 5000:8080 --network cavrnus --name cavrnus-installer cavrnus/installer
      Make sure your volume mount option points to the same drive and path as your storage path

2. Open a browser to http://<host-address>:5000 to start the installer

 Related resources