Skip to content

API Config

This holds the port the API will be exposed on alongside basic authentication details.

Fields

host - optional defaults to localhost

The host the API will try to start up from, you may need to override it if you want to expose the api to a wider network

rrelayer.yaml
name: first-rrelayer
description: 'my first rrelayer'
api_config:
  host: "0.0.0.0"

port

The port the API will try to start up from

rrelayer.yaml
name: first-rrelayer
description: 'my first rrelayer'
api_config:
  port: 3000

authentication_username

The basic authentication username

rrelayer.yaml
name: first-rrelayer
description: "my first rrelayer"
api_config:
  port: 3000
  authentication_username: "${RRELAYER_AUTH_USERNAME}"

authentication_password

The basic authentication password

rrelayer.yaml
name: first-rrelayer
description: "my first rrelayer"
api_config:
  port: 3000
  authentication_username: "${RRELAYER_AUTH_USERNAME}"
  authentication_password: "${RRELAYER_AUTH_PASSWORD}"