Skip to content

Beacon Telemetry

SuperPlane includes a lightweight beacon that sends a periodic ping to help the team understand installation volume and deployment types.

The beacon sends a JSON payload with:

  • installation_type: The installation type (for example demo, single-host, or kubernetes).
  • installation_id: A randomly generated UUID stored in the SuperPlane database

No user data, workflow payloads, or secrets are included. The data is anonymized.

You can disable the beacon by setting SUPERPLANE_BEACON_ENABLED=no and restarting SuperPlane.

Set the environment variable when starting the container:

Terminal window
docker run --rm -p 3000:3000 -v spdata:/app/data \
-e SUPERPLANE_BEACON_ENABLED=no \
-ti ghcr.io/superplanehq/superplane-demo:stable

If you already have a data volume, you can also edit /app/data/superplane.env in that volume and restart the container.

Edit superplane.env in the installation directory and set:

Terminal window
SUPERPLANE_BEACON_ENABLED=no

Then restart the stack:

Terminal window
docker compose up -d

Set the Helm value and upgrade:

installation:
beaconEnabled: false

Or with --set:

Terminal window
helm upgrade superplane ./superplane-helm-chart \
--set installation.beaconEnabled=false