Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


The Kiuwan On-Premises


installer is a powerful tool that suits multiple environment scenarios:

  • Single-host


  • fully contained installation.
  • Multi-host installation where infrastructure services are externalized.
  • Multi-host installation where


  • Kiuwan services are distributed.
  • Any combination of the two previous scenarios.

Depending on your needs, a different installation approach will be needed. Check this installation guide for details on how to proceed and to find the solution that best fits your requirements.

System requirements

Installation requirements

It is mandatory for any host where Kiuwan On-Premises is installed to meet these requirements:


Please follow Docker official recommendations when installing Docker. These URLs describe the installation process for different Linux distributions:

These software are also needed:

  • Docker CE >= 19.03.2
  • Docker-compose >= 1.24.1
  • Unzip
  • GNU tar
  • Wget
  • BC
  • Tee
  • Ip
  • Java Runtime Environment >= 8 (needed to generate keystores for custom hosts).
  • OpenSSL >= 1.1.1 (needed to generate certificates for custom hosts). Other supported versions of OpenSSL are 1.0.2g and 1.0.2k-fips.

Make sure that the docker-compose command can be executed with sudo. This means that the docker-compose binary file must be included in the sudoers path. The binary is usually installed under the /usr/local/bin directory. Depending on your OS, this information may be set in the secure_path variable in the sudoers file (/etc/sudoers). Please check the official Docker-compose documentation for more information:

It is also recommended to use the target installation hosts exclusively for Kiuwan


Kiuwan on premise installation process is carried out by our "kiuwan-cluster" tool.

The tool is provided as a tar.gz file. Once extracted you can find these resources:

  • /config
  • /docker
  • /logs
  • /ssl
  • /user-content
  • /volumes


services. If you plan on running other containers than Kiuwan's in a single-host installation, please make sure that:

  • None of them is using the following network:
  • There are no containers that may block any of these ports:
    • 443: standard HTTPS port (or the one you will configure to access your Kiuwan On-Premises installation).
    • 8143, 8243, 8343, 8443, 8543, 8643, 8743, 8843: ports that Kiuwan front instances listen to (or those you may configure for Kiuwan front instances).
    • 6379: port that Redis instances listen to.
    • 3306: port that MySQL instance listen to (or the port you configure for MySQL).
The Kiuwan On-Premises installation tool will check most of these requisites before installing. If any of them is not met, installation will be canceled.

Special requirements for RedHat, CentOS, and Fedora

If your docker server is running on RedHat, CentOS or Fedora, be sure the filesystem where docker is installed supports d_type (the directory entry data structure that describes the information of a directory on the filesystem).

Some of the above operating systems are not configured with d_type support (see

Running on XFS without d_type support causes Docker to skip the attempt to use the overlay or overlay2 driver. See

You can check if your existing XFS filesystem has d_type enabled by running the following commands:

Code Block
$ docker info | grep "Supports d_type:"
Supports d_type: true

$ xfs_info /docker-mount-point | grep ftype
naming =version 2         bsize=4096      ascii-ci=0     ftype=1

In case you get d_type: false or ftype=0, you will need to create a new XFS filesystem with d_type support enabled. Unfortunately, it isn't possible to enable d_type support on an existing filesystem.


The Kiuwan On-Premises installation tool will check if d_type is enabled on XFS filesystems and stop the installation if it is not.

There are two options:

  • Add a new disk and create a new XFS partition on it.
  • Backup your existing data and recreate the XFS filesystem with d_type support enabled.

You can create a new XFS filesystem with d_type enabled by running the following command:

Code Block
$ mkfs.xfs -n ftype=1 /mount-point

Needed internet connections

Please make sure your host machines have connection to these servers when installing Kiuwan On-Premises:

HostNeeded whenPurpose

* (all subdomains of, including nested subdomains)

* (all subdomains of

InstallingThese are the Docker servers where the needed images will be pulled from.
cdn.mysql.comInstallingDownload the mysql driver file needed during the installation process.
static.kiuwan.comInstallingThis is Kiuwan's static content server, needed by the installer to download needed resources.

You own a Kiuwan On-Premises Insights license, both for installing and running

This is Kiuwan's central API endpoint, needed to update Insights vulnerabilities database.

Proxy configuration

If the host on which you are installing Kiuwan On-Premises needs to access the internet through a proxy server, note that:

  • Your OS should know about your proxy settings in order to be able to download the Kiuwan On-Premises installer distribution.
  • Docker daemon must know about your proxy settings in order to download images from https://* or https://*
  • Docker must know about your proxy settings in order to propagate them to the created containers.
  • Direct access to your SMPT mail server is needed (it is MANDATORY that the host machine can access your mail server regardless of the proxy server).

To instruct your OS to use your proxy settings, please refer to the official documentation for your Linux distribution.

To make Docker daemon use your proxy server, please follow the official Docker documentation on how to set a proxy:

To make Docker use your proxy when creating containers, please follow the official Docker documentation on how to set a proxy to be used by the containers:

Remember to restart both docker daemon and docker to apply proxy configuration changes:

Code Block
sudo systemctl daemon-reload
sudo systemctl restart docker

You can check if Docker has successfully read your configuration by executing:

Code Block
docker system info

Check if your proxy configuration is shown in the console:

Code Block
HTTP Proxy:
HTTPS Proxy:
No Proxy: localhost,,


This is an example of a /etc/systemd/system/docker.service.d/http-proxy.conf file that makes the Docker daemon use a proxy:

Code Block

This is an example of a ~/.docker/config.json that makes Docker propagate proxy configuration to the created containers:

Code Block
	"proxies": {
    	"default": {
			"httpProxy": "",
			"httpsProxy": "",
			"noProxy": "localhost,,"

CPU and memory minimum requirements

The following table shows the minimum requirements for each service. Note that these are only minimum requirements. You should make sure to give each service enough resources depending on your system demands.

ServiceMemoryCPU cores
wildflykiuwan-f[n]2.5GB2 cores
wildflykiuwan-a[n]2.5GB per analysis slot2 cores per analysis slot
wildflykiuwan-s[n]2.5GB2 cores
mysql5GB4 cores
loadbalancer1GB1 core
redis_0000[n]2GB2 cores

Note: CPU clock speed and disk speed will affect the overall response time. 

With the above configuration, a system with the following load should give continuous service without problems:

  • Parallel processing of 2 analyses (any additional parallel analysis request will be enqueued, and it will be executed as soon as any of the running analyses finishes)
  • 50 concurrent web users or REST API calls.

Given the table above, for a single-host installation where no service is externalized the minimum system requirements are:

  • 18GB of RAM and a processor with 8 cores for Kiuwan On-Premises.

It is recommended that you overscale these characteristics for the OS to have resources available for itself.

The Kiuwan On-Premises installation tool (kiuwan-cluster)

The Kiuwan On-Premises installation process is carried out by our "kiuwan-cluster" tool.

The tool is provided as a tar.gz file. The following table summarizes the resources you will find once the tool distribution is extracted:

/config/volumes.propertiesConfiguration file to set where your persistent volumes will reside.
/docker/composeDocker compose files used to manage Kiuwan On-Premises' docker services.
/docker/*.shAdvanced shell scripts to interact with your Kiuwan


On-Premises installation.
/logsThe folder where the tool will write installation logs.
/sslTools that ease the certificate creation to keep Kiuwan


On-Premises under a secure environment.
/supportTools to ease collecting support data.
/toolsInternal tools used when installing.


The folder where you will have to put some resources


the installation process will need.


/volumesThe base persistent volumes (that may be copied to different locations depending on your installation needs).




Main shell scripts


to interact with your Kiuwan On-Premise installation.

The following sections will guide you through the installation process.

Installation: common steps

This guide will reference two important folders:

  • [INSTALLER_DIR]: where the installation tool (kiuwan-cluster) will be located.
  • [VOLUMES_DIR]: where the persistent volumes will be located.

Sometimes these folders will be referenced inside command line examples. Please make sure you replace any of them with the needed real path.

Note that it is up to you where these folders will be located.

Step 1: download kiuwan-cluster

The first step is to download kiuwan-cluster (the Kiuwan On-Premises installation tool). It can be downloaded directly from a terminal like this:

Code Block

This will download the latest available installation tool to the current directory.

Note that, as stated in System requirements, you will need access to in order to download this file. You should also check your proxy configuration if you access the internet over a proxy server.

Step 2: untar kiuwan-cluster

Once downloaded, you should untar the provided gz file:

Code Block
tar xvzpf kiuwan-cluster.tar.gz

This will untar the installation tool to a folder with extended version information of the tool. For example:


This folder will be referred to as [INSTALLER_DIR] throughout this guide.

Step 3: copy license files

In order to be able to start a Kiuwan On-Premises installation, you will need two license files:


Copy these files to the user-content folder of your installation tool directory (please remember to replace [INSTALLER_DIR] with the real location of your installation directory):

Code Block
cp [INSTALLER_DIR]/user-content
cp [INSTALLER_DIR]/user-content

Step 4: download and copy the needed driver version for MySQL

Kiuwan On-Premises needs this exact MySQL driver:


You can download it by executing this command and extracting the jar file included inside the tar:

Code Block

Untar the downloaded file:

Code Block
tar xvzpf mysql-connector-java-5.1.39.tar.gz

Copy the connector jar file to the user content folder:

Code Block
cp mysql-connector-java-5.1.39/mysql-connector-java-5.1.39-bin.jar [INSTALLER_DIR]/user-content

Step 5: configure the volumes paths

The installation tool provides the base volumes needed to boot a first installation of Kiuwan On-Premises. Three volumes are included:

  • config-shared: contains the base configuration, shared between different services.
  • data-shared: contains the base data structure, shared between different services.
  • data-local: contains the base data structure, independent for each service.

The installation tool needs to know where you want these volumes to reside. To do so, edit the file located in [INSTALLER_DIR]/config/ and set desired locations:

Code Block

Please remember that [VOLUMES_DIR] is just a placeholder for the real path you chose.

Note that you will need to create the configured folders by running:

Code Block
sudo mkdir [VOLUMES_DIR]

In case you are using different base directories for each volume, you must create all the needed base directories.


Do NOT use the same folder for different volumes. It is MANDATORY that each volume resides on a separated folder.

Step 6: initialize your volumes

Copy the provided volumes to the configured location by running this script:

Code Block
sudo ./

Step 7: configure your email server

Kiuwan On-Premises needs a working and accessible e-mail server to send notifications.

Edit with your preferred editor the main configuration file, found in your [VOLUMES_DIR]:

Code Block
sudo vim [VOLUMES_DIR]/config-shared/globalConfig/

Please note that this is the file located in your [VOLUMES_DIR], not in the [INSTALLER_DIR], which only contains the base volumes.

Edit the following properties under the section named "Kiuwan instances shared configuration":

  • the host of your email server.

  • kiuwan.mail.port: the port of your email server.

  • kiuwan.mail.authentication: a flag to indicate if your mail server needs authentication or not.
  • kiuwan.mail.username: the username to use when authenticating with your email server (only applies if kiuwan.mail.authentication is true).

  • kiuwan.mail.password: the password to use when authenticating with your email server (only applies if kiuwan.mail.authentication is true).

  • kiuwan.mail.from: the email account to use as the sender.

  • the security layer that your mail server uses (ssl, tls or none). Set to none if your mail server uses a plaintext connection.
  • the value to set to the ssl or tls (true or false). Only applies if is not none.
  • kiuwan.default.mail.account: the email account to set to the default Kiuwan user (kiuwanadmin).

Mail server configuration examples

If your mail server uses a plaintext connection without authentication, set these properties values (other mail server properties values will be ignored):

  • kiuwan.mail.authentication=false

If your mail server uses a TLS secure connection but does not need authentication:

  • kiuwan.mail.authentication=false

If your mail server uses a SSL secure connection and needs authentication:

  • kiuwan.mail.authentication=true
  • kiuwan.mail.username=myuser
  • kiuwan.mail.password=mypassword

If your mail server uses a plaintext connection and needs authentication:

  • kiuwan.mail.authentication=true
  • kiuwan.mail.username=myuser
  • kiuwan.mail.password=mypassword

Installation: single-host and minimum configuration

Follow this section if you want to proceed and install Kiuwan On-Premises with no further customization.

The defaults will install Kiuwan On-Premises with these characteristics:

  • Single-host installation, including these services (see Kiuwan On-Premises Distributed System Architecture for more details):
    • Apache as a load balancer.
    • A Kiuwan front instance.
    • A Kiuwan analyzer instance.
    • A Kiuwan scheduler instance.
    • MySQL database.
    • Redis cluster.
  • HTTPS support when accessing Kiuwan and between the loadbalancer and Kiuwan instances.
  • Kiuwan On-Premises deployed in the default domain (https://kiuwan.onpremise.local).

If this is enough for you, just continue with the following steps.

If you plan to change the default domain, please refer to the Modifying the default domain section before continuing and come back here after you have made the needed changes.

Step 1: deploy user content

On a terminal, navigate to the [INSTALLER_DIR] folder and execute this command:

Code Block
sudo ./

This will copy the user-content files to the configured volumes and set the needed permissions.

Step 2: install Kiuwan On-Premises

On a terminal, navigate to the [INSTALLER_DIR] folder and execute this command:

Code Block
sudo ./

This will:

  • Check if your host meets the minumum installation requirements.
  • Download and run the needed Docker images.
  • Install the database resources for Kiuwan On-Premises.
  • Download the latest available Local Analyzer, Engine and Kiuwan for Developers to make them available in your installation.
  • Install the engine data in your Kiuwan On-Premises database.
  • Autogenerate the needed configuration for each Kiuwan instance.
  • Run all the needed containers.

Once the installation is finisished please refer to the Accessing your Kiuwan On-Premises installation section.

Accessing your Kiuwan On-Premises installation

In order to access your Kiuwan On-Premises installation you should follow a few more steps.

Step 1: add your domain to your local network DNS

To access your Kiuwan On-Premises installation you should take into account whether the selected domain is available in the DNSs your local network may use.

In order to access Kiuwan you will need to do one of the following options:

  • Add kiuwan.onpremise.local to your DNS (recommended option).
  • Add kiuwan.onpremise.local to your hosts file.

For testing purposes or if you choose the second option, edit this file in the host where you plan to access Kiuwan from:

  • Windows OS: C:\Windows\System32\drivers\etc\hosts
  • Linux OS: /etc/hosts

Add the following entry to the previous file:

Code Block
[kiuwan_on_premise_host_ip] [kiuwan_on_premise_host]

For example, the previous entry may look like this for an installation pointing to the default host (note that the IP of the example may change in your local network):

Code Block kiuwan.onpremise.local

Step 2: add your certificates' CA to your clients

Depending on whether you are using a trusted CA or not to sign your certificates, you may need to add the CA to your client's certificate store to avoid warning messages. 

Please refer to the Adding the provided or a custom CA to Kiuwan On-Premises' clients section for a complete explanation on how to handle this depending on your installation configuration.

Step 3: access Kiuwan On-Premises

Accessing the web application

Once the previous steps have been done, you should be able to access Kiuwan On-Premises entering your Kiuwan host in your browser which by default is:

Code Block

Note that although the installation process may have finished, the Kiuwan servers may need some minutes to start up. If this is the case, a loading page will be shown (as long as you are using the provided Apache load balancer service):

Image Added

Once Kiuwan On-Premises services are started, you will be redirected to your Kiuwan On-Premises installation's main login page:

Image Added

Downloading Kiuwan Local Analyzer

Once logged into the web application, you can download Kiuwan Local Analyzer by clicking on the "Download Kiuwan Local Analyzer" option in the top right drop-down menu. 

 Image Added

Consuming Kiuwan REST API

To access your Kiuwan On-Premises installation via its REST API, you should point to this URL:

Code Block

Please refere to the Kiuwan REST API documentation deployed in your Kiuwan On-Premises server for more details:

Code Block

You can also access the REST API documentation through the link shown in your Kiuwan On-Premises login page.


There are no quota limits to Kiuwan REST API invocations anymore since Kiuwan On-Premises 2.8.1910.7.

Configuring Kiuwan for Developers

To install the Kiuwan for Developers plugin you should point to the corresponding download endpoint for each Kiuwan for Developers distribution:

IDE distributionHow to installURL

Add a new updatesite 

JetBrainsAdd a new custom plugin repositoryhttps://[KIUWAN_DOMAIN]/pub/jetbrains/plugins.xml
Visual StudioAdd an extension galleryhttps://[KIUWAN_DOMAIN]/pub/vsgallery/atom.xml
Visual Studio CodeDownload the extension package file and use the "Install from VSIX" optionhttps://[KIUWAN_DOMAIN]/pub/vscode/k4d-vscode.vsix

Please refer to the Kiuwan for Developers page for more information.

Default users

Kiuwan On-Premises is provided with two user accounts:

UsernameDefault password

Please make sure you change these passwords as soon as possible, by selecting the option "Account management" from the menu in the upper right corner and selecting "Change Password".