Platform Setup

TIVITY Core Setup CLI guide: installation, update, and uninstallation processes. Covers setup options, cached settings, and command verbs for efficient platform management and configuration.

TIVITY Core Setup

Tivity Core Setup command-line interface provides a tool to install, update or uninstall the TIVITY application which handles user interaction, app creation and source execution.

The result of the setup depends on the verb (install, uninstall or version) and options entered by the user or passed as arguments. Options are cached and saved in the setup.json. The cached options are used when the setup is invoked in the next times. For example, the option "core-backupenabled" is true by default which means that the core databases are backed up during the update and are restored on failure. If you change this option to false in the setup.json, the databases will not be backed up and restored, so that the administrator can do one backup for multiple (potential failing) setup attempts.

Install

The install verb is used to install or update the TIVITY Core application.

Options

  • path: The path of the instance to setup.

  • name: The name of the instance to setup.

  • host: The host of the instance to setup (e.g. localhost).

  • db-host: The SQL host of the SQL server to connect to.

  • db-port: The SQL port of the SQL server to connect to.

  • db-user: The SQL username to use to connect to the SQL server.

  • db-pass: The SQL password to use to connect to the SQL server.

  • db-path: The path for SQL server backups (available for the app and database server).

Cached Options

  • core-name: The name of the Web Site. Default: [name].

  • core-iislogs: The path of the IIS logs (relative to [path]). Default: IisLogs.

  • core-logs: The path of the logs (relative to [path]). Default: Logs.

  • core-temp: The path of the temp folder (relative to [path]). Default: Temp.

  • core-web: The path of the web application files (relative to [path]). Default: Web.

  • core-webdebugenabled: Determines whether debug is enabled (true or false). Default: true.

  • core-webuseminimized: Determines whether use the minimized web files (true or false). Default: false.

  • core-config: The name of the config database. Default: [name]_Config.

  • core-instance: The name of the instance database. Default: [name]_Instance.

  • core-license: The name of the license database. Default: [name]_License.

  • core-backupenabled: Determines whether the target databases will be backed up. Default: true.

  • core-version: The version of the installation.

  • apmserver-port: The port of the APM server APM data is sent to.

  • tika-port: The port of the Tika service.

  • search-port: The port of the Search service.

Uninstall

The uninstall verb is used to uninstall the TIVITY Core application.

Options

  • path: The path of the instance to setup.

Cached Options

  • core-name: The name of the Web Site. Default: [name]

  • core-temp: The path of the temp folder (relative to [path]). Default: Temp

  • core-web: The path of the web application files (relative to [path]). Default: Web

  • core-version: The version of the installation.

Version

The version verb will output the version of the setup (no options are supported).

Last updated