Build keys

The build keys tell Ferry where to build, with which Dockerfile and with which commands.

render.yaml

services:
  - type: web
    name: api
    runtime: node
    repo: https://github.com/render-examples/express-hello-world
    buildCommand: npm ci          # runs in the build
    startCommand: node app.js     # starts the app

These keys control the build of a service and the command that starts it.

The keys

Key	Type	Default	Ferry setting and notes
`rootDir`	string	repository root	`root_dir`: the root directory, a relative path in the repository. It is also the build context.
`dockerContext`	string	none	Ferry uses it as `root_dir` when the entry has no `rootDir`.
`dockerfilePath`	string	`Dockerfile`	`dockerfile_path`, relative to the root directory.
`buildCommand`	string	none	`build_command`, for native runtimes.
`startCommand`	string	none	`start_command`.
`dockerCommand`	string	none	The same as `startCommand`.
`staticPublishPath`	string	none	`publish_dir`: the directory that a static site serves.

Source keys

A service gets its code from a git repository or from an image. Set repo or image, not the two.

Run and deploy keys

These keys set the port, the health check, the number of instances, auto-deploy and the schedule.

Build keys

The keysCopy Anchor Link

dockerContext and dockerfilePath

startCommand and dockerCommand

On this page

The keys