NOTE: master branch is preserved for legacy use. All new development, and any code published to npm, should be done under the
A common configuration module for use within the SymphonyCare API and UI node projects.
SymphonyCare-config is a lightweight wrapper on top of the https://github.com/flatiron/nconf module, which abstracts access to various configuration stores. Configuration data may come from files, machine environment variables, or the node command line.
- require the module
var config = require('SymphonyCare-config');
- get a config value
var foo = config.get('foo');
// nested property access
var bar = config.get('foo.bar');
SymphonyCare-config supports 3 types of configuration storage:
- files - JSON or JS files, located in the root config directory
- ENV variables - machine environment variables
- CMD params - command line parameters, passed to node
Config files must be placed in the root config directory. Files should match for format *.config.js or *.config.json in order to be included. Additionally, files matching *.config.local.js or *.config.local.json are also parsed. Local files take precedence over non-local files. Normally a repo should ignore config/*.local.*, allowing developers to override properties as needed, without committing those changes to the repository.
Machine environment variables are included in the available configuration data. This is the same set of data normally provided by node under process.env. Note that environment variables take the lowest priority.
command line parameters
Config data may also be set directly from the command line, when starting node. To set a parameter value, prefix it with two dashes, and place an equals sign between the value. For example: --value='hello world' Note that command line parameters take the highest priority.