kazana-config

kazana-config

Kazana core module for environment based configuration

Usage

// npm install --save git+ssh://[e-mail]:eHealthAfrica/kazana-config.git
var config = require('kazana-config')

Parse 12factor-config compatible configurations

var config = require('kazana-config').parse({
  funk: {
    env: 'KAZANA_FUNK',
    default: 'boogie woogie'
  }
})

// config.funk set to `KAZANA_FUNK`, falls back to 'boogie woogie'

Settings / Defaults

Kazana can be fully configured using environment variables. Below is a list of all variables used across the services, including their default values where applicable.

Within services, the settings below are accessible at server.settings.app.<setting name>, e.g. sever.settings.app.dbRawData.

Name / Env	Description	Default / Example
kazanaAppPort KAZANA_APP_PORT	5000
backendPort KAZANA_BACKEND_PORT	4999
adminUser KAZANA_ADMIN_USER	CouchDB admin username	kazana
adminPass KAZANA_ADMIN_PASS	CouchDB admin password	secret
backendName KAZANA_BACKEND_NAME	When undefined, defaults to pouchdb-server's built-in "leveldown". Can be set to "couchdb" or any levelup storage back-ends: https://github.com/Level/levelup/wiki/Modules#storage-back-ends	-no default-
backendLocation KAZANA_BACKEND_LOCATION	Location option as it gets passed to levelup https://github.com/Level/levelup#leveluplocation-options-callback If KAZANA_BACKEND_NAME="couchdb", set the couchdb url without credententials, e.g. "https://my.couch.com"	./.db
backendLogFile KAZANA_BACKEND_LOG_FILE	Does not apply if KAZANA_BACKEND_NAME="couchdb"	./.db/pouch.log
backendLogLevel KAZANA_BACKEND_LOG_LEVEL	Does not apply if KAZANA_BACKEND_NAME="couchdb"	info
backendConfigFile KAZANA_BACKEND_CONFIG_FILE	Does not apply if KAZANA_BACKEND_NAME="couchdb"	./.db/config.json
dbRawData KAZANA_DB_RAW_DATA	Name of database containing submitted raw data	kazana-raw-data
dbIntegratedData KAZANA_DB_INTEGRATED_DATA	Name of database containing integrated data	kazana-raw-data
emailService KAZANA_EMAIL_SERVICE	Nodemailer Email Service	gmail
emailAuthUsername KAZANA_EMAIL_AUTH_USERNAME	Nodemailer Email Service Username	e.g. [e-mail]
emailAuthPassword KAZANA_EMAIL_AUTH_PASSWORD	Nodemailer Email Service Password	e.g. secret

Local setup and Testing

git clone [e-mail]:eHealthAfrica/kazana-config.git
cd kazana-config
npm install
npm test

Test

npm test

Credit

Brought to you by eHealth Africa — good tech for hard places.

License

Apache-2.0