Zequent Client SDK - Configuration

This page describes the public configuration model for external developers and customer deployments.

Zequent platform services are run from published container images. Customer applications use the Client SDKs and connect to the service endpoints exposed by the deployment.

Container Configuration

The public customer Compose template is docker-compose.customer.yml. It references one deployment-local .env file.

services:
  connector-service:
    image: ghcr.io/zequent/connector-service:latest
    env_file:
      - .env

Use the same env_file: .env pattern for Zequent service images, Admin Console images, adapter images, and customer application containers.

Do not commit .env files. Store credentials and deployment-specific values in your deployment environment or secret manager.

Start the public template with:

docker compose -f docs/docker-compose.customer.yml up -d

Optional adapter images are enabled through Compose profiles, for example:

docker compose -f docs/docker-compose.customer.yml --profile edge-dji up -d

Platform Service Images

Component	Image	Default port
Connector Service	`ghcr.io/zequent/connector-service:latest`	`8010`
Remote Control Service	`ghcr.io/zequent/remote-control-service:latest`	`8002`
Live Data Service	`ghcr.io/zequent/live-data-service:latest`	`8003`
Mission Autonomy Service	`ghcr.io/zequent/mission-autonomy-service:latest`	`8004`
Admin Console API	`ghcr.io/zequent/admin-console-service:latest`	`8005`
Admin Console UI	`ghcr.io/zequent/zqnt-admin-console-dashboard:latest`	`3001`

Use versioned image tags for production deployments.

Adapter Images

Adapter	Image	Status
DJI	`ghcr.io/zequent/edge-dji:latest`	Available
Betaflight	`ghcr.io/zequent/edge-betaflight:latest`	Available
MAVLink	`ghcr.io/zequent/edge-mavlink:latest`	Available
RNS	`ghcr.io/zequent/edge-rns:latest`	Available
Sapient	`ghcr.io/zequent/edge-sapient:latest`	Available
AI Adapter	`ghcr.io/zequent/ai-adapter:latest`	Under development

Client SDK Service Endpoints

Customer applications need the platform service hostnames and ports.

When the customer application runs inside the same Compose or Kubernetes network, use the service names:

Variable	Typical value
`REMOTE_CONTROL_SERVICE_HOST`	`remote-control-service`
`REMOTE_CONTROL_SERVICE_PORT`	`8002`
`LIVE_DATA_SERVICE_HOST`	`live-data-service`
`LIVE_DATA_SERVICE_PORT`	`8003`
`MISSION_AUTONOMY_SERVICE_HOST`	`mission-autonomy-service`
`MISSION_AUTONOMY_SERVICE_PORT`	`8004`
`CONNECTOR_SERVICE_HOST`	`connector-service`
`CONNECTOR_SERVICE_PORT`	`8010`

When the customer application runs on the host and connects to exposed local ports, use localhost for the host values.

Admin Console

The Admin Console has two images:

Component	Image	Default local URL
Admin Console API	`ghcr.io/zequent/admin-console-service:latest`	`http://localhost:8005`
Admin Console UI	`ghcr.io/zequent/zqnt-admin-console-dashboard:latest`	`http://localhost:3001`

The Admin Console UI needs public API and WebSocket URLs that are reachable from the user's browser.

Variable	Purpose
`BACKEND_ORIGIN`	Backend origin used by the UI container inside the deployment network
`NEXT_PUBLIC_BACKEND_AUTH_API_HOST`	Public Admin Console API URL
`NEXT_PUBLIC_BACKEND_OPERATION_API_HOST`	Public operation API URL
`NEXT_PUBLIC_BACKEND_SCHEDULER_API_HOST`	Public scheduler API URL
`NEXT_PUBLIC_BACKEND_ASSET_API_HOST`	Public asset API URL
`NEXT_PUBLIC_BACKEND_ORGANIZATION_API_HOST`	Public organization API URL
`NEXT_PUBLIC_BACKEND_ASSET_WS_HOST`	Public asset WebSocket URL
`NEXT_PUBLIC_BACKEND_DRC_WS_HOST`	Public direct remote control WebSocket URL
`NEXT_PUBLIC_BACKEND_NOTIFICATION_WS_HOST`	Public notification WebSocket URL

For a local Compose deployment, these URLs normally point to localhost:8005.

Edge Adapter Configuration

Ready-made adapter images and custom Edge SDK adapters need a reachable adapter endpoint plus any device-specific credentials.

Variable	Purpose
`EDGE_ADAPTER_TARGET_ENDPOINTS`	Host and port where the platform can reach the adapter
Device/broker credentials	Credentials required by the selected adapter integration
Storage credentials	Optional credentials when the adapter uploads or downloads mission files/media

The exact device-specific values depend on the selected adapter image.

Deployment Notes

Keep one .env per deployment environment.
Do not publish .env files in public documentation or source repositories.
Keep secrets in your orchestrator's secret mechanism for production.
Use service names for container-to-container communication.
Use public hostnames or exposed local ports for browser-facing URLs.
Use the Client SDK for customer applications.
Use the Edge SDK when you need to build a custom adapter.