Skip to content

Quick Start

Choose the path that matches your Console deployment.

PathConsole operatorWhat you do
Self-hostedYour organizationLaunch the Console binary, complete the setup wizard, and deploy Sensors
ManagedTelovixOpen the provisioned Console and deploy Sensors

Self-hosted quick start

Before you begin

You need:

  • an active self-hosted deployment in Telovix Portal;
  • a Linux host sized for the complete stack;
  • reachable PostgreSQL and ClickHouse services;
  • the Console binary for amd64 or arm64;
  • browser access to the Console host on port 15483 by default.

For a small all-in-one pilot, start with 8 vCPU, 24 GiB RAM, and 250 GiB of fast persistent storage. This baseline covers the Console, PostgreSQL, ClickHouse, and retained data. See Requirements before production use.

1. Create the deployment and download Console

  1. Sign in to Telovix Portal.
  2. Create or select a Self-hosted deployment.
  3. Open Downloads.
  4. Download the Console binary for the target architecture.
  5. Verify the downloaded SHA-256 value against the value shown in the Portal.

The Console binary contains the web application and the supported Sensor packages. There is no separate frontend installation.

Portal Getting Started page showing a Telovix self-hosted deployment with the Issue License and Download buttons
Portal Getting Started - self-hosted deployment with Issue License and Download buttons Click to enlarge

2. Launch the binary

Run the binary from a directory that will remain on the host:

bash
mkdir -p telovix-console
mv telovix-console-linux-amd64 telovix-console/
cd telovix-console
chmod +x telovix-console-linux-amd64
./telovix-console-linux-amd64

Use telovix-console-linux-arm64 on an ARM64 host. The first run creates a telovix-data directory beside the binary and starts the setup experience on port 15483.

Keep this process running while completing setup. For production, run the same binary through your service manager and keep its working directory and data directory persistent.

3. Register the Console ID and issue the license

  1. Open https://<console-host>:15483.
  2. The first-run wizard displays the Console ID on the activation step.
  3. Copy the ID.
  4. Return to the self-hosted deployment in Telovix Portal and register the ID.
  5. Issue and download the signed license bundle for that deployment.

The license is bound to this Console ID. A bundle issued for another Console will be rejected.

4. Complete the setup wizard

The wizard guides you through:

  1. License: upload or paste the signed license bundle.
  2. Storage: enter and test PostgreSQL and ClickHouse connections.
  3. Platform: choose Standard or Telecom.
  4. Event buffer: optionally configure a Redpanda Kafka endpoint when your deployment uses it.
  5. Administrator: create the first Admin account.
Setup wizard license import step showing the file upload field and a successful validation state.
Setup wizard license import step showing the file upload field and a successful validation state. Click to enlarge
Setup wizard storage step showing the PostgreSQL URL field, ClickHouse URL field, platform vertical selector (Standard / Telecom), and optional Redpanda broker field.
Setup wizard storage step showing the PostgreSQL URL field, ClickHouse URL field, platform vertical selector (Standard / Telecom), and optional Redpanda broker field. Click to enlarge
Setup wizard admin creation step showing the email, display name, and password fields with strength indicators.
Setup wizard admin creation step showing the email, display name, and password fields with strength indicators. Click to enlarge

PostgreSQL and ClickHouse must be reachable when you test the Storage step. The wizard initializes the required schemas after the connections pass.

The Console generates its local trust material automatically. You do not need to create certificates before opening the wizard. Organizations with an internal PKI can configure their approved certificate workflow after planning the deployment.

5. Enroll the first Sensor

  1. Sign in to the Console.
  2. Open Sensors > Deploy.
  3. Select VM / Bare Metal, Kubernetes, or Ephemeral.
  4. Enter the requested node or cluster information.
  5. Select Standard or Telecom.
  6. Copy and run the command generated by the wizard.
Deploy Sensor wizard showing the node name field, role selector, flavor selector (standard or telecom), and the generated one-line install command.
Deploy Sensor wizard showing the node name field, role selector, flavor selector (standard or telecom), and the generated one-line install command. Click to enlarge

For a VM or bare-metal test, run the generated command as root on a supported Linux node. For Kubernetes, run the generated Helm command from a workstation with cluster-admin access.

6. Verify visibility

In Sensors > Fleet, confirm:

  • the Sensor appears within approximately one minute;
  • its status is healthy;
  • the displayed version and flavor are correct;
  • runtime events appear in Monitor > Live Feed;
  • processes appear in Monitor > Runtime Explorer.
Fleet view showing the newly enrolled sensor with healthy trust state, first heartbeat timestamp, node role, and flavor label.
Fleet view showing the newly enrolled sensor with healthy trust state, first heartbeat timestamp, node role, and flavor label. Click to enlarge
Sensor detail page showing a `file_open` event for `/etc/shadow` under Recent Events, with process name, file path, and timestamp visible.
Sensor detail page showing a `file_open` event for `/etc/shadow` under Recent Events, with process name, file path, and timestamp visible. Click to enlarge

If the Sensor does not appear, check its local service or pod logs and verify it can reach the exact Console URL shown by the deployment wizard.

Managed quick start

  1. Create or select a Managed deployment in Telovix Portal.
  2. Wait until its status is Ready.
  3. Open the Console URL and sign in with the configured administrator account.
  4. Open Sensors > Deploy.
  5. Select the deployment type and run the generated command.
  6. Confirm the new Sensor is healthy in Sensors > Fleet.

Storage, license bootstrap, and Console infrastructure are managed by Telovix in this path. You do not run the self-hosted setup wizard.

Next steps

Released under the Telovix Commercial License.