histograph/config

Name: config

Owner: Histograph

Description: Histograph configuration

Created: 2015-03-03 10:13:35.0

Updated: 2016-01-11 12:57:11.0

Pushed: 2017-08-16 14:26:24.0

Homepage: http://histograph.io

Size: 46

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

histograph-config

All Histograph components use histograph-config to load their configuration parameters:

config = require('histograph-config');

histograph-config loads the default configuration from histograph.default.yml and merges this with a required user-specified configuration file. You can specify the location of your own configuration file in two ways:

  1. Start the Histograph module with the argument --config path/to/config.yml
  2. Set the HISTOGRAPH_CONFIG environment variable to the path of the configuration file:
rt HISTOGRAPH_CONFIG=/Users/bert/code/histograph/config/histograph.bert.yml

This configuration file should at least specify the following options:


taDir: /Users/bert/data/histograph
min:
name: histograph
password: password

j:
er: neo4j
ssword: password

rt:
rs:
- ../data
- ../../erfgoed-en-locatie/historische-geocoder/data

If you want to use this package in a project with a different schema, you can pass a config dir that contains the following files:

config.schema.json
default.yml
local.yml

All files must be provided and local.yml will override default.yml. The idea is that local.yml is specific to the production or development environment. You can specify the location of this directory in two ways:

  1. Start the project module with the argument --config-dir path/to/config
  2. Set the HISTOGRAPH_CONFIG_DIR environment variable to the path of the configuration file:
rt HISTOGRAPH_CONFIG_DIR=/Users/bert/code/transparantnederland/config

Copyright © 2016 Waag Society.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.