FerryDocs

Environment variables

Ferry sets, generates, links or copies each variable of the blueprint. The form of the entry decides.

Edit on GitHub
render.yaml
envVars:
  - key: DATABASE_URL
    fromDatabase: { name: app-db, property: connectionString }   # ${{datastore.app-db.connectionString}}
  - key: API_HOST
    fromService: { type: pserv, name: api, property: hostport }  # ${{service.api.hostport}}

A fromDatabase or fromService entry becomes a . Ferry replaces the reference with the real value when the service starts.

Each form

FormOn Ferry
{key, value}Ferry sets it. The value stays as you wrote it: 3.10 stays 3.10.
{key, generateValue: true}A random value of 64 hex characters.
{key, sync: false}Ferry does not set it. A warning gives the ferry env set command to run.
{key, fromDatabase: {name, property}}A reference ${{datastore.NAME.PROPERTY}}.
{key, fromService: {type, name, property}}A reference to the service, or to the for type: redis / keyvalue.
{key, fromService: {name, envVarKey}}Ferry copies the variable of the other service when you apply the file.
{fromGroup: NAME}Ferry links the to the service (services only).
previewValueFerry ignores it, with a warning.

Properties

ForProperties
fromDatabase and key value storesconnectionString, host, port, hostport, user, password, database
Serviceshost, port, hostport, url, internalUrl

On this page