|
| 1 | +--- |
| 2 | +title: "Supervisor" |
| 3 | +description: "Environment variables for the supervisor container." |
| 4 | +sidebarTitle: "Supervisor" |
| 5 | +tag: "v4" |
| 6 | +mode: "wide" |
| 7 | +--- |
| 8 | + |
| 9 | +| Name | Required | Default | Description | |
| 10 | +| :------------------------------------------ | :------- | :---------- | :---------------------------------------------------------- | |
| 11 | +| **Required settings** | | | | |
| 12 | +| `TRIGGER_API_URL` | Yes | — | Trigger.dev API URL. Should point at the webapp. | |
| 13 | +| `TRIGGER_WORKER_TOKEN` | Yes | — | Worker token (can be a file path with file://). | |
| 14 | +| `MANAGED_WORKER_SECRET` | Yes | — | Managed worker secret. Needs to match webapp value. | |
| 15 | +| `OTEL_EXPORTER_OTLP_ENDPOINT` | Yes | — | OTel exporter endpoint. Point at: `<webapp-url>/otel` | |
| 16 | +| **Worker instance** | | | | |
| 17 | +| `TRIGGER_WORKER_INSTANCE_NAME` | No | random UUID | Worker instance name. Set to `spec.nodeName` on k8s. | |
| 18 | +| `TRIGGER_WORKER_HEARTBEAT_INTERVAL_SECONDS` | No | 30 | Worker heartbeat interval (seconds). | |
| 19 | +| **Workload API settings** | | | | |
| 20 | +| `TRIGGER_WORKLOAD_API_ENABLED` | No | true | Enable workload API. Runs use this to perform actions. | |
| 21 | +| `TRIGGER_WORKLOAD_API_PROTOCOL` | No | http | Workload API protocol (http/https). | |
| 22 | +| `TRIGGER_WORKLOAD_API_DOMAIN` | No | — | Workload API domain. Keep empty for auto-detection. | |
| 23 | +| `TRIGGER_WORKLOAD_API_HOST_INTERNAL` | No | 0.0.0.0 | Workload API internal host. | |
| 24 | +| `TRIGGER_WORKLOAD_API_PORT_INTERNAL` | No | 8020 | Workload API internal port. | |
| 25 | +| `TRIGGER_WORKLOAD_API_PORT_EXTERNAL` | No | 8020 | Workload API external port. | |
| 26 | +| **Runner settings** | | | | |
| 27 | +| `RUNNER_HEARTBEAT_INTERVAL_SECONDS` | No | — | Runner heartbeat interval (seconds). | |
| 28 | +| `RUNNER_SNAPSHOT_POLL_INTERVAL_SECONDS` | No | — | Runner snapshot poll interval (seconds). | |
| 29 | +| `RUNNER_ADDITIONAL_ENV_VARS` | No | — | Additional runner env vars (CSV). | |
| 30 | +| `RUNNER_PRETTY_LOGS` | No | false | Pretty logs for runner. | |
| 31 | +| **Dequeue settings** | | | | |
| 32 | +| `TRIGGER_DEQUEUE_ENABLED` | No | true | Enable dequeue to pull runs from the queue. | |
| 33 | +| `TRIGGER_DEQUEUE_INTERVAL_MS` | No | 250 | Dequeue interval (ms). | |
| 34 | +| `TRIGGER_DEQUEUE_IDLE_INTERVAL_MS` | No | 1000 (1s) | Dequeue idle interval (ms). | |
| 35 | +| `TRIGGER_DEQUEUE_MAX_RUN_COUNT` | No | 10 | Max dequeue run count. | |
| 36 | +| `TRIGGER_DEQUEUE_MAX_CONSUMER_COUNT` | No | 1 | Max dequeue consumer count. | |
| 37 | +| **Docker settings** | | | | |
| 38 | +| `DOCKER_API_VERSION` | No | v1.41 | Docker API version. You should probably not touch this. | |
| 39 | +| `DOCKER_STRIP_IMAGE_DIGEST` | No | true | Strip image digest in Docker. Turning off can cause issues. | |
| 40 | +| `DOCKER_ENFORCE_MACHINE_PRESETS` | No | true | Enforce Docker machine cpu and memory limits. | |
| 41 | +| `DOCKER_AUTOREMOVE_EXITED_CONTAINERS` | No | true | Auto-remove exited containers. | |
| 42 | +| `DOCKER_RUNNER_NETWORKS` | No | host | Docker runner networks (CSV). | |
| 43 | +| **Registry auth** | | | | |
| 44 | +| `DOCKER_REGISTRY_URL` | No | — | Docker registry URL, e.g. `docker.io`. | |
| 45 | +| `DOCKER_REGISTRY_USERNAME` | No | — | Docker registry username. | |
| 46 | +| `DOCKER_REGISTRY_PASSWORD` | No | — | Docker registry password. | |
| 47 | +| **Kubernetes settings** | | | | |
| 48 | +| `KUBERNETES_FORCE_ENABLED` | No | false | Force Kubernetes mode. | |
| 49 | +| `KUBERNETES_NAMESPACE` | No | default | The namespace that runs should be in. | |
| 50 | +| `KUBERNETES_WORKER_NODETYPE_LABEL` | No | v4-worker | Nodes for runs need this label, e.g. `nodetype=v4-worker`. | |
| 51 | +| `KUBERNETES_IMAGE_PULL_SECRETS` | No | — | Image pull secrets (CSV). | |
| 52 | +| `KUBERNETES_EPHEMERAL_STORAGE_SIZE_LIMIT` | No | 10Gi | Ephemeral storage size limit. Applies to all runs. | |
| 53 | +| `KUBERNETES_EPHEMERAL_STORAGE_SIZE_REQUEST` | No | 2Gi | Ephemeral storage size request. Applies to all runs. | |
| 54 | +| **Metrics** | | | | |
| 55 | +| `METRICS_ENABLED` | No | true | Enable metrics. | |
| 56 | +| `METRICS_COLLECT_DEFAULTS` | No | true | Collect default metrics. | |
| 57 | +| `METRICS_HOST` | No | 127.0.0.1 | Metrics host. | |
| 58 | +| `METRICS_PORT` | No | 9090 | Metrics port. | |
| 59 | +| **Pod cleaner** | | | | |
| 60 | +| `POD_CLEANER_ENABLED` | No | true | Enable pod cleaner. | |
| 61 | +| `POD_CLEANER_INTERVAL_MS` | No | 10000 (10s) | Pod cleaner interval (ms). Best not to touch this. | |
| 62 | +| `POD_CLEANER_BATCH_SIZE` | No | 500 | Pod cleaner batch size. | |
| 63 | +| **Failed pod handler** | | | | |
| 64 | +| `FAILED_POD_HANDLER_ENABLED` | No | true | Enable failed pod handler. | |
| 65 | +| `FAILED_POD_HANDLER_RECONNECT_INTERVAL_MS` | No | 1000 (1s) | Failed pod handler reconnect interval (ms). | |
| 66 | +| **Debug** | | | | |
| 67 | +| `DEBUG` | No | false | Enable debug logs. | |
| 68 | +| `SEND_RUN_DEBUG_LOGS` | No | false | Send run debug logs to the platform. | |
| 69 | +| **Not used for self-hosting** | | | | |
| 70 | +| `TRIGGER_WARM_START_URL` | No | — | Warm start URL. | |
| 71 | +| `TRIGGER_CHECKPOINT_URL` | No | — | Checkpoint URL. | |
| 72 | +| `TRIGGER_METADATA_URL` | No | — | Metadata URL. | |
| 73 | +| `RESOURCE_MONITOR_ENABLED` | No | false | Enable resource monitor. | |
| 74 | +| `RESOURCE_MONITOR_OVERRIDE_CPU_TOTAL` | No | — | Override CPU total for resource monitor. | |
| 75 | +| `RESOURCE_MONITOR_OVERRIDE_MEMORY_TOTAL_GB` | No | — | Override memory total (GB) for resource monitor. | |
0 commit comments