Skip to main content
Version: Next

ConfigSources.default()

Home > @backstage/config-loader > ConfigSources > default

Creates the default config source for Backstage.

Signature:

static default(options: ConfigSourcesDefaultOptions): ConfigSource;

Parameters

ParameterTypeDescription
optionsConfigSourcesDefaultOptionsOptions

Returns:

ConfigSource

The default Backstage config source

Remarks

This will read from app-config.yaml and app-config.local.yaml by default, as well as environment variables prefixed with APP_CONFIG_. If --config <path|url> command line arguments are passed, these will override the default configuration file paths. URLs are only supported if the remote option is provided.