Environment variables
This page lists the environment variables the worker SDK and the platform skeleton read at startup. They are the contract between your worker and the surrounding instance.
| Variable | Required | Default | Purpose |
|---|
ORCHESTY_API_HOST | yes | – | Base URL of the platform's worker API. The worker uses it to register and report. |
ORCHESTY_API_KEY | yes | – | Pre-shared API key used by this worker. |
WORKER_HOST | yes | – | URL the platform uses to call back into this worker (its public address). |
WORKER_PORT | yes | 8080 | Port the worker HTTP server listens on. |
| Variable | Required | Default | Purpose |
|---|
WORKER_NAME | recommended | container hostname | Human-readable worker name shown in the Admin UI. |
TENANT_ID | optional | – | Multi-tenant deployments only (e.g. running Orchesty under Applinth). When set, the worker only accepts work routed for the given identifier. Leave unset for standalone Orchesty. |
| Variable | Required | Default | Purpose |
|---|
MONGO_DSN | PHP only (Node uses platform storage by default) | – | MongoDB connection string used to persist ApplicationInstall. |
MONGO_DB_NAME | PHP only | orchesty | MongoDB database name. |
| Variable | Required | Default | Purpose |
|---|
ORCHESTY_ENCRYPTION_KEY | yes when storing credentials | – | Symmetric key used to encrypt addSettings() values. Must be stable across worker restarts. |
| Variable | Required | Default | Purpose |
|---|
LOG_LEVEL | optional | info | One of debug, info, warn, error. |
LOG_FORMAT | optional | json | json for log shippers, text for development. |
The full-stack skeleton ships with a .env.dist template. make init-dev renders it into a working .env (your UID/GID, a random ORCHESTY_API_KEY, default DEV_IP, default ports) on the first run. The variables above are the same; only the values change between environments.