Update configuration.md

redis · Jan 22, 2024 · 7452bd6 · 7452bd6
1 parent 72b9c98
commit 7452bd6
Showing 1 changed file with 65 additions and 17 deletions.
diff --git a/docs/install/install-redisinsight/configuration.md b/docs/install/install-redisinsight/configuration.md
@@ -6,27 +6,75 @@ categories: ["RI"]
 path: install/install-redisinsight/configuration
 altTag: Configure RedisInsight
 ---
-You can configure RedisInsight with system environment variables.
+You can configure RedisInsight with the following environment variables.
 
-To configure RedisInsight with environment variables:
 
-1. Set environment variables for your operating system:
+### RI_APP_PORT
 
-    - [Mac](https://apple.stackexchange.com/a/106814)
-    - [Windows](https://support.microsoft.com/en-au/topic/how-to-manage-environment-variables-in-windows-xp-5bf6725b-655e-151c-0b55-9a8c9c7f747d)
-    - [Linux](https://askubuntu.com/a/58828)
-    - [Docker](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)
+**Description:** Port which RedisInsight should listen to.
 
-1. Set the environment variables.
-1. Restart RedisInsight.
+**Type:** Number
 
-## RedisInsight environment variables
+**Default:** `5540`
 
-The following environment variables can be set to configure RedisInsight:
+**Example:** `-e RI_APP_PORT=5001`
 
-| Environment variable | Description | Type | Default |
-| --- | --- | --- | --- |
-| RI_APP_PORT | Port which RedisInsight should listen to. | Number | `5540` |
-| RI_APP_HOST | Host which RedisInsight should listen to. | String | `0.0.0.0` on Docker and `127.0.0.1` on Windows, Mac, and Linux. |
-| RI_LOG_LEVEL | Configures the log level of the application. Possible values are - `"DEBUG"`, `"INFO"`, `"WARNING"`, `"ERROR`" and `"CRITICAL"`. | String | `"WARNING"` |
-| RI_FILES_LOGGER | Log to file	| Boolean | `False` |
+### RI_APP_HOST
+
+**Description:** Host which RedisInsight should listen to.
+
+**Type:** String
+
+**Default:** `0.0.0.0` on Docker and `127.0.0.1` on Windows, Mac, and Linux.
+
+**Example:** `-e RI_APP_HOST=127.0.0.1`
+
+### RI_LOG_LEVEL
+
+**Description:** Configures the log level of the application. Possible values are - `"DEBUG"`, `"INFO"`, `"WARNING"`, `"ERROR`" and `"CRITICAL"`.
+
+**Type:** String
+
+**Default:** `"WARNING"`
+
+**Example:** `-e RI_LOG_LEVEL="DEBUG"
+
+### RI_FILES_LOGGER
+
+**Description:** Allows to log to file.
+
+**Type:** Boolean
+
+**Default:** `true`
+
+**Example:** `-e RI_FILES_LOGGER=false`
+
+### RI_ENCRYPTION_KEY
+
+**Description:** Enables encryption for storing sensitive information (database passwords, Workbench history, etc.) using an encryption key. <p> `Note:` Securely store the specified encryption key to be able to provide it in the future (e.g. during the startup process), otherwise RedisInsight will not be able to decrypt the information.
+
+**Type:** String
+
+**Default:** no defailt value
+
+**Example:** `-e RI_ENCRYPTION_KEY=b3daa77b4c04a9551b8781d03191fe098f325e67`
+
+### RI_SERVER_TLS_CERT
+
+**Description:** Provides a path to a file with TLS certificate.
+
+**Type:** String
+
+**Default:** no defailt value
+
+**Example:** `-e RI_SERVER_TLS_CERT="/certs/example.crt`
+
+### RI_SERVER_TLS_KEY
+
+**Description:** Provides a path to a file with TLS private key.
+
+**Type:** String
+
+**Default:** no defailt value
+
+**Example:** `-e RI_SERVER_TLS_KEY="/certs/example.key`