Send Feedback
Skip to content

Standard Deploy

This page describes how to perform a standard deployment of KX Dashboards using a zip file.

Prerequisites

KX Dashboards is a minimal portable install only requiring kdb+ 3.4+ to run.

  1. Install kdb
  2. Define q as a command

Download

  1. Access the end-user license agreement and review the details.

  2. Click I Accept, after verifying you agree to the specified terms and conditions.

Your account is registered and you are emailed a personal download link for KX Dashboards.

  1. Check your email for a message with the subject Download for KX Dashboards.

  2. Click on the link in the email to download a zip file.

    Note

    The download link is only valid for 24 hours. Once expired, you must return to the end-user license agreement page for a new one.

  3. Proceed with the installation steps in the next section.

Install and run

  1. Extract the KX Dashboards zip file.

  2. Run KX Dashboards and a sample data process (shown below). For details on what you see when KX Dashboards opens, refer to the open Dashboards section.

  3. Windows: Click dash.bat to launch from the KX Dashboards folder.

  4. Linux and macOS: Manually open a terminal and launch the processes:

    $ q sample/demo.q -u 1 &
$ q dash.q -p 10001 -u 1

    Options

    Flag Description
    -secure Restricts dash.q to access only functions defined on the .api namespace
    -p Listening port to serve KX Dashboards
    -u 1 Disables system commands and no access above start directory
    -u usr-pwd sets a password file for basic authentication
    -E TLS server mode

    See the full kdb+ and q command-line reference for more detailed explanations.

Info

Follow the steps in Upgrade to upgrade your existing installation to the latest version of dashboards.

Next steps