Corredor server configuration

You can place all configurations into a single .env file.

Corteza Corredor server is configured via the environment (.env) file. It allows a quick deploy to another platform, along with fine-tuning the behaviour and enabled features.

The .env file is at the root of the application. In the context of Docker Compose, it is next to the docker-compose.yaml file.

You can use variables defined in the .env inside your docker-compose.yaml file; for example ${VERSION}.

Base configuration

These variables control the base Corredor server configurations, such as extension search paths, and certificate locations.

Type Default value Description

CORREDOR_ADDR

string

corredor:80

This setting is used by both, Corredor and API Server.

For Corredor server: where is server listening on

For API server: where can Corredor server be accessed.

Used by Corredor and API server.

CORREDOR_ENABLED

bool

false

This is a setting for API server, will Corredor be used for server automation?

Used by Corredor and API server.

CORREDOR_MAX_BACKOFF_DELAY

duration

1m

Connection timeout (from API server to Corredor)

Used by API server.

CORREDOR_EXEC_CSERVERS_API_BASEURL_TEMPLATE

string

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

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.

Used by Corredor server.

CORREDOR_EXEC_CSERVERS_API_HOST

string

Hostname used for template

Used by Corredor server.

CORREDOR_LOG_ENABLED

boolean

corredor

This setting is used by both, Corredor and API Server.

For Corredor service: where is service listening on (gRPC)

For API server: where can Corredor service be accessed.

Used by Corredor and API server.

CORREDOR_LOG_LEVEL

string

info

Defaults to trace when CORREDOR_DEBUG is true, defines amount of log information outputed.

Used by Corredor and API server.

CORREDOR_LOG_PRETTY

boolean

false

Are events logged in one-line JSON or formatted to ease development?

Used by Corredor.

CORREDOR_DEBUG

boolean

false

Corredor will log even more information.

Used by Corredor.

CORREDOR_EXT_DEPENDENCIES_AUTO_UPDATE

boolean

true

Corredor will auto update script dependencies found in package.json files

Used by Corredor.

CORREDOR_EXT_SERVER_SCRIPTS_ENABLED

boolean

true

Server scripts are enabled

Used by Corredor.

CORREDOR_EXT_SERVER_SCRIPTS_WATCH

boolean

true

Corredor will reload server-scripts on change

Used by Corredor.

CORREDOR_EXT_CLIENT_SCRIPTS_ENABLED

boolean

true

Client scripts are enabled

Used by Corredor.

CORREDOR_EXT_CLIENT_SCRIPTS_WATCH

boolean

true

Corredor will reload client-scripts on change

Used by Corredor.