Standard Deploy

This page describes how to do 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 links for KX Dashboards.

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

  4. 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 or a new one.

  5. 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 see here.

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

    • Linux and MacOS: Manually open a terminal and launch the processes.

      Bash

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

      Note

      Options

      -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.

Information

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

Next Steps