ConceptsServices
Build and deploy settings
Each service keeps its settings. A change applies at the next deploy.
You change a setting with the CLI, the dashboard or the API.
1 / 2
The number of instances is the exception: it applies immediately. The API route is PATCH /api/v1/services/{id}.
The settings
| Setting | CLI flag | API field | Default |
|---|---|---|---|
| Repository | --repo | repo_url | none |
| Branch | --branch | branch | main |
| Image | --image | image | none |
| Runtime | --runtime | runtime | auto |
| Root directory | --root-dir | root_dir | the repository root |
| Dockerfile path | --dockerfile | dockerfile_path | Dockerfile |
| Build command | --build-cmd | build_command | the default of the runtime |
| Start command | --start-cmd | start_command | the default of the runtime, or the command of the image |
| Publish directory (static sites) | --publish-dir | publish_dir | detected |
| Port | --port | port | detected |
| Health check path | --health | health_check_path | none: a TCP check |
| Instances | --instances | instances | 1 |
| Cron schedule | --schedule | schedule | required for cron jobs |
| Disk mount path | --disk | disk_mount_path | none |
| Memory limit (each instance and job run) | --memory | memory_limit_mb | the limit of the server, 512 MiB by default |
| CPU limit (each instance and job run) | --cpu | cpu_limit | the limit of the server, 1 CPU by default |
| Custom domains | --domain (repeatable) | custom_domains | none |
| Auto-deploy | --no-auto-deploy, --auto-deploy | auto_deploy | on |
Clear a setting
ferry update api --start-cmd "" # clear a text setting
ferry update api --port 0 # Ferry detects the port again
ferry update api --memory default --cpu default # back to the limits of the serverA change of the limits applies at the next deploy or restart. ferry restart is sufficient.
- Runtime, commands, root directory and publish directory: Builds & runtimes.
- Port: The port of your app.
- Health check: Health checks.
- Instances and disks: Disks, scaling & suspend.
- Memory and CPU limits: Resource limits.
- When a change applies: Settings and the live deploy.