kazana-config

kazana-config

Kazana core module for configuration

Usage

Kazana is configured using .kazanarc files, using the rc package.

module.exports = {
  name: 'myapp',
  version: '1.0.0'
}

When loaded as plugin, it's looking for a [plugin.<name>] section within the .kazanarc files. Additionally, default configuration can be passed:

module.exports = {
  name: 'myapp',
  version: '1.0.0',
  config: {
    admin: {
      user: 'myadmin',
      password: 'secret'
    }
  }
}

Configuration can be also passed ase environment varibales

kazana_admin__password = 'supersecret' npm start

or as command line arguments

npm start -- --admin.password='supersecret'

See https://www.npmjs.com/package/rc#standards for the full list and order of configuration sources.

Within services, the settings are available as server.settings.app.<setting path>, for example server.settings.app.admin.password

Setting Path	Default / Example
port	5000
log.level	warn
admin.username Database admin username	kazana
admin.password Database admin password	secret
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-
backend.port	4999
backend.location Location option as it gets passed to levelup https://github.com/Level/levelup#leveluplocation-options-callback If backend.name="couchdb", set the couchdb url without credententials, e.g. "https://my.couch.com"	./.db
backend.log.file Does not apply if backend.name="couchdb"	./.db/pouch.log
backend.log.level Does not apply if backend.name="couchdb"	info
backend.config.file Does not apply if backend.name="couchdb"	./.db/config.json
backend.timeout Time to connect database in milliseconds	30000
db.rawData Name of database containing submitted raw data	kazana-raw-data
db.integratedData Name of database containing integrated data	kazana-raw-data
db.options Database ajax options, as passed to the PouchDB constructor.	{ timeout: 10000 }
email.service Nodemailer Email Service	gmail
email.auth.username Nodemailer Email Service Username	e.g. [e-mail]
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