RI-5042: Add documentation for env variables

Author: nelsonwellsredis

DOCKER_README.md

@@ -0,0 +1,26 @@
+# Docker
+
+Included in this repository is a Dockerfile that can be used to deploy a hosted instance of Redis Insight.
+
+# Usage
+
+To build and run the image locally with Docker buildx, simply
+
+```
+$ docker buildx build -t redis-insight:latest
+$ docker run -d -p5000:5000 redis-insight:latest
+```
+
+These commands will build the image and then start the container. Redis Insight can then be accessed on localhost port 5000, `http://localhost:5000`.
+
+# Configuration
+
+Redis Insight supports several configuration values that can be supplied via container environment variables. The following may be provided:
+
+| Variable | Purpose | Default | Additional Info |
+| ---------|---------|-----------------|---------|
+| RI_APP_PORT | The port the app listens on | 5000 | See [Express Documentation](https://expressjs.com/en/api.html#app.listen) |
+| RI_APP_HOST | The host the app listens on | 0.0.0.0 | See [Express Documentation](https://expressjs.com/en/api.html#app.listen) |
+| RI_SERVER_TLS | Enable HTTPS | false | If `true`, requires RI_SERVER_TLS_KEY and RI_SERVER_TLS_CERT as well. |
+| RI_SERVER_TLS_KEY | Private key for HTTPS | | Private key in [PEM format](https://www.ssl.com/guide/pem-der-crt-and-cer-x-509-encodings-and-conversions/#ftoc-heading-3). May be a path to a file or a string in PEM format. |
+| RI_SERVER_TLS_CERT | Certificate for supplied private key | | Public certificate in [PEM format](https://www.ssl.com/guide/pem-der-crt-and-cer-x-509-encodings-and-conversions/#ftoc-heading-3) |

Dockerfile

@@ -43,13 +43,13 @@ FROM node:18.18-alpine
 
 # runtime args and environment variables
 ARG NODE_ENV=production
-ARG RI_HOSTNAME
+ARG RI_APP_HOST
 ARG RI_APP_PORT=5000
 ARG RI_SERVER_TLS
 ARG RI_SERVER_TLS_CERT
 ARG RI_SERVER_TLS_KEY
 ARG SEGMENT_WRITE_KEY
-ENV RI_HOSTNAME=${RI_HOSTNAME}
+ENV RI_APP_HOST=${RI_APP_HOST}
 ENV RI_APP_PORT=${RI_APP_PORT}
 ENV RI_SERVER_TLS=${RI_SERVER_TLS}
 ENV RI_SERVER_TLS_CERT=${RI_SERVER_TLS_CERT}

configs/webpack.config.main.prod.ts

@@ -62,7 +62,7 @@ export default merge(baseConfig, {
       RI_SERVER_TLS_KEY: process.env.RI_SERVER_TLS_KEY || '',
       APP_FOLDER_NAME: process.env.APP_FOLDER_NAME || '',
       UPGRADES_LINK: process.env.UPGRADES_LINK || '',
-      RI_HOSTNAME: '127.0.0.1',
+      RI_APP_HOST: '127.0.0.1',
       BUILD_TYPE: 'ELECTRON',
       APP_VERSION: version,
       AWS_BUCKET_NAME:

configs/webpack.config.main.stage.ts

@@ -26,7 +26,7 @@ export default merge(mainProdConfig, {
       RI_SERVER_TLS_KEY: process.env.RI_SERVER_TLS_KEY || '',
       APP_FOLDER_NAME: process.env.APP_FOLDER_NAME || '',
       UPGRADES_LINK: process.env.UPGRADES_LINK || '',
-      RI_HOSTNAME: '127.0.0.1',
+      RI_APP_HOST: '127.0.0.1',
       BUILD_TYPE: 'ELECTRON',
       APP_VERSION: version,
       AWS_BUCKET_NAME:

redisinsight/api/config/default.ts

@@ -43,7 +43,7 @@ export default {
   server: {
     version,
     env: 'development',
-    listenInterface: process.env.RI_HOSTNAME ?? '0.0.0.0',
+    host: process.env.RI_APP_HOST ?? '0.0.0.0',
     port: process.env.RI_APP_PORT ?? 5000,
     docPrefix: 'api/docs',
     globalPrefix: 'api',

redisinsight/api/src/main.ts

@@ -26,7 +26,7 @@ interface IApp {
 export default async function bootstrap(): Promise<IApp> {
   await migrateHomeFolder();
 
-  const port = serverConfig.port;
+  const { port, host } = serverConfig;
   const logger = WinstonModule.createLogger(LOGGER_CONFIG);
 
   const options: NestApplicationOptions = {
@@ -66,11 +66,9 @@ export default async function bootstrap(): Promise<IApp> {
 
   const logFileProvider = app.get(LogFileProvider);
 
-  await app.listen(port, serverConfig.listenInterface);
+  await app.listen(port, host);
   logger.log({
-    message: `Server is running on http(s)://${
-      serverConfig.listenInterface ?? 'localhost'
-    }:${port}`,
+    message: `Server is running on http(s)://${host}:${port}`,
     context: 'bootstrap',
   });