Installing the Klocwork Server package on Mac
From current
Contents |
This page provides instructions for installing the Klocwork Server package using the installer.
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.
Prerequisites
- JVM versions: You must install JVM 1.6 Update 29 or later on your machine before installing the Klocwork Server or User package. If you have a previous JVM version installed and you try to install the Server or User package, you will see the error message, "Version of Java is too old". Apple supplies their own version of Java. Use the Software Update feature on your Mac.
- Access level: When installing the Mac packages, you must have administrator access.
- If your organization uses GCC, make sure the correct version of the compiler is in your PATH before you run the installation program. Including the GCC compiler in your PATH automatically creates default links to standard GCC libraries and defines for all the projects you create. Note that any user can override these defaults for a particular project or build by not including the standard libraries and defines. If your organization does not use GCC, do not include it in your PATH when you run the installation program.
Default settings and installation directories
- The Klocwork Server and User packages are installed in the /Applications/ and /Library/Frameworks/ directories.
- Symbolic links are set up in /usr/local/kw/, so you can access command-line tools more easily.
- The projects_root directory installs to /Users/Shared/Klocwork/ProjectsRoot/ by default.
- The Klocwork Servers are set to localhost, running on the default ports.
You can override server settings and specify where the projects_root is created during installation.
Note: All components of the Klocwork Server and User packages are installed. You can't specify which components you want to install.
Running the installation package
Copy the Klocwork Server installation package to your desktop and run it, following the prompts. Please note the following:
- The Server Settings screen is where you can adjust:
- the location for the projects_root. IMPORTANT: If you are upgrading, specify the old projects_root directory that you want to migrate.
- ports for the Klocwork and Database Servers
- 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.
Troubleshooting
Check the installation log from the Console (Applications > Utilities) or var/log/install.log.
Start the servers
Start the servers with kwservice start:
kwservice --projects-root <projects_root> start
- where <projects_root> is the projects_root directory you specified during installation
Example
kwservice --projects-root /space/klocwork/projects_root start
You see messages indicating that the servers have been started, showing the server host name and port number and the path to the projects_root. For example:
Using projects root: /space/klocwork/projects_root
Local Host is: serverxyz.com [13.1.1.142]
Starting License Server [started on serverxyz.com:27000] (projects root is /space/klocwork/projects_root)
Starting Database Server [started on serverxyz.com:3306] (projects root is /space/klocwork/projects_root)
Starting Klocwork Server [started on serverxyz.com:8080] (projects root is /space/klocwork/projects_root)
Next steps
Now you're ready to analyze your integration build.