Environment Setup and Agent Install
This page covers first-time environment setup for cloud-edge execution.
Step 1: Create Environment Record
In project environments UI, create an environment with:
- clear name (location + purpose)
- environment type (
edge/on-premwhere applicable) - connection notes for operations
Do not reuse one environment entry across multiple physical devices.
Step 2: Capture Environment ID
After creation, copy the generated environment ID.
This ID binds the runtime agent to the correct project target.
Step 3: Install Agent Container
Run the environment agent in Docker with restart policy enabled.
Typical command pattern:
docker run -d \
--name solutionengine_agent \
--privileged --pid=host --restart unless-stopped --pull always \
-v /var/run/docker.sock:/var/run/docker.sock \
-v solutionengine_agent_data:/app/agents \
-e EDGE_AUTO_INSTALL_DEPS=true \
-e ENV_ID=<environment_id> \
-e CLOUD_API_URL=<platform_api_url> \
-e DEPLOYMENT_KEY=<environment_deployment_key> \
solutionengine/solutionengine_agent:latest
Required Runtime Settings
| Variable | Required | Purpose |
|---|---|---|
ENV_ID | Yes | Binds agent to target environment |
CLOUD_API_URL | Yes | Platform API endpoint |
DEPLOYMENT_KEY | Yes | Auth header key used by the agent (X-Deployment-Key) |
EDGE_AGENT_IMAGE | Optional | Override agent image (used by self-update flow) |
Validation Checklist
- Container is running (
docker ps) - First heartbeat appears in environment status
- Environment status changes to online
- Assigned workflows synchronize successfully
Common Setup Failures
- Wrong environment ID
- Invalid token/scope
- API endpoint unreachable from target network
- Container restarted repeatedly due to missing env vars
