3.4. Console-based Installation

3.4.1. Step 1: Language
3.4.2. Step 2: Welcome
3.4.3. Step 3: Information
3.4.4. Step 4: Licensing Agreements
3.4.5. Step 5: Target Path
3.4.6. Step 6: Select Installation Packages
3.4.7. Step 7: User Data
3.4.8. Step 8: Installation
3.4.9. Step 9: Perform External Processes
3.4.10. Step 10: Setup Shortcuts
3.4.11. Step 11: Installation Finished

The installer also supports a GUI-less variant which only needs a shell/command window and can be invoked by adding the option -- -console to the command line.

This installer displays the content of an installer page in a panel in the shell window and lets the user input her choices via keyboard.

The buttons are replaced by short key sequences:

Enter

shows the next page or accepts a default value

1+Enter

selects a checkbox

0+Enter

deselects a checkbox

n+Enter

chooses the nth item from a list

3.4.1. Step 1: Language

The Language panel ( Section 3.3.1, “Language Selection”) is displayed. Enter 0+Enter for English or 1+Enter for German Language.

    Select your language
    0  [x] eng
    1  [ ] deu
    Enter selection:

3.4.2. Step 2: Welcome

The Welcome panel ( Section 3.3.2, “Step 1: Welcome”) is displayed and wants to be committed by 1+Enter.

    -----------------------------------------------------------------------------------------
    Information
    -----------------------------------------------------------------------------------------


    Version 5.5.5
    (c) Copyright 2009-2023 verit Informationssysteme GmbH. All Rights Reserved.



    Press 1 to continue, 2 to quit, 3 to redisplay
    1

3.4.3. Step 3: Information

The Information panel ( Section 3.3.3, “Step 2: Information”) displays the release notes of the recent versions.

...

      Version 5.5.5

      New Features...


    Press 1 to continue, 2 to quit, 3 to redisplay
    1

3.4.4. Step 4: Licensing Agreements

The License panel ( Section 3.3.4, “Step 3: Licensing Agreements”) displays the Licensing Agreements, which must be accepted to continue with the installation. Commit with 1+Enter.

    -----------------------------------------------------------------------------------------
    Licensing Agreements
    -----------------------------------------------------------------------------------------

    Limited Use Software License Agreement

    PLEASE READ THIS AGREEMENT CAREFULLY BEFORE ATTEMPTING TO USE THE
    SOFTWARE OF verit Informationssysteme GmbH AND RELATED DOCUMENTATION
    (COLLECTIVELY, THE "SOFTWARE") AND BEFORE INSTALLING OR USING THE
    SOFTWARE. BY INSTALLING OR USING THE SOFTWARE, YOU ARE CONSENTING
    TO BE BOUND BY THIS AGREEMENT....

    limitations may not apply to you. You may also have other rights
    that vary from state to state.

    Press 1 to accept, 2 to reject, 3 to redisplay
    1

3.4.5. Step 5: Target Path

The Target Path panel ( Section 3.3.5, “Step 4: Target Path”) looks like this with the console installer:

    -----------------------------------------------------------------------------------------
    Target Path
    -----------------------------------------------------------------------------------------


    Select the installation path: [C:\Users\...\Klaros-Testmanagement]

You can press Enter to accept the proposed path or enter a different one. The path will be created, if it did not already exist. If the directory already exists, a warning is displayed, and you can cancel the installation or continue.

3.4.6. Step 6: Select Installation Packages

The Select Installation Packages panel ( Section 3.3.6, “Step 5: Select Installation Packages”) is more complex in console mode. The required packages (Java, Tomcat and Klaros-Test­management) are displayed for information only. Entering Y selects the installation of the PDF documentation, while N deselects it. You are then prompted to confirm your entry with 1 and Enter.

    -----------------------------------------------------------------------------------------
    Select Installation Packages
    -----------------------------------------------------------------------------------------

    Select the packs you want to install:

      [x] Pack ‘Java Runtime Environment’ required
      [x] Pack 'Tomcat 9 Application Server' required
      [x] Pack 'Klaros-Testmanagement required
    -----------------------------------------------
      [x] Include optional pack 'PDF-Documentation'
    -----------------------------------------------
    Enter Y for Yes, N for No: N
    Y
    Done!

    Press 1 to continue, 2 to quit, 3 to redisplay
    1

3.4.7. Step 7: User Data

After that, the installer requests user data ( Section 3.3.7, “Step 6: User Data”). The installation program displays default values that can be accepted or overwritten by pressing Enter. Checkboxes show [x] if the checkbox is set, or [ ] otherwise. Pressing Enter accepts the current value, which can be set and unset explicitly with 1 and 0 respectively.

In this example we adopt most of the default values. Only the memory settings and the tomcat admin password (without default values) are entered and the two checkboxes are unset:

    -----------------------------------------------------------------------------------------
    User Data
    -----------------------------------------------------------------------------------------
    Tomcat Server Settings:

    Server-Port: [18005]

    HTTP-Port: [18080]

    Session Timeout: [60]

    The minimum and maximum amount of memory available to the Tomcat process:
    Minimum (MB): [512]
    400
    Maximum (MB): [1024]
    1024

    The username and the password of the administrator account for managing the Tomcat server:
    Username: [admin]

    Password:
    **********
    Retype Password:
    **********

    ------------------------------------------
      [ ] Launch Application Server
    Enter 1 to select, 0 to deselect:
    0

      [ ] Launch Browser
    Enter 1 to select, 0 to deselect:
    0


    Press 1 to continue, 2 to quit, 3 to redisplay
    1

3.4.8. Step 8: Installation

Packages are displayed as soon as they are installed ( Section 3.3.8, “Step 7: Installation”).

    [ Starting to unpack ]
    [ Processing package: Java Runtime Environment (1/4) ]
    [ Processing package: Tomcat 9 Application Server (2/4) ]
    [ Processing package: Klaros-Testmanagement (3/4) ]
    [ Processing package: PDF-Documentation (4/4) ]
    [ Unpacking finished ]
    Installation finished

3.4.9. Step 9: Perform External Processes

This panel is skipped since we chose not to launch the server or a browser. Otherwise, startup messages of the server could be seen here. See Section 3.3.9, “Step 8: Perform External Processes” on how this is handled in GUI mode.

3.4.10. Step 10: Setup Shortcuts

In a GUI-less environment we typically do not want to create any menu entries or icons on the desktop, thus we choose N. See Section 3.3.10, “Step 9: Setup Shortcuts” for details on shortcut setup in windowed environments.

    -----------------------------------------------------------------------------------------
    Setup Shortcuts
    -----------------------------------------------------------------------------------------

    ----------------------------------
    Create shortcuts in the Start-Menu
    ----------------------------------
    Enter Y for Yes, N for No:
    N
    ------------------------------------------
    Create additional shortcuts on the desktop
    ------------------------------------------
    Enter Y for Yes, N for No:
    N

3.4.11. Step 11: Installation Finished

An automatic installation script with the selected user choices can be generated here, so that the same installation could be repeated for unattended updates or on other machines. Automatic installation scripts will work for unattended installations in console mode as well.

    Generate an automatic installation script
    Enter Y for Yes, N for No:
    Y
    Select the installation script (path must be absolute)[C:\Users\...\Klaros-Testmanagement
      \auto-install.xml]

    Installation was successful
    Application installed on C:\Users\...\Klaros-Testmanagement
    [ Writing the uninstaller data ... ]
    [ Console installation done ]

After finishing the installation, Klaros-Test­management is located in the directory /opt/klaros-testmanagement. In Section 3.12, “Installing as a System Service” you can find more information how Klaros-Test­management can be set up as a system service to run it automatically at system startup.