[doc] Updated usage.js and README.md for the next hierarchical syntax.

This commit is contained in:
indexzero 2011-09-18 21:34:45 -04:00
parent da2da7aea8
commit a0638805ce
4 changed files with 107 additions and 10 deletions

101
README.md
View file

@ -1,6 +1,6 @@
# nconf # nconf
A hybrid local / remote configuration storage library for node.js. A hierarchical node.js configuration management library with support for files, environment variables, command-line arguments, and atomic object merging.
## Installation ## Installation
@ -14,7 +14,7 @@ A hybrid local / remote configuration storage library for node.js.
[sudo] npm install nconf [sudo] npm install nconf
``` ```
## Usage ## Getting started
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: 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:
``` js ``` js
@ -24,14 +24,15 @@ Using nconf is easy; it is designed to be a simple key-value store with support
// //
// Setup nconf to use the 'file' store and set a couple of values; // Setup nconf to use the 'file' store and set a couple of values;
// //
nconf.use('file', { file: 'path/to/your/config.json' }); nconf.add('file', { file: 'path/to/your/config.json' });
nconf.set('database:host', '127.0.0.1'); nconf.set('database:host', '127.0.0.1');
nconf.set('database:port', 5984); nconf.set('database:port', 5984);
// //
// Get the entire database object from nconf // Get the entire database object from nconf. This will output
// { host: '127.0.0.1', port: 5984 }
// //
var database = nconf.get('database'); console.dir(nconf.get('database'));
// //
// Save the configuration object to disk // Save the configuration object to disk
@ -43,6 +44,71 @@ Using nconf is easy; it is designed to be a simple key-value store with support
}); });
``` ```
## Hierarchical configuration
Configuration management can get complicated very quickly for even trivial applications running in production. `nconf` addresses this problem by enabling you to setup a hierarchy for different sources of configuration with some sane defaults (in-order):
1. Manually set overrides
2. Command-line arguments
3. Environment variables
4. Any additional user stores (in the order they were added)
The top-level of `nconf` is an instance of the `nconf.Provider` abstracts this all for you into a simple API.
### nconf.add(name, options)
Adds a new store with the specified `name` and `options`. If `options.type` is not set, then `name` will be used instead:
``` js
nconf.add('global', { type: 'file', filename: '/path/to/globalconf.json' });
nconf.add('userconf', { type: 'file', filename: '/path/to/userconf.json' });
```
### nconf.use(name, options)
Similar to `nconf.add`, except that it can replace an existing store if new options are provided
``` js
//
// Load a file store onto nconf with the specified settings
//
nconf.use('file', { filename: '/path/to/some/config-file.json' });
//
// Replace the file store with new settings
//
nconf.use('file', { filename: 'path/to/a-new/config-file.json' });
```
### nconf.remove(name)
Removes the store with the specified `name.` The configuration stored at that level will no longer be used for lookup(s).
``` js
nconf.remove('file');
```
## Working with Configuration
`nconf` will traverse the set of stores that you have setup in-order to ensure that the value in the store of the highest priority is used. For example to setup following sample configuration:
1. Command-line arguments
2. Environment variables
3. User configuration
3. Global configuration
``` js
var nconf = require('nconf');
//
// Read in command-line arugments and environment variables
//
nconf.argv = nconf.env = true;
//
// Setup the `user` store followed by the `global` store. Note that
// order is significant in these operations.
//
nconf.add('user', { file: 'path/to/user-config.json' });
nconf.add('global', { file: 'path/to/global-config.json' })
```
## Storage Engines ## Storage Engines
### Memory ### Memory
@ -52,6 +118,27 @@ A simple in-memory storage engine that stores a nested JSON representation of th
nconf.use('memory'); nconf.use('memory');
``` ```
### System
Based on the Memory store, but exposes hooks into manual overrides, command-line arguments, and environment variables (in that order of priority). Every instance of `nconf.Provider`, including the top-level `nconf` object itself already has a `System` store at the top-level, so configuring it only requires setting properties
``` js
//
// `nconf.get(awesome)` will always return true regardless of
// command-line arguments or environment variables.
//
nconf.overrides = { awesome: true };
//
// Can also be an object literal to pass to `optimist`.
//
nconf.argv = true;
//
// Can also be an array of variable names to restrict loading to.
//
nconf.env = true;
```
### File ### File
Based on the Memory store, 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. Based on the Memory store, 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.
@ -93,8 +180,8 @@ There is more documentation available through docco. I haven't gotten around to
## Run Tests ## Run Tests
Tests are written in vows and give complete coverage of all APIs and storage engines. Tests are written in vows and give complete coverage of all APIs and storage engines.
``` ``` bash
vows test/*-test.js --spec $ npm test
``` ```
#### Author: [Charlie Robbins](http://nodejitsu.com) #### Author: [Charlie Robbins](http://nodejitsu.com)

View file

@ -2,18 +2,28 @@ var fs = require('fs'),
path = require('path'), path = require('path'),
nconf = require('./lib/nconf'); nconf = require('./lib/nconf');
//
// Configure the provider with a single store and
// support for command-line arguments and environment
// variables.
//
var single = new nconf.Provider({ var single = new nconf.Provider({
useEnv: true, env: true,
useArgv: true, argv: true,
store: { store: {
type: 'file', type: 'file',
file: path.join(__dirname, 'config.json') file: path.join(__dirname, 'config.json')
} }
}); });
//
// Configure the provider with multiple hierarchical stores
// representing `user` and `global` configuration values.
//
var multiple = new nconf.Provider({ var multiple = new nconf.Provider({
stores: [ stores: [
{ type: 'file', } { name: 'user', type: 'file', file: path.join(__dirname, 'user-config.json') },
{ name: 'global', type: 'global', file: path.join(__dirname, 'global-config.json') }
] ]
}); });