You are reading the documentation for an outdated Corteza release. 2022.9 is the latest stable Corteza release.

Corredor Server configuration

  • type: string

  • description: Be careful when sharing your environmental variables, CORREDOR_ADDR is used by both, Corredor and API Server.

When used by Corredor server it sets the IP address and port server listens on. It defaults to 0.0.0.0:80 in Docker and localhost:50051 in development mode. This instructs server to listen on all interfaces, all IP addresses on port 80.

It is also used by API server to set where the server can find and connect to Corredor Server. Defaults are defined by context. Building from source and running in development mode, value is localhost:50051, in Docker container it is set to corredor:80.

These context-dependant defaults allow us to have working setup without additional changes.

  • default: 0.0.0.0:80

  • type: bool

  • description: Only used by the API server to enable or disable Corredor server use. Corredor server ignores this config.

  • default: false

  • type: string

  • description: Enables development mode when value of the variable starts with "dev". Otherwise Corredor starts in production mode.

When CORREDOR_ENVIRONMENT is not set, Corredor looks for CORREDOR_ENV and NODE_ENV and uses first one available.

  • default: false

  • type: duration

  • description: Maximum amount of time to wait before retrying the failed connection from API to Corredor server.

  • default: 1m

  • type: string

  • description: Location of the Corteza server API. {host} is replaced with value from env variables (in this order: CORREDOR_EXEC_CSERVERS_API_HOST, DOMAIN, HOSTNAME, HOST), {service} is replaced dynamically inside Corredor with compose, system or messaging.

  • default: https://api.{host}/{service}

  • type: string

  • description: Hostname is used for the template.

  • default: ``

  • type: boolean

  • description: Enable logging in Corredor server.

  • default: corredor

  • type: string

  • description: Default is trace when CORREDOR_ENVIRONMENT is set to dev. Defines amount of information server logs.

  • default: info

  • type: boolean

  • description: When set to true, logs are logged formatted to ease development.

  • default: false

  • type: boolean

  • description: Corredor auto updates script dependencies found in package.json files.

  • default: true

  • type: boolean

  • description: Server scripts are enabled.

  • default: true

  • type: boolean

  • description: Corredor reloads server-scripts on change.

  • default: true

  • type: boolean

  • description: Client scripts are enabled.

  • default: true

  • type: boolean

  • description: Corredor reloads client-scripts on change.

  • default: true

  • type: boolean

  • description: Requires a valid certificate for connecting to Corredor server. Set to false when running in development mode.

Used by Corredor server. * default: true

  • type: string

  • description: Base path for all certificate files

Used by Corredor server. * default: /certs

  • type: string

  • description: Path to certificate authority file

Used by Corredor server. * default: ca.crt

  • type: string

  • description: Path to private key file for Corredor server.

Used by Corredor server. * default: private.key

  • type: string

  • description: Path to certificate file for Corredor server.

Used by Corredor server. * default: public.crt

  • type: boolean

  • description: Establish secure connection to Corredor server. Set to false when running in development mode.

Used by API server. * default: true

  • type: string

  • description: Base path for all certificate files.

Used by API server. * default: /certs/corredor/client

  • type: string

  • description: Path to certificate authority file.

Used by API server. * default: ca.crt

  • type: string

  • description: Path to private key file for Corredor server.

Used by API server. * default: private.key

  • type: string

  • description: Path to certificate file for Corredor server.

Used by API server. * default: public.crt