Understanding the Setup Manager
Use the Setup Manager to update, install and configure, or modify K2 components.
Components fall into three categories:
- Server Components
- Client Components
- Required Components
When running the Setup Manager, the Select Components page allows you to select or deselect components, or when performing a configure or modify with the Setup Manager, which components are installed and can be selected/deselected.
The Setup Manager has two modes: graphical user interface (GUI) and the command line interface. Both are accessible using the Setup.exe file in either the root of the installation media's extracted folder or from the "%ProgramFiles%\K2" folder after installation has taken place.
The Setup Manager can also be used to generate an XML file that will be used for Unattended Installations.
Command line
The tables below list the Options and their parameters available when using setup.exe from the command line.
Run SourceCode.SetupManager.exe /? to see help on the command line options in the console window.
| Usage | Description |
|---|---|
| SourceCode.SetupManager.exe |
/? |
| Options | Description |
|---|---|
| /systemkey | Get the system key for this server and write it to
the console. The /systemkey option can be used with the /noui option and/or with the :path parameter, for example SourceCode.SetupManager.exe /systemkey:"C:\Program Files\K2". K2 recommends not using the path parameter. K2 generates the system key using the K2 installation folder and other system parameters. This means that if you enter an incorrect K2 installation folder path in the path parameter, the returned key will be incorrect and you will receive licensing errors if you use this key in the future. See the path parameter in the table below for more information. If you use the /systemkey option with the /noui option for a silent installation (with no user interaction), you must use the following command: SourceCode.SetupManager.exe /noui /systemkey Using setup.exe /systemkey /noui requires you to press Enter to continue after the console displays the system key. |
| /output | Generates an XML configuration file after gathering environment information by walking through Setup Manager pages. |
| /install | Run the unattended (silent) installer with the specified XML file. |
| /loglevel | Specify the log level to be used (optional). |
| /update | Run the unattended (silent) installer to update installed components. |
| /config | Configure an existing installation. |
| /configcomps | Configure specified components. |
| /var: | Override variables like [LICENSEKEY] and/or [USERSPASS] during installation. Use the tilde character (~) to separate multiple variable overrides. Example: SourceCode.SetupManager.exe /Update /var:[LICENSEKEY]=XXXXXXXXXXXXX~[USERSPASS]=XXXXX This is an advanced feature and can be destructive. Any variables passed in like this will be on an override list and they will not change even if they were to normally change during execution of the install. |
| /remove | Remove an existing installation. |
| /analyze | Analyze an existing installation to see if it is valid. |
| /noval | Strips validation from the Next button on two installer panels: Exchange & SmartActions. This means that no validation takes place when the Next button is clicked.
The Test button on those panels still performs validation on demand. This action is also logged for troubleshooting purposes. |
| /noui | Outputs the result of the action to the console instead of the normal UI, works with: /systemkey |
| /allowsys | Stops the installer from blocking the local system account from installing. |
| Examples | Description |
|---|---|
| SourceCode.SetupManager.exe /? | Displays the command line options. |
| SourceCode.SetupManager.exe /output:MyConfig.xml | Launches the Setup managers and outputs the environment settings to ‘MyConfig.xml’ file. |
| SourceCode.SetupManager.exe /systemkey | Output the system key generated during the creation of the XML unattended installation file, to the console. |
| SourceCode.SetupManager.exe /noui /systemkey | Output the System Key to the Console. |
GUI
The Graphical User Interface walks you through the installation process. Some of the pages provide information while others require input of configuration information - like SQL connection details - before the setup manager can continue.
Typically the setup Manager steps through the following pages:
| Page | Description |
|---|---|
| Welcome | Simple welcome. |
| K2 version check | Checks the installation media's version against the latest release version. |
| End User License Agreement | Displays the EULA. |
| License key entry | Page where you enter your license key. |
| Component selection | Tree view of components to install, upgrade or modify. |
| Database connection details | Page used to enter database connection details. |
| Integration configuration | A number of possible pages allowing integration configuration for 3rd party software like: Exchange Server; IIS (K2 Site) etc. |
| Configuration Summary | Page displaying the configuration about to be installed. |
| Additional Actions | Page displaying any addition actions like required redistributable packages being installed. |
| Installation Progress | Installation status information page. |
| Configuration Analysis | Post installation configuration analysis which will display any warning or errors concerning the installation and information on how to correct any issues. |
| Finish | The Finished page appears when the installation is complete. |