v1.2.7

Author: andris9

.gitignore

@@ -2,3 +2,4 @@
 node_modules
 package-lock.json
 licenses.csv
+.env

README.md

@@ -91,6 +91,19 @@ Once application is started open http://127.0.0.1:3000/ for instructions and API
 
 ![](https://cldup.com/mK0aS_uVfQ.png)
 
+## Config mapping
+
+| Configuration option | CLI argument           | ENV value            | Default                      |
+| -------------------- | ---------------------- | -------------------- | ---------------------------- |
+| Redis connection URL | `--dbs.redis="url"`    | `REDIS_URL="url"`    | `"redis://127.0.0.1:6379/8"` |
+| Host to bind to      | `--api.host="1.2.3.4"` | `API_HOST="1.2.3.4"` | `"127.0.0.1"`                |
+| Port to bind to      | `--api.port=port`      | `API_HOST=port`      | `3000`                       |
+| Log level            | `--log.level="level"`  | `LOG_LEVEL=level`    | `"trace"`                    |
+
+> **NB!** environment variables override CLI arguments. CLI arguments override configuration file values.
+
+If available then IMAP API uses dotenv file from project root to populate environment variables.
+
 ## Example
 
 #### 1. Set up webhook target

lib/db.js

@@ -4,9 +4,9 @@ const fs = require('fs');
 const config = require('wild-config');
 const Queue = require('bull');
 const Redis = require('ioredis');
-const redis = new Redis(config.dbs.redis);
+const redis = new Redis(process.env.REDIS_URL || config.dbs.redis);
 
-const notifyQueue = new Queue('notify', { redis: config.dbs.redis });
+const notifyQueue = new Queue('notify', { redis: process.env.REDIS_URL || config.dbs.redis });
 
 const zExpungeScript = fs.readFileSync(__dirname + '/lua/z-expunge.lua', 'utf-8');
 const zSetScript = fs.readFileSync(__dirname + '/lua/z-set.lua', 'utf-8');

lib/logger.js

@@ -4,7 +4,7 @@ const config = require('wild-config');
 const pino = require('pino');
 
 let logger = pino();
-logger.level = config.log.level;
+logger.level = process.env.LOG_LEVEL || config.log.level;
 
 const { threadId } = require('worker_threads');
 

package.json

@@ -1,7 +1,7 @@
 {
     "name": "imapapi",
     "private": true,
-    "version": "1.2.6",
+    "version": "1.2.7",
     "description": "Email Sync Engine",
     "main": "server.js",
     "scripts": {
@@ -23,6 +23,7 @@
         "@popperjs/core": "2.2.1",
         "bootstrap": "4.4.1",
         "bull": "3.13.0",
+        "dotenv": ".value8.2.0",
         "email-reply-parser": "1.2.2",
         "exponential-backoff": "3.0.0",
         "hapi-pino": "7.0.0",

server.js

@@ -1,5 +1,7 @@
 'use strict';
 
+require('dotenv').config();
+
 process.title = 'imapapi';
 
 // cache before wild-config

workers/api.js

@@ -232,8 +232,8 @@ parentPort.on('message', message => {
 
 const init = async () => {
     const server = Hapi.server({
-        port: config.api.port,
-        host: config.api.host,
+        port: (process.env.API_PORT && Number(process.env.API_PORT)) || config.api.port,
+        host: process.env.API_HOST || config.api.host,
         query: {
             parser: query => qs.parse(query, { depth: 3 })
         }