README.md

NRT Config

NRT is powered by a number of configuration files

config/env.json

This file sets the global app configuration for the given environment. Currently, the possible environments are 'development', 'test' and 'production'.

Using it in the app

The config is accessible thusly:

Require it

  AppConfig = require('initializers/config')
  AppConfig.get('features').dpsir_filtering

Controllers/Middleware

  req.APP_CONFIG.features.dpsir_filtering

Handlebars views

  {{APP_CONFIG.features.dpsir_filtering}}

Example

{
  "instance_name": "Abu Dhabi", // The name of the instance
  "iso2": "AD", // ISO 2 country code
  "db": {
    "name": "nrt_production" // The name of your database
  }
  "features": { // Toggle features
    "dpsir_filtering": true, // Enable visibility and filtering of DPSIR attributes
    "open_access": false, // If enabled, user is not required to login
    "ldap": true // Enable LDAP authentication
  },
  "server": {
    "name": "abu-dhabi-production", // the server name, used to identify deploy targets
    "use_unix_sockets": true, // listens on a new unix socket at /tmp/abu-dhabi-production.sock
    "port": 3000 // port to listen on, if use_unix_sockets is false or not defined
  },
  "deploy": { // Automatic deployment config
    "tags": ["production", "unix"], // optional tags to identify groups of servers on deployment
    "github": { // Login details for GitHub deployment statuses
      "username": "123abc",
      "password": "x-oauth-token"
    }
  }
}

ldap.json

Configuration for ldap, if that feature is enabled for the instance (see above). See config/ldap.json.example.

seeds/

This directory contains the seed data for NRT, which is loaded into the DB if the DB is empty.

Instance configurations

config/instances/ contains the configuration for the many instances of NRT. When developing or deploying an instance of NRT, copy the relevant configuration from this folder to config/, to setup the app correctly. Long-term, this will probably be moved elsewhere.