Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
nconf is a hierarchical node.js configuration with support for multiple sources. It allows you to manage configuration settings for your application from various sources such as command-line arguments, environment variables, files, and even custom sources.
Loading Configuration from Command-Line Arguments
This feature allows you to load configuration settings from command-line arguments. The `argv` method parses the command-line arguments and makes them available through the `nconf` object.
const nconf = require('nconf');
nconf.argv();
console.log(nconf.get('someArg'));
Loading Configuration from Environment Variables
This feature allows you to load configuration settings from environment variables. The `env` method reads the environment variables and makes them accessible through the `nconf` object.
const nconf = require('nconf');
nconf.env();
console.log(nconf.get('NODE_ENV'));
Loading Configuration from a File
This feature allows you to load configuration settings from a file. The `file` method reads the specified file and makes its contents available through the `nconf` object.
const nconf = require('nconf');
nconf.file({ file: 'config.json' });
console.log(nconf.get('database:host'));
Setting Default Values
This feature allows you to set default configuration values. The `defaults` method sets the default values that will be used if no other source provides a value for a given key.
const nconf = require('nconf');
nconf.defaults({ 'port': 3000 });
console.log(nconf.get('port'));
Overriding Configuration Values
This feature allows you to override configuration values. The `overrides` method sets values that will take precedence over any other source.
const nconf = require('nconf');
nconf.overrides({ 'port': 8080 });
console.log(nconf.get('port'));
The `config` package provides a way to manage configuration files for your Node.js application. It supports different configurations for different deployment environments and allows for hierarchical configurations. Compared to nconf, `config` is more focused on file-based configurations and environment-specific settings.
The `dotenv` package loads environment variables from a `.env` file into `process.env`. It is simpler and more lightweight compared to nconf, focusing solely on environment variables and not supporting other sources like command-line arguments or JSON files.
The `convict` package provides a way to define a schema for your configuration and validate it. It supports multiple sources like environment variables and JSON files, similar to nconf. However, `convict` adds the ability to define a schema and validate the configuration against it, which nconf does not provide.
A hybrid local / remote configuration storage library for node.js.
curl http://npmjs.org/install.sh | sh
[sudo] npm install nconf
Using nconf is easy; it is designed to be a simple key-value store with support for both local and remote storage. Keys are namespaced and delimited by :
. Lets dive right into sample usage:
var fs = require('fs'),
nconf = require('nconf');
//
// Setup nconf to use the 'file' store and set a couple of values;
//
nconf.use('file', { file: 'path/to/your/config.json' });
nconf.set('database:host', '127.0.0.1');
nconf.set('database:port', 5984);
//
// Get the entire database object from nconf
//
var database = nconf.get('database');
//
// Save the configuration object to disk
//
nconf.save(function (err) {
fs.readFile('path/to/your/config.json', function (err, data) {
console.dir(JSON.parse(data.toString()))
});
});
A simple in-memory storage engine that stores a nested JSON representation of the configuration. To use this engine, just call .use()
with the appropriate arguments. All calls to .get()
, .set()
, .clear()
, .reset()
methods are synchronous since we are only dealing with an in-memory object.
nconf.use('memory');
Based on the Memory engine, but provides additional methods .save()
and .load()
which allow you to read your configuration to and from file. As with the Memory store, all method calls are synchronous with the exception of .save()
and .load()
which take callback functions. It is important to note that setting keys in the File engine will not be persisted to disk until a call to .save()
is made.
nconf.use('file', { file: 'path/to/your/config.json' });
The file store is also extensible for multiple file formats, defaulting to JSON
. To use a custom format, simply pass a format object to the .use()
method. This object must have .parse()
and .stringify()
methods just like the native JSON
object.
The Redis engine will persist all of your configuration settings to a Redis server. All calls to .get()
, .set()
, .clear()
, .reset()
are asynchronous taking an additional callback parameter.
nconf.use('redis', { host: 'localhost', port: 6379, ttl: 60 * 60 * 1000 });
The Redis engine also has an in-memory cache with a default TTL of one hour. To change this, just pass the ttl
option to .use()
.
There is more documentation available through docco. I haven't gotten around to making a gh-pages branch so in the meantime if you clone the repository you can view the docs:
open docs/nconf.html
Tests are written in vows and give complete coverage of all APIs and storage engines.
vows test/*-test.js --spec
FAQs
Hierarchical node.js configuration with files, environment variables, command-line arguments, and atomic object merging.
The npm package nconf receives a total of 603,161 weekly downloads. As such, nconf popularity was classified as popular.
We found that nconf demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.