Environment Variables
This document outlines the available environment variables for configuring Configarr besides the config files. Each variable can be set to customize the behavior of the application.
Available Environment Variables
| Variable Name | Default Value | Required | Description |
|---|---|---|---|
LOG_LEVEL | "info" | No | Sets the logging level. Options are trace, debug, info, warn, error, and fatal. |
CONFIG_LOCATION | "./config/config.yml" | No | Specifies the path to the configuration file. |
SECRETS_LOCATION | "./config/secrets.yml" | No | Specifies the path to the secrets file. |
CUSTOM_REPO_ROOT | "./repos" | No | Defines the root directory for custom repositories. |
ROOT_PATH | Current working directory | No | Sets the root path for the application. Defaults to the current working directory. |
DRY_RUN | "false" | No | When set to "true", runs the application in dry run mode without making changes. |
LOAD_LOCAL_SAMPLES | "false" | No | If "true", loads local sample data for testing purposes. |
DEBUG_CREATE_FILES | "false" | No | Enables debugging for file creation processes when set to "true". |
Usage
To use these environment variables, set them in your shell or include them in your deployment configuration via docker or kubernetes.
Examples
- For example you change the default path for all configs, repos with the
ROOT_PATHvariables. As default it would store them inside the application directory (in the container this is/app)
References
Check the .env.template file in the repository Github