Skip to content

Generate Settings

Corridor provides an option to generate the default configuration file at any point of time. This is particularly useful when doing a Corridor version upgrade as during upgrades, the existing configuration files are not overwritten. The user can generate the latest configuration file and look at the default values for any new setting which might have been added in that version.

The command is available for the components:

  • corridor-api
  • corridor-app
  • corridor-worker
  • corridor-jupyter

Available options:

$ corridor-api settings generate --help

Usage: corridor-api settings generate [OPTIONS]

  Generates a config file with default configurations.

Options:
  --file PATH                   The location to generate the config file.
  --overwrite / --no-overwrite  Whether to overwrite the config file if
                                already present.

  --help                        Show this message and exit.

The default settings files would be generated in the config folder inside the instance path: INSTALL_DIR/instances/INSTANCE_NAME/config

Example

To generate the configuration file /opt/corridor/api_config_latest.py for corridor-api, run:

corridor-api settings generate --file /opt/corridor/api_config_latest.py