Need help with node-config?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

5.4K Stars 446 Forks Other 670 Commits 68 Opened issues


Node.js Application Configuration

Services available


Need anything else?

Contributors list

Configure your Node.js Applications

NPM   Build Status   release notes


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.

$ npm install config
$ mkdir config
$ vi config/default.json
  // Customer module configs
  "Customer": {
    "dbConfig": {
      "host": "localhost",
      "port": 5984,
      "dbName": "customers"
    "credit": {
      "initialLimit": 100,
      // Set low for development
      "initialDays": 1

Edit config overrides for production deployment:

 $ vi config/production.json
  "Customer": {
    "dbConfig": {
      "host": "prod-db-server"
    "credit": {
      "initialDays": 30

Use configs in your code:

const config = require('config');
const dbConfig = config.get('Customer.dbConfig');
db.connect(dbConfig, ...);

if (config.has('optionalFeature.detail')) { const detail = config.get('optionalFeature.detail'); //... }

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

Start your app server:

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

Running in this configuration, the

elements of
will come from the
file, and the
element will come from the
override file.


Further Information

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


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


May be freely distributed under the MIT license.

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.