Name	Last Update	Last Commit 30598995 – preparazione progetto per ampliamento History
..
lib	Loading commit data...
node_modules	Loading commit data...
tools	Loading commit data...
.npmignore	Loading commit data...
.travis.yml	Loading commit data...
History.md	Loading commit data...
LICENSE	Loading commit data...
README.md	Loading commit data...
defer.js	Loading commit data...
package.json	Loading commit data...

README.md

Configure your Node.js Applications

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.

$ 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:

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

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

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:

$ export NODE_ENV=production
$ 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

Contributors

lorenwest	markstos	elliotttf	leachiM2k	josx	enyo
rundef	arthanzel	eheikes	diversario	th507	nsabovic
Osterjour	axelhzf	benkroeger	jaylynch	jberrisch	nitzan-shaked
Alaneor	roncli	superoven	ncuillery	keis	abh
bertrandom	laktak	cmcculloh	thetalecrafter	DMajrekar	dsimidzija