On-Premises Installation

Information on how to set up Cavrnus On-Premises for Cavrnus Private Cloud.

On-Premises Installation

Information on how to set up Cavrnus On-Premises for Cavrnus Private Cloud.

Obtaining Certificate and Key Files for SSL Setup

The Cavrnus Web Client and WebGL version require that the server be hosted on HTTPS. A valid and trusted SSL key and certificate are required for this. Installed applications will be functional without a certificate.
  • Obtain your certificate and key files from a certificate authority. This is generally something that requires a third-party or an in-house service to setup. There are a number of public certificate authorities or you can use a popular free authority such as: Let's Encrypt.
  • Be sure to make note of the hostname you have set up your certificate and key files with. This will be needed in in the SSL setup process.

How to Install On-Premises Server

  1. Run the executable for the server install. It will extract the cavrnus-on-premises-installer.exe into the same folder.
  2. Create a folder on your hard drive where you want to locate the on-premises server files and copy the extracted cavrnus-on-premises-installer.exe to that folder.
  3. Launch a Command prompt and Run as Administrator.
  4. Change directory to the folder where the cavrnus-on-premises-installer.exe is located. To change the directory, use cd %the folder path%. Run the program by typing “cavrnus-on-premises-installer.exe” on the command prompt and hitting enter. If you are configuring SSL for your on-premises server, you will need your certificate and key files to answer the following prompts accordingly, otherwise continue to step 5 to complete your on-premises installation.
  5. “What address do clients use to reach this server?”. Return this inquiry with your local IP Address.
  6. “What address do clients use to reach this server?”. This refers to your hostname - this should be the same hostname you have selected during Certificate and Key file configuration.
  7. “Do you have an SSL key and trusted certificate? (y/N)”. You will return “Y” to proceed.
  8. You will then supply the file-path where your SSL Certificate (ssl.cert) and Private Key (ssl.key) file’s are located. *Both files need to be PEM-encoded.
  9. Follow the command prompts and hit enter to each of the prompts it steps you through. Almost always you should use the default values unless you have port conflicts, at that point you would provide port numbers that work inside your company network.
  10. Finally copy the machineID printed out at the command prompt and send to your Cavrnus representative. If you can’t copy the machine ID from the command prompt, then you can copy and paste the following URL into a browser to retrieve it: http://localhost:4000/machineid.
  11. To install the local application of the Cavrnus platform and to manage users and licenses, please visit http://localhost:8080/.

Very Important

The IP address on the server should never change; however, if it does change you will need to reinstall the server and have it associated with the new IP. You can reinstall the server by running the cavrnus-on-premises.exe application and selecting Re-Install Server option.

Installed Services

After a successful installation there will be 6 services installed in the Windows Services system. The Services that are installed and should be running are below:
  • Cavrnus API Service
  • Cavrnus Importer Service
  • Cavrnus LiveSwitch Gateway
  • Cavrnus LiveSwitch MediaServer
  • Cavrnus LiveSwitch RedisDB
  • Cavrnus MongoDB
  • Cavrnus Web Portals Service

Change Content Folder Storage

image2 (1).png

This can be done manually after the installation is complete. The content folder is where all the files are stored; therefore, the amount of storage needed could be significant. We recommend the content folder be on a drive with at least 500GB of storage. It is also recommended that it be stored on a RAID drive for data redundancy and reliability.

To change the folder that the Content is stored, edit the server\settings.json and change the "localcontentpath": "folder where the content is located”. Don’t forget to copy all the content over to that folder so it is available in the spaces that were created.

Note: Changing this setting will require restarting the server. The service can be restarted directly in the services window. Lastly, if you do change the folder, you should move all the files into the new folder as well.

Backup Data

The following database and content should be backed up regularly as it contains all the journal history, users, spaces, and content in the spaces.
  • Mongodb folder
  • Content folder

To create a new backup:

  • Navigate to “Backup Database” and hit enter. To complete the process, set up a name for your backup folder and hit enter.

To restore a backup:

  • Note: Please read the prompts very carefully before proceeding with “y”.
  • Navigate to “Restore Database from Backup” and hit enter. To complete the process, select the intended backup folder and hit enter to apply.

Note: To manually kill a service running in the Services use the following command on a Command Prompt that is Run as an Administrator:

taskkill/IM FM.LiveSwitch.Gateway.Service.exe/f
taskkill/IM FM.LiveSwitch.MediaServer.Service.exe/f