FerryDocs
ReferenceBlueprint spec

Source keys

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

Edit on GitHub
ferry.yaml
services:
  - type: web
    name: api
    runtime: node
    repo: https://github.com/render-examples/express-hello-world   # a repository
    branch: main
  - type: web
    name: hello
    image:
      url: nginx:alpine                                            # or an image

These keys give the of a service and its . Set repo or image, not the two.

The keys

KeyTypeDefaultNotes
runtimestringsee notesdocker, image, node, python, go, rust, ruby or static. Other accepted names: nodejs, javascript, bun, python3, golang.
repostringnoneA git : https://, ssh://, git://, file://, git@host:path, or an absolute path on the server. It becomes repo_url.
branchstringmainThe that Ferry builds, and that follows.
imagestring or mappingnoneAn that exists already: image: nginx:alpine or image: { url: nginx:alpine }.

The default of runtime

EntryDefault runtime
image has a valueimage
A static sitestatic
Other entriesFerry finds it from your files

Ferry also accepts the old key env for runtime.

Service entries

Each entry of services needs a type and a name. The other keys are optional.

Build keys

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

On this page

The keysThe default of runtime