Configuration#
All configuration is via .env (see .env.example). See
Get Started for the deployment walkthrough these variables
support and the Release Notes for what changed per version.
Variable |
Default |
Purpose |
|---|---|---|
|
|
Bind address for this machine’s published port |
|
|
Dashboard port; |
|
|
UAV Companion Compute IP field |
|
|
Camera card order, by a word in the stream name; unlisted cameras follow alphabetically |
|
|
UAV host’s nginx HTTPS port |
|
|
Set |
|
empty (system CAs) |
Used when verification is on: PEM file (under |
|
|
UAV host’s nginx MQTT passthrough port |
|
|
UAV host’s raw RTSP port, pulled by the mediamtx relay |
|
|
Address browsers use to reach this machine; advertised as the WebRTC ICE candidate. Set it when |
|
|
Published WebRTC (WHEP) port and ICE UDP/TCP ports of the relay; |
|
|
Devices passed to |
|
( |
Credentials for the VSS overlay’s MinIO and Postgres — internal to this stack only, edit |
|
|
Registry and tag of the VSS images used by |
|
|
Only for a VSS deployed separately; |
|
|
Host port (bound to |
|
|
Host’s |
|
|
Embedding model VSS uses for frames and queries; edit |
|
|
Object detection model VSS dataprep uses for crop extraction. Must be a Hugging Face OpenVINO™ Model API repository in the |
|
|
Run object-detection crops alongside embedding during ingestion |
|
|
Devices for VSS indexing, object detection, and query embedding. Set all three at once at deploy time with |
|
|
Live ingest embeds one frame every N frames |
|
|
How long indexed live footage/embeddings are kept before being purged |
|
|
Longest a new live feed waits for its first embeddings: a partial batch of frames is embedded once its oldest frame is this many seconds old (VSS’s own default is |
|
|
How often running UAV pipelines are synced to VSS live streams |
|
|
VSS MinIO bucket for uploaded videos |
|
|
Timeout for one search request to VSS |
|
|
Hides hits whose best frame is less similar to the query than this; tuned for CLIP ViT-B/32, retune for other embedding models ( |
|
|
Keeps hits whose peak frame similarity is at least this fraction of the best hit’s of the same UAV ( |
|
|
For a query that names a detectable object (person, car, truck, bus, …): |
|
|
Offers a cached low-bitrate SD preview of each result alongside the full-resolution HD clip; |
|
|
Quality the player starts in ( |
|
|
Preview height in pixels (never upscaled) |
|
|
Preview video bitrate cap |
|
|
Disk budget for cached previews in |
|
|
Top results transcoded as soon as a search returns |
|
|
Maximum scene captions kept per (host, camera) for the Flight Summary report |
|
|
Drop a (host, camera) caption subscriber after this many seconds of not being observed captioning |
|
|
Most results the search popup lists. Also |
|
|
Live streams VSS indexes at once (one per UAV camera); feeds beyond it show as |
The remote-port defaults assume the standard nginx-published ports from
uav-vision-analytics/docker-compose-pymavlink.yml; only change them if that
stack’s nginx is configured differently.
Backend Routes#
uav-gs-backend proxies everything so the browser only talks to this dashboard.
VSS Search#
Route |
Upstream VSS call |
Purpose |
|---|---|---|
|
|
Reachability + search feature flag (popup status pill) |
|
|
Ranked hits, joined with filenames / live stream names |
|
|
Range-aware clip streaming (seekable |
|
|
Best-matching frame (thumbnail / fallback) |
|
(local registry) |
UAV hosts and cameras currently live-indexed, for the search popup’s UAV / Camera filters |
|
|
Show / start ( |
Quick check:
curl -s http://${VIZ_HOST_IP:-127.0.0.1}:${VIZ_PORT:-8080}/api/search/status
curl -s -X POST http://${VIZ_HOST_IP:-127.0.0.1}:${VIZ_PORT:-8080}/api/search \
-H 'Content-Type: application/json' -d '{"query": "a car on the road"}'
Flight Summary#
Route |
Purpose |
|---|---|
|
JSON report, rendered inline in the modal |
|
Same report as a downloadable PDF |
Other Routes#
Route |
Purpose |
|---|---|
|
Default host, remote HTTPS port, and the relay’s WebRTC host/port for the browser |
|
Cameras and pipelines running on the UAV host |
|
Scene captions as SSE |
|
UAV host and ground-station utilization as SSE |
|
Configure and check the mediamtx path |
|
Connected UAV hosts, kept server-side so a page reload restores the tabs; a backend restart (new |
Notes#
The UAV host’s TLS certificate is self-signed; the backend skips verification when calling it (trusted-LAN tool posture, consistent with the
-k/--insecurecurl examples inuav-vision-analytics’s own README).This project makes outbound, read-only requests to whatever host you enter; it never starts/stops pipelines on the remote stack.