installerConfig.json

The installerConfig.json can be used to setup file is utilized for configuring the initial environment configuration for settings of the agent being installed agent. The file has to be located under the same location . It must be placed in the same directory as the .msi installer file.

The possible configuration options:

...

Name - Name of customer. Used to set the Sentry environment. Default: agent

...

ServerAddress- Address of the cluster. The address should be without the schema and should not include the port. Default: gvqa.gvdevelopment.k3s.getvisibility.com
IPV6 should be also supported but needs to be verified internally.

...

Configuration Options

• ServerAddress: The cluster's address (without schema and port). IPv6 is also supported; however, it requires internal verification.

• ServerUseSsl: Determines if SSL is used (true by default). When enabled, port 443 is used; otherwise, port 80 is used. The agent does not switch to an insecure channel if SSL fails.

• Language- initial language of agent. Default: en

• VisualStyle - Light or Dark mode. Default: Dark

• KeycloakClientId - The ClientId configured in Keycloak. Default: agent
  This option shouldn’t be changed in most cases - default keycloak configuration is sufficient.

• KeycloakUsername - The Username configured in Keycloak. Default: agent (email: agent@gv.com)
  This option shouldn’t be changed in most cases - default keycloak configuration is sufficient.

• KeycloakCertificateContent - The .crt of the user certificate. If no value provided then default is used.
  The content should be the content of the PEM certificate without the prefix (-----BEGIN CERTIFICATE-----) or suffix (-----END CERTIFICATE-----).

• KeycloakKeyContent - the .key of the user certificate. If no value provided then default is used.
  The key should be the content of the PEM key without the prefix (-----BEGIN PRIVATE KEY-----) or suffix (-----END PRIVATE KEY-----).

• SentryDsn - Sentry URL. Default: empty
  For internal use only.

Most of the time, changing only ServerAddress, Language, VisualStyle is enough for a customer installation:

...

• : Sets the agent's initial language. Options include ar, de, es, fr, he, it, pl, pt, th, zh. Default is en.

• VisualStyle: Chooses between Light or Dark mode, with Dark mode set as the default.

• KeycloakUrl: The agent now supports a different URL for Keycloak, if the URL is provided the agent will use the KeycloakUrl for authentication (otherwise the usual ServerAddress will be used).

• KeycloakClientId: The ClientId in Keycloak, typically agent by default. It is recommended not to change this unless necessary.

• KeycloakAuthType: Specifies the authentication method. Default is mTLS. Options include:

  • mTLS: Authentication via user certificate.

  • PasswordGrant: User password grant flow for authentication.

Authentication Configuration Details

For mTLS:

• KeycloakUsername: Generally, agent with email agent@gv.com (default). Changing this is usually unnecessary.

• KeycloakCertificateContent: The user's certificate in PEM format (excluding the BEGIN/END certificate lines).

• KeycloakKeyContent: The user's private key in PEM format (excluding the BEGIN/END private key lines).

For PasswordGrant:

• KeycloakUsername: Same as above.

• KeycloakUserPassword: The encrypted password corresponding to KeycloakUsername. Use GVClient.Tools.SetupHelper for encryption.

• KeycloakClientSecret: The encrypted client secret for the Keycloak client. Use GVClient.Tools.SetupHelper for encryption.

CLI Configuration (agent version >= 4.0.0)

As an alternative to installerConfig.json, configuration parameters can be provided via CLI arguments during installation:

msiexec /i "path_to_msi.msi" SERVERADDRESS="{server_address}" SERVERUSESSL="True" LANGUAGE="en" VISUALSTYLE="1" KEYCLOAKCLIENTID="agent_v2" KEYCLOAKAUTHTYPE="1" KEYCLOAKUSERNAME="agent" KEYCLOAKUSERPASSWORD="{pwd}" KEYCLOAKCLIENTSECRET="{secret}"

Ensure that all argument keys are in uppercase.

GVClient.Tools.SetupHelper

The GVClient.Tools.SetupHelper utility aids in creating a valid configuration for installation. It will walk through the configuration process and ultimately generate an installerConfig.json file and a corresponding CLI command.

...

Binaries:

• Windows -

  View file
  name GVClient.Tools.SetupHelper.zip

Example Configuration

For typical customer installations, altering the ServerAddress, Language, and VisualStyle is often sufficient:

{
  "ServerAddress": "123.example.abc.com",
  "Language": "en",
  	"VisualStyle": "Dark"
}

Remember to adjust the configuration according to the specific requirements of the installation environment.