Skip to main content

Environment variables

Never paste a real secret, key, token or password into this site. Use https://media.example.com rather than a private hostname.

Feature switches​

Two variables decide whether the remote vehicle and media features are served. Their names retain LTE, but the vehicle may use any supported Internet connection. Both default to off: unset means off, and only the literal true means on.

VariableWhat it turns on
NEXT_PUBLIC_DRONE_CONTROL_LTE_ENABLEDThe /drone-control page, its sidebar entry, and the APIs that talk to a vehicle over its LTE link
NEXT_PUBLIC_DRONE_VIDEO_MEDIAMTX_ENABLEDVideo through MediaMTX: the stream APIs, the detached stream window, and the managed RTSP endpoints

They default to off in an unspecified build. Production and the public test VM set both to true in their reviewed build workflows. While a feature is off, its page answers 404 and its API answers 503 naming the variable, so a caller can tell "switched off" from "moved or removed".

They are separate switches so video and remote-control availability can be configured independently.

A third switch, server-side and unrelated to those two, decides whether the direct bench transports may run:

VariableWhat it turns on
DRONE_CONTROL_LOCAL_TRANSPORT_ENABLEDConnecting to a vehicle over plain UDP or TCP from the server process

That path opens sockets with node:dgram and node:net in the Node process. It is an opt-in bench transport; Oracle hosting does not enable it automatically. With it off, /api/drone-control/connect answers 503 naming the variable.

:::caution Both are build-time values NEXT_PUBLIC_* variables are inlined when the app is built. Changing either switch therefore takes effect on the next deployment, not when the variable is saved. :::

One route is deliberately left on: /api/drone-control/connections, which reads and writes a vehicle's stored connection settings. It is configuration rather than a live link. No screen writes to it any more: enrolment and camera configuration happen from the drone's Setup and Streams tabs respectively.

Identity​

VariableLayer
OIDC_ISSUERserver, canonical HTTPS origin of the Suite provider, also used by the Suite's own OIDC client; falls back to NEXT_PUBLIC_SITE_URL
SUITE_OIDC_CLIENT_ID, SUITE_OIDC_CLIENT_SECRETserver, credentials the Suite signs in with through its own provider; the id defaults to suite
AUTH_SESSION_SECRETserver only, 32 bytes base64url, encrypts the session cookie
NEXT_PUBLIC_SITE_URLbrowser, decides where OIDC comes back to

The provider login takes an email address and a password and runs no bot challenge; what does stand behind it is in Provider login defences.

Reaching a vehicle​

VariableLayer
SUITE_GATEWAY_PRIVATE_KEY_PEMserver only, the Ed25519 private key in PKCS#8 PEM that signs gateway tokens
SUITE_GATEWAY_PUBLIC_KEY_PEMserver only, matching public PEM returned to an enrolled Jetson; required to complete its bundle
JETSON_SUITE_ALLOWED_ORIGINSserver only, comma-separated Suite origins returned at enrolment; falls back to NEXT_PUBLIC_SITE_URL
CLOUDFLARE_ACCOUNT_ID, CLOUDFLARE_ZONE_ID, CLOUDFLARE_TUNNEL_API_TOKENserver only, account/zone and credential used to provision vehicle tunnels, DNS, presence, and SSH publication
SUITE_GATEWAY_TOKEN_ISSUER, SUITE_GATEWAY_TOKEN_AUDIENCEserver only, optional overrides of the iss and aud claims
SUITE_GATEWAY_TOKEN_TTL_SECONDSserver only, clamped to between 30 and 300
VEHICLE_SSH_ACCESS_APPserver only, set to exactly ssh-*.sabrobotix.com once the Cloudflare Access application for vehicle SSH exists; until then remote SSH cannot be published (see Remote SSH)

The signer reads the PEM value from the service environment; it does not accept a key-file path or generate a replacement when the value is missing. On Oracle, the protected /etc/suite/suite.env file supplies that value to systemd. A gateway must trust the matching public key before it accepts a token.

VariableLayer
OIDC_KEY_WRAP_SECRETserver only, at least 32 characters, encrypts the private half of every OIDC signing key stored in SQLite

Unlike the gateway key, this one does not sign anything: it is what makes the signing keys in oidc_signing_keys readable. Its custody and OIDC-key rotation are described in OIDC signing keys. Gateway trust and token issuance are described in The remote link; the key pairs are separate.

Data​

The Oracle service uses SUITE_DATABASE_PATH for SQLite. Set R2_ENDPOINT, R2_ACCESS_KEY_ID, R2_SECRET_ACCESS_KEY, R2_BUCKET_MEDIA, R2_BUCKET_MEDIA_PUBLIC and R2_BUCKET_AVATAR for R2 S3 access. Runtime settings are in /etc/suite/suite.env; see Node server settings.

Media and streaming​

VariableLayer
MEDIA_MTX_WEBRTC_BASE_URL, MEDIA_MTX_HLS_BASE_URLMediaMTX playback configuration for local/manual paths; remote vehicle playback is resolved from the gateway response and exposed through Suite proxy URLs
NEXT_PUBLIC_MEDIA_MTX_WEBRTC_BASE_URL, NEXT_PUBLIC_MEDIA_MTX_HLS_BASE_URLLegacy public aliases accepted by the playback resolver, taking precedence over the corresponding server values; do not put credentials or private origins in public build variables
MEDIA_MTX_API_BASE_URLserver, MediaMTX control API
MEDIA_MTX_API_USERNAME, MEDIA_MTX_API_PASSWORD, MEDIA_MTX_API_TOKENserver, optional control-API auth
MEDIA_MTX_RTSP_PUBLISH_BASE_URL, MEDIA_MTX_RTSP_TRANSPORTserver
DRONE_VIDEO_STREAM_KINDS, DRONE_VIDEO_STREAM_LABELS, DRONE_VIDEO_PATH_TEMPLATEserver, camera slots and path naming

MEDIA_TRANSCODER_* and MEDIA_RTSP_CODEC_DETECTION_MODE configure a local ffmpeg. Encoding remains on the aircraft; keep server transcoding disabled unless it is explicitly provisioned on the VM.

VariableLayer
DRONE_LTE_TELEMETRY_URL_TEMPLATEserver, optional template for gateway telemetry endpoints

SIM​

STELLAR_API_URL, STELLAR_API_LOGIN, STELLAR_API_PASSWORD and the STELLAR_SIM_* identifiers are server-only and back the SIM usage panel.

Per-vehicle provider fields are edited through Configure SIM usage. The stored SIM password is not returned to the browser; a blank password draft keeps the existing value, and removal is explicit. These fields do not configure the Jetson modem's APN.

Software and release proxy​

VariableLayer
HARLOCK_GITHUB_UPDATE_TOKENserver only, credential used to read authorized private release assets; required for the software/update proxy
HARLOCK_GITHUB_REPOserver only, optional repository override; defaults to SAB-GROUP-SRL/harlock

The same proxy supports the permitted Jetson runtime/model release repositories and validates requested repositories and assets. Do not expose the token through a NEXT_PUBLIC_* variable or a downloadable installer. Download eligibility is described in Download Harlock; application sign-in, licence validation, and download eligibility are separate checks.

Documentation site​

DOCS_SITE_URL and DOCS_BASE_URL are read by docs-site/docusaurus.config.ts. Defaults are https://docs.sabrobotix.com and /suite/; a Suite deployment owns that prefix only and must leave /harlock/ unchanged.