Configure your Node.js Applications

      release notes

Introduction

Node-config organizes hierarchical configurations for your app deployments.

It lets you define a set of default parameters, and extend them for different deployment environments (development, qa, staging, production, etc.).

Configurations are stored in configuration files within your application, and can be overridden and extended by environment variables, command line parameters, or external sources.

This gives your application a consistent configuration interface shared among a growing list of npm modules also using node-config.

Project Guidelines

• Simple - Get started fast
• Powerful - For multi-node enterprise deployment
• Flexible - Supporting multiple config file formats
• Lightweight - Small file and memory footprint
• Predictable - Well tested foundation for module and app developers

Quick Start

The following examples are in JSON format, but configurations can be in other file formats.

Install in your app directory, and edit the default config file.

1$ npm install config
2$ mkdir config
3$ vi config/default.json

1{
2  // Customer module configs
3  "Customer": {
4    "dbConfig": {
5      "host": "localhost",
6      "port": 5984,
7      "dbName": "customers"
8    },
9    "credit": {
10      "initialLimit": 100,
11      // Set low for development
12      "initialDays": 1
13    }
14  }
15}

Edit config overrides for production deployment:

1 $ vi config/production.json

1{
2  "Customer": {
3    "dbConfig": {
4      "host": "prod-db-server"
5    },
6    "credit": {
7      "initialDays": 30
8    }
9  }
10}

Use configs in your code:

1const config = require('config');
2//...
3const dbConfig = config.get('Customer.dbConfig');
4db.connect(dbConfig, ...);
5
6if (config.has('optionalFeature.detail')) {
7  const detail = config.get('optionalFeature.detail');
8  //...
9}

config.get() will throw an exception for undefined keys to help catch typos and missing values. Use config.has() to test if a configuration value is defined.

Start your app server:

1$ export NODE_ENV=production
2$ node my-app.js

Running in this configuration, the port and dbName elements of dbConfig will come from the default.json file, and the host element will come from the production.json override file.

Articles

• Configuration Files
  • Special features for JavaScript configuration files
• Common Usage
• Environment Variables
• Reserved Words
• Command Line Overrides
• Multiple Node Instances
• Sub-Module Configuration
• Configuring from a DB / External Source
• Securing Production Config Files
• External Configuration Management Tools
• Examining Configuration Sources
• Using Config Utilities
• Upgrading from Config 0.x
• Webpack usage

Further Information

If you still don't see what you are looking for, here are some more resources to check:

• The wiki may have more pages which are not directly linked from here.
• Review questions tagged with node-config on StackExchange. These are monitored by node-config contributors.
• Search the issue tracker. Hundreds of issues have already been discussed and resolved there.

Contributors

lorenwest	markstos	iMoses	elliotttf	jfelege	leachiM2k
josx	enyo	leosuncin	arthanzel	eheikes	th507
Osterjour	cunneen	nsabovic	BadgerBadgerBadgerBadger	simon-scherzinger	leonardovillela
axelhzf	benkroeger	fgheorghe	IvanVergiliev	jpwilliams	jaylynch
jberrisch	kgoerlitz	bertho-zero	NguyenMatthieu	nitzan-shaked	robertrossmann

License

May be freely distributed under the MIT license.

Copyright (c) 2010-2022 Loren West and other contributors