Installing the Klocwork Server package on Windows
From current
Contents |
This page provides instructions for installing the Klocwork Server package using the installation wizard. For instructions on unattended installation of both the Klocwork Server and User packages, see Unattended installation on Windows.
You can either put the user packages where users can download and install them ("pull" installation) or, if your organization is set up for it, you can install the clients for your users in an unattended ("push") installation through a Software Management System (SMS) or similar system. In the "pull" scenario, you need to let your developers know where they can access the User package.
Before you begin
Upgrading? See Upgrading from a previous version.
Where do I get the software? You download the Klocwork Server and User packages from https://my.klocwork.com. Typically, only one or two users in an organization have access to my.klocwork. If you don't have a password, contact Klocwork Customer Support.
You need a license. See Getting a license if you don't already have one.
Running two versions of the Klocwork Servers
If you will be running two sets of the Klocwork Servers, for example to test the Klocwork Insight 9.5 Servers while users continue to access your existing servers, you must run them on different projects_root directories.
On Windows, if Klocwork detects another version of the Klocwork Servers running as Windows services during installation, it will set the startup type for the previously installed servers to "manual", rather than "automatic". This ensures that when the host machine is rebooted, only the newly installed servers will start as Windows services, thus preventing a conflict.
Required permissions
- Administrator access is required to install all Windows packages, whether using the installation wizard or unattended installation.
- You must have administrator access to install the Klocwork Server.
- You must have administrator permissions to start the Klocwork Servers (and to run the Klocwork Servers as Windows Services).
Installation using the Windows installation wizard
Run the Klocwork Server installation wizard, following the prompts. Please note the following:
- You can specify server information during installation in the Klocwork Servers configuration screen to override the default settings. The defaults for the License Server are localhost and 27000. The default port for the Klocwork Server is 8080. See Viewing and changing Klocwork server settings for more information on ports.
- For information on the Use secure server connection (HTTPS) checkbox, see Using a secure Klocwork Server connection.
- You'll be asked where you want to create the projects_root directory, which is the data location for the Klocwork Servers and applications. It contains Klocwork Server settings and information about integration projects and build analysis runs. It also stores the Klocwork license file. The default location is <Server_install>\projects_root.
- Caution: Do not install the Server package and the projects_root in the Program Files directory. Default security settings for Windows 7 and Windows Server 2008 restrict writing to files in the Program Files directory.
- IMPORTANT: If you are upgrading, specify the old projects_root directory that you want to migrate.
- During installation, you specify whether you want to use the locally installed License Server (Local) or connect to a remote License Server (Remote). Local, the default option, requires you to browse to your license file. If you select Remote, you must specify the host name and port number for your License Server.
- You have the option of starting the Klocwork Servers as Windows services automatically following installation. This option is available on the Set up Klocwork Servers dialog of the Server package installer. If you do not select this option, you need to start the servers manually following installation. See Start the servers below.
Note: The installation package will automatically detect whether you have a 32-bit or 64-bit operating system and will install the appropriate version of Java.
Note on the Path environment variable
On Windows, the Klocwork bin directory is automatically added to your Path environment variable as follows:
| Installation package | Environment variable modified | Value used |
| Server | System Path | <server_install>/bin |
| User | User Path | <user_install>/bin |
Log files for Windows installation
An installation log file is saved to the Temp directory of Local Settings whenever one of the Klocwork installation packages is started on Windows. For example, on Windows 7, the installation log file is saved to \Users\<user>\AppData\Local\Temp.
These log files are named Klocwork<release_number>-<package>.log. For example, the installation log file for the Klocwork 9.5 Server package is named Klocwork9.5-Server.log.
A logs directory is also created in the root Klocwork installation directory during installation. For the Server installer, for example, the log files in this directory store kwservice output when the servers are first started and the projects_root directory is initialized.
If you need to troubleshoot your installation, check these logs.
Start the servers
If you did not already start the servers during installation, start them now, using Windows Services Administration or kwservice start:
kwservice --projects-root <projects_root> start
- where <projects_root> is the projects_root directory you specified during installation
Example
kwservice --projects-root C:\klocwork\projects_root start
Next steps
Now you're ready to analyze your integration build.