Deploying Remote Agents
This guide will walk you through setting up a Remote Agent in your environment and configuring a Flow to use it.
Prerequisites
- A server or VM with Docker installed.
- Outbound internet access to
https://api.saddledata.io.
Step 1: Create an Agent in the UI
- Log in to Saddle Data.
- Navigate to "Remote Agents" in the left sidebar.
- Click "Register New Agent".
- Give your agent a name (e.g.,
prod-vpc-worker-1). - Important: Copy the Agent Key provided. You will not be able to see it again.
Step 2: Run the Agent Container
On your infrastructure, run the following Docker command. Replace <YOUR_AGENT_KEY> with the key you copied in Step 1.
docker run -d --name saddle-worker \
--restart always \
-e SADDLEDATA_API_URL=https://api.saddledata.io \
-e SADDLEDATA_AGENT_KEY=<YOUR_AGENT_KEY> \
-e WORKER_MODE=AGENT \
saddledata/worker:latest
If you are using a self-signed certificate for the API (e.g., in a local development environment), you can add -e SADDLEDATA_SKIP_TLS_VERIFY=true. Do not use this in production.
Step 3: Verify Connection
Return to the Remote Agents page in the Saddle Data UI. Within a minute, you should see your new agent's status change to Online (Green).
Step 4: Run a Flow with the Agent
Now that your agent is online, you can direct flows to run on it.
- Create a new Flow or edit an existing one.
- In the Flow Editor, look for the "Execution Plane" dropdown.
- Select "Remote Agent (Self-Hosted)".
- (Optional) In the "Allowed Agents" dropdown, select the specific agent(s) you want to handle this flow. If you leave this empty, any available agent in your organization can pick up the job.
- Save the Flow.
The next time this flow runs (either manually or on a schedule), the job will be queued for your Remote Agent.
Configuration Reference
The Remote Agent is configured entirely via environment variables.
| Variable | Description | Required | Default |
|---|---|---|---|
SADDLEDATA_API_URL | The URL of the Saddle Data API. | Yes | https://api.saddledata.io |
SADDLEDATA_AGENT_KEY | The unique authentication key for this agent. | Yes | - |
WORKER_MODE | Must be set to AGENT for remote execution. | Yes | CLOUD |
SADDLEDATA_SKIP_TLS_VERIFY | Set to true to disable SSL certificate verification (Dev only). | No | false |