]> git.r.bdr.sh - rbdr/dead-drop/blob - config/config.js
16e9a9f017dad1f581b82aa03aa0150c40542b5c
[rbdr/dead-drop] / config / config.js
1 'use strict';
2
3 const Getenv = require('getenv');
4
5 const internals = {};
6
7 /**
8 * The main configuration object for Dead Drop. It will be used to
9 * initialize all of the sub-components. It can extend any property of
10 * the dead drop object.
11 *
12 * @memberof DeadDrop
13 * @typedef {object} tConfiguration
14 * @property {number} [port=1988] the port where the app will listen on
15 * @property {DeadDrop.tRedisConfiguration} redis the configuration to
16 * connect to the redis server
17 */
18 module.exports = internals.Config = {
19 port: Getenv.int('DEAD_DROP_PORT', 1988),
20
21 /**
22 * Information required to connect to the redis server
23 *
24 * @memberof DeadDrop
25 * @typedef {object} tRedisConfiguration
26 * @property {string} host the location of the redis host
27 * @property {string} [post=6379] port where redis server is listening
28 */
29 redis: {
30 host: Getenv('DEAD_DROP_REDIS_HOST'),
31 port: Getenv.int('DEAD_DROP_REDIS_PORT', 6379)
32 }
33 };