Install Admin Application

Anthony - Versasec Support
Anthony - Versasec Support
  • Updated

Introduction

The vSEC:CMS Admin Application lets administrators set up and manage the vSEC:CMS system. It's automatically installed on the vSEC:CMS server, but can also be installed on other computers for administrators. This guide will describe how you can install the Admin application on administrators computers.

Important
Starting March 2024, we will stop supporting the SOAP client interface. For best performance and compatibility, please switch to gRPC in the protocol settings. While SOAP will still be included in the product, we will no longer provide support for any problems you encounter while using it.
Note
For instructions on configuring the Admin Application service on the server-side, refer to the article vSEC:CMS Client-Server Communication for details.

Installation

From version 7.0 the vSEC:CMS Admin application will not be available as a selection option from the installation wizard. Therefore you will need to pass in command line parameter of -admin when launching the installer. Then you will see a flow like below:

  1. Launch the vSEC:CMS installer from a command window with -admin as a parameter on the client host and click I Agree.
  2. The option Admin: Admin interface to the server will automatically be selected and click Next.

Untitled.png

  1. Select the default location for the installation or click Browse to install to a different location. Click Install to begin the installation.
  2. When it's finished, you can click Close.

If you are updating from a version prior to 7.0 then the installer will automatically determine that the Admin application is installed and use this type for the application update, therefore you do not need to pass in the -admin parameter.

Configuration

Starting from version 6.3, you can configure the connection settings by launching the application from the desktop shortcut. Upon launching the console for the first time, you will encounter a dialog similar to the one below.

admin_application_settings.png

Configuring gRPC connection to the vSEC:CMS Server:

  1. From the Protocol dropdown list, select Force gRPC.
  2. Locate the Server URL (gRPC) field in the dialog box.
  3. Enter the URL of the backend server where gRPC is listening, in the following format.
    • http://<server-host>:<port-number>
    • https://<server-host>:<port-number> if SSL/TLS is enabled.
  4. Once the URL is entered, click Test to check the connection.
  5. After verifying the connection status, click Ok to finish setup.

By completing these instructions, you'll have successfully configured your gRPC connection to the vSEC:CMS Server, enabling seamless operations and management.

Silent Installation

It is possible to perform a silent install and configure the backend connection using the following parameters:

  • -admin: This parameter to required from version 7.0.
  • /S: Use this parameter to initiate silent installation.
  • -grpc_client: Specifies the Server URL for the gRPC listener.
  • -server_proto 4: Specifies the use of the gRPC protocol.

Silent Installation via PowerShell

Below is an example demonstrating the utilization of silent install parameters, in conjunction with the Server URL:

PS C:\> .\vSEC_CMS_Setup.exe /S -admin -grpc_client "https://vSEC-CMS:50550/" -server_proto 4
Ensure that the entered Server URL is valid and accessible from the client. Additionally, make sure to run the PowerShell session with administrative privileges.

Registry Configuration

You also have the option to configure the Admin Application through the registry, utilizing either host-wide configurations or per-user settings.

Registry Path

For per-user configurations, use the following registry location:

[HKEY_CURRENT_USER\Software\Versatile Security\vSEC_CMS_T]

For host-wide configurations, use this registry location:

[HKEY_LOCAL_MACHINE\SOFTWARE\Versatile Security\vSEC_CMS_T]

Registry Settings

The registry values are:

  • cms.adm.server.protocol: REG_DWORD
    • 4: Force gRPC
  • grpc.adm.server.url: REG_SZ
    • http://<server-host>:<port-number>
    • https://<server-host>:<port-number>if SSL/TLS is enabled.