Environment Config

# Environment Config Reference The `EnvironmentConfig` object is used to configure services, volumes, and shared variables in Railway. ## Structure ```json { "services": { "": { "source": { ... }, "build": { ... }, "deploy": { ... }, "variables": { ... }, "networking": { ... } } }, "sharedVariables": { ... }, "volumes": { ... }, "buckets": { ... } } ``` Only include fields being changed. The patch is merged with existing config. ## Service Config ### Source | Field | Type | Description | |-------|------|-------------| | `image` | string | Docker image (e.g., `nginx:latest`) | | `repo` | string | Git repository URL | | `branch` | string | Git branch to deploy | | `commitSha` | string | Specific commit SHA | | `rootDirectory` | string | Root directory (monorepos) | | `checkSuites` | boolean | Wait for GitHub check suites | | `autoUpdates.type` | disabled | patch | minor | Auto-update policy for Docker images | ### Build | Field | Type | Description | |-------|------|-------------| | `builder` | NIXPACKS | DOCKERFILE | RAILPACK | Build system | | `buildCommand` | string | Command for Nixpacks builds | | `dockerfilePath` | string | Path to Dockerfile | | `watchPatterns` | string[] | Patterns to trigger deploys | | `nixpacksConfigPath` | string | Path to nixpacks config | ### Deploy | Field | Type | Description | |-------|------|-------------| | `startCommand` | string | Container start command | | `multiRegionConfig` | object | Region → replica config. See [Multi-Region Config](#multi-region-config). | | `healthcheckPath` | string | Health check endpoint | | `healthcheckTimeout` | number | Seconds to wait for health | | `restartPolicyType` | ON_FAILURE | ALWAYS | NEVER | Restart behavior | | `restartPolicyMaxRetries` | number | Max restart attempts | | `cronSchedule` | string | Cron schedule for cron jobs | | `sleepApplication` | boolean | Sleep when inactive | ### Variables | Field | Type | Description | |-------|------|-------------| | `value` | string | Variable value | | `isOptional` | boolean | Allow empty value | Set to `null` to delete a variable. For variable references, see [variables.md](variables.md). ### Lifecycle | Field | Type | Description | |-------|------|-------------| | `isDeleted` | boolean | Mark for deletion (requires ADMIN) | | `isCreated` | boolean | Mark as newly created | ## Multi-Region Config Controls replica count per region. Structure: region name → `{ numReplicas }` or `null` to remove. ```json { "multiRegionConfig": { "us-west2": { "numReplicas": 3 }, "europe-west4-drams3a": { "numReplicas": 2 } } } ``` ### Available Regions | Name | Location | Aliases | |------|----------|---------| | `us-west2` | US West (California) | "us west", "california" | | `us-east4-eqdc4a` | US East (Virginia) | "us east", "virginia" | | `europe-west4-drams3a` | EU West (Amsterdam) | "europe", "eu", "amsterdam" | | `asia-southeast1-eqsg3a` | Southeast Asia (Singapore) | "asia", "singapore" | ### Interpreting User Requests - "add 3 replicas to europe" → `{ "europe-west4-drams3a": { "numReplicas": 3 } }` - "add a replica to all regions" → set `numReplicas: 1` for all 4 regions - "remove from asia" → `{ "asia-southeast1-eqsg3a": null }` - "increase replicas to 5" (no region specified) → query current config first, update existing region(s) **Important:** When user doesn't specify a region, query the current `multiRegionConfig` and modify the existing region(s). Don't assume a default region. ## Common Operations ### Set Build Command ```json { "services": { "": { "build": { "buildCommand": "npm run build" } } } } ``` ### Set Start Command ```json { "services": { "": { "deploy": { "startCommand": "node server.js" } } } } ``` ### Set Replicas ```json { "services": { "": { "deploy": { "multiRegionConfig": { "us-west2": { "numReplicas": 3 } } } } } } ``` ### Add Variables ```json { "services": { "": { "variables": { "API_KEY": { "value": "xxx" } } } } } ``` ### Delete Variable ```json { "services": { "": { "variables": { "OLD_VAR": null } } } } ``` ### Add Shared Variable ```json { "sharedVariables": { "DATABASE_URL": { "value": "postgres://..." } } } ``` ### Change Docker Image ```json { "services": { "": { "source": { "image": "nginx:latest" } } } } ``` ### Connect GitHub Repo ```json { "services": { "": { "source": { "repo": "owner/repo", "branch": "main" } } } } ``` ### Change Git Branch ```json { "services": { "": { "source": { "branch": "develop" } } } } ``` ### Set Health Check ```json { "services": { "": { "deploy": { "healthcheckPath": "/health", "healthcheckTimeout": 30 } } } } ``` ### Change Builder ```json { "services": { "": { "build": { "builder": "DOCKERFILE", "dockerfilePath": "./Dockerfile" } } } } ``` ### Delete Service ```json { "services": { "": { "isDeleted": true } } } ``` ### Delete Volume ```json { "volumes": { "": { "isDeleted": true } } } ``` ### New Service Instance ```json { "services": { "": { "isCreated": true, "source": { "image": "nginx" } } } } ``` **Note:** `isCreated: true` is required for new service instances.