config.js

/**
 * Default Configuration.
 * See https://github.com/mozilla/node-convict/blob/master/README.md for details.
 */
var convict = require('convict');

module.exports = function () {

  // Check if we need to auto configure for a fast start.
  var env = process.env.NODE_ENV || 'dev';
  var configFile = process.env.FREIGHT_CONFIG || __dirname + '/' + env + '.json';

  require('./autoconfig')(configFile);

  var conf = convict({
    env: {
      doc: 'The applicaton environment.',
      format: [ 'dev', 'test', 'stage', 'prod', 'production' ],
      default: 'dev',
      env: 'NODE_ENV'
    },
    log: {
      level: {
        default: 'info',
        env: 'LOG_LEVEL'
      }
    },
    ip: {
      doc: 'The IP address to bind.',
      format: 'ipaddress',
      default: '127.0.0.1',
      env: 'IP_ADDRESS'
    },
    port: {
      doc: 'The port to bind.',
      format: 'port',
      default: 8872,
      env: 'PORT'
    },
    limit: {
      doc: 'The bundle transmission size limit, in kb.',
      format: 'nat',
      default: 500
    },
    password: {
      doc: 'The password that is used to create Freight bundles.',
      format: String,
      default: ''
    },
    storage: {
      // TODO: You need to create this directory if it does not exist.
      // This directory is also used as a static file directory for Freight bundles.
      doc: 'Default bundle storage directory. Make sure it is somewhere in the Freight Server directory.',
      format: String,
      default: __dirname + '/../storage'
    },
    tempDir: {
      // TODO: You need to create this directory if it does not exist.
      doc: 'Default directory for temporary files.',
      format: String,
      default: __dirname + '/../temp'
    },
    // Redis config, see https://github.com/learnboost/kue#redis-connection-settings
    redis: {
      port: {
        doc: 'Redis Port',
        format: 'port',
        default: 6379
      },
      host: {
        doc: 'Redis IP address to bind.',
        format: 'ipaddress',
        default: '127.0.0.1'
      },
      auth: {
        doc: 'Redis Password.',
        format: String,
        default: ''
      },
      options: {
        doc: 'Redis Options.',
        format: Object,
        default: {}
      }
    },
    track: {
      delay: {
        doc: 'Repository update check delay in milliseconds',
        format: 'nat',
        default: 60 * 60000
      }
    }
  });

  // load environment dependent configuration
  // TODO: development only for now, change it later.
  conf.loadFile(configFile);
  // perform configuration validation
  conf.validate();

  return conf;
};