Linux quickstart

Downloads and public test settings#

Download the files below directly. The downloads guide provides the public test key and configuration; pair the device code in your own account for testing.

e22b4792bbdc58878c67c5104d182422f8accfea9da10379252e0a5296d3e57a

58d120c0f123169726077a8845ac2619692cb14b45058e72a5aaa80700d6e5d0

Prerequisites and scope#

Run as a normal user, not root. Terminal requires /bin/bash and a PTY. For desktop mode, deploy the matching capture helper and desktop dependencies; headless systems remain terminal-only. Fleet is disabled unless explicitly enabled. This library is not compatible with legacy ARMv5 xSpan.

Backend HTTPS and signaling WSS origins, DNS, correct time and outbound ICE/TURN connectivity are required. relay_only=true requires usable TURN credentials/connectivity. There is no inbound public listener installed by the SDK.

Run the C test application#

{
  "config": {
    "api_key": "sz_test_public",
    "device_name": "Store Linux",
    "mode": "terminal"
  },
  "state_dir": "/home/operator/.local/state/streamzet-sdk-test",
  "fleet": false
}

chmod 600 config.json
./embedded-example config.json

The C example prints initial status and changes detected every 500 ms, then stops on Enter or stdin closure. running=true does not mean enrolled or connected. Pair in the dashboard after device_code appears.

Embed in Go#

support, err := sdk.Start(ctx, sdk.Options{
    Config: sdk.Config{
        APIKey: "sz_test_public",
        DeviceName: "Store Linux", Mode: "terminal",
    },
    StateDir: "/home/operator/.local/state/streamzet-sdk",
    Fleet: false,
})
if err != nil { return err }
// The host decides when support is enabled and when to stop.
// Poll support.Identity() for public registration information.
// Later, from a worker during host shutdown:
support.Stop()
return support.Wait()

Import github.com/plitsoft/streamzet/linux-agent/sdk. Use a local module replace to the delivered source until a tagged module release exists. Start enables support availability; it does not show a local consent dialog. The product must expose its own support policy and controls.

Build and lifetime#

make sdk
# Outputs: dist/sdk/native/libstreamzet.so, libstreamzet.h, embedded-example

Build on the target Linux ABI with Go 1.26 and a C compiler. Use the generated header; keep libstreamzet.so beside the example. Do not dlclose the Go library during the host lifetime. Start once per process; stop and wait before host shutdown. Preserve state across updates and never share it with the standalone agent. Embedded mode does not run the standalone updater or replace the host executable.