From 5ee20e081ece628adc1acd070aa5b56cb9ba277d Mon Sep 17 00:00:00 2001 From: "David W. Dougherty" Date: Wed, 8 May 2024 13:48:59 -0700 Subject: [PATCH] DEV: re-do RI changes --- content/develop/connect/insight/_index.md | 11 +- .../env-variables.md => configuration.md} | 17 +- .../redisinsight/install/configuration.md | 160 ------------------ 3 files changed, 13 insertions(+), 175 deletions(-) rename content/operate/redisinsight/{install/env-variables.md => configuration.md} (77%) delete mode 100644 content/operate/redisinsight/install/configuration.md diff --git a/content/develop/connect/insight/_index.md b/content/develop/connect/insight/_index.md index cc444dce8..a1d8517a4 100644 --- a/content/develop/connect/insight/_index.md +++ b/content/develop/connect/insight/_index.md @@ -121,7 +121,8 @@ Redis Insight includes an opt-in telemetry system. This help us improve the deve ## Log files -To get detailed information about errors in Redis Insight, you can review the log files with the `.log` extension in the appropriate location: +You can review the Redis Insight log files (files with a `.log` extension) to get detailed information about system issues. +These are the locations on supported platforms: - **Docker**: In the `/data/logs` directory *inside the container*. - **Mac**: In the `/Users//.redis-insight` directory. @@ -132,14 +133,6 @@ To get detailed information about errors in Redis Insight, you can review the lo You can install Redis Insight on operating systems that are not officially supported, but it may not behave as expected. {{< /note >}} -## Using behind a reverse proxy - -When you configure Redis Insight to run behind a reverse proxy like [NGINX](https://www.nginx.com/): - -- Because some requests can be long-running, it is recommended that the request timeout is set to over 30 seconds on the reverse proxy. - Redis Insight also allows you to manage its connection timeout, which is 30 seconds by default, on the form to manage the connection details. -- Hosting Redis Insight behind a prefix path (path-rewriting) is not supported. - ## Feedback To provide your feedback, [open a ticket in our Redis Insight repository](https://github.com/Redis-Insight/Redis-Insight/issues/new). diff --git a/content/operate/redisinsight/install/env-variables.md b/content/operate/redisinsight/configuration.md similarity index 77% rename from content/operate/redisinsight/install/env-variables.md rename to content/operate/redisinsight/configuration.md index c198fa805..f63e8d7b5 100644 --- a/content/operate/redisinsight/install/env-variables.md +++ b/content/operate/redisinsight/configuration.md @@ -3,14 +3,11 @@ categories: - docs - operate - redisinsight -description: 'Redis Insight supported environment variables - - ' -linkTitle: Environment variables -title: Environment variables +linkTitle: Configuration settings +title: Redis Insight configuration settings weight: 5 --- -You can configure Redis Insight with the following environment variables. +## Environment variables | Variable | Purpose | Default | Additional info | | --- | --- | --- | --- | @@ -23,3 +20,11 @@ You can configure Redis Insight with the following environment variables. | RI_FILES_LOGGER | Logs to file | `true` | By default, you can find log files in the following folders: | | RI_STDOUT_LOGGER | Logs to STDOUT | `true` | | | RI_PROXY_PATH | Configures a subpath for a proxy | n/a | Available only for Docker. | + +## Use Redis Insight behind a reverse proxy + +When you configure Redis Insight to run behind a reverse proxy like [NGINX](https://www.nginx.com/), set the request timeout to over 30 seconds on the reverse proxy because some requests can be long-running. + +Redis Insight also allows you to manage its connection timeout on the form to configure the connection details. The default timeout is 30 seconds. + +Hosting Redis Insight behind a prefix path (path-rewriting) is not supported. diff --git a/content/operate/redisinsight/install/configuration.md b/content/operate/redisinsight/install/configuration.md deleted file mode 100644 index 89ba3685e..000000000 --- a/content/operate/redisinsight/install/configuration.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -categories: -- docs -- operate -- redisinsight -linkTitle: Configuration settings -title: Configuration settings -weight: 5 ---- -To configure Redis Insight with environment variables: - -1. Follow the instructions to set environment variables for your operating system: - - - [macOS](https://apple.stackexchange.com/a/106814) - - [Windows](https://www.architectryan.com/2018/08/31/how-to-change-environment-variables-on-windows-10/) - - [Linux](https://askubuntu.com/a/58828) - - [Docker](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) - -1. Restart Redis Insight. - -## Redis Insight environment variables - -Use the following environment variables to configure Redis Insight: - -### RIPORT - -**Description:** Which port should Redis Insight listen on. - -**Type:** Number - -**Default:** `8001` - -### RIHOST - -**Description:** Which host should Redis Insight bind to. - -**Type:** String - -**Default:** `"0.0.0.0"` on Docker and `"127.0.0.1"` on Windows, macOS, and Linux. - -### RIHOMEDIR - -**Description:** Sets the storage directory where Redis Insight stores application data (such as local database, log files, and snapshot files). - -**Type:** String - -**Default:** `"~/.redisinsight"` on desktop, `"/db"` on Docker. - -### RILOGDIR - -**Description:** Sets the directory where Redis Insight stores application logs. - -**Type:** String - -**Default:** `"~/.redisinsight"` on desktop, `"/db"` on Docker. - - -### RILOGLEVEL - -**Description:** Configures the log level of the application. Possible values are `"DEBUG"`, `"INFO"`, `"WARNING"`, `"ERROR`", and `"CRITICAL"`. - -**Type:** String - -**Default:** `"WARNING"` - - -### RITRUSTEDORIGINS - -**Description:** Configures the trusted origins of the application. - -**Type:** String - -**Default:** `""` - -**Examples:** `"https://my-website.com,https://my-another-website.com,http://my-third-website.com"` - -### RIPROXYENABLE - -**Description:** Enables Sub-path Proxy for the application. - -**Type:** Bool - -**Default:** `False` - - -### RIPROXYPATH - -**Description:** Configures Sub-path Proxy path for the application. - -**Type:** String - -**Default:** `""` - -**Examples:** `"/redisinsight"`, `"/myapp"` - -### RIPROXYPREFIX - -**Description:** Sets the Sub-path proxy prefix HTTP header field name for the application. The application uses the value from this HTTP header key as the proxy sub-path. - -**Type:** String - -**Default:** `"X-Forwarded-Prefix"` - -**Examples:** `"X-Forwarded-Prefix"`, `"X-Forwarded-Path"` - -### RIAUTHPROMPT - -**Description:** Enables an authentication prompt that asks for authentication before opening an instance or when the user is idle. - -**Type:** Bool - -**Default:** `false` - - -### RIAUTHTIMER - -**Description:** Idle timer value for the authentication prompt in minutes. - -**Type:** Bool - -**Default:** `30` - - -### REDISINSIGHT_PORT (DEPRECATED) - -**Description:** Which port should Redis Insight listen on. - -**Type:** Number - -**Default:** `8001` - -**Deprecated in:** `v1.9.0` - -### REDISINSIGHT_HOST (DEPRECATED) - -**Description:** Which host should Redis Insight bind to. - -**Type:** String - -**Default:** `"0.0.0.0"` - -**Deprecated in:** `v1.9.0` - -### REDISINSIGHT_HOME_DIR (DEPRECATED) - -**Description:** Sets the storage directory where Redis Insight stores application data (such as local database, log files, and snapshot files). - -**Type:** String - -**Default:** `"~/.redisinsight"` on desktop, `"/db"` on docker. - -**Deprecated in:** `v1.9.0` - -### LOG_DIR (DEPRECATED) - -**Description:** Sets the directory where Redis Insight stores application logs. - -**Type:** String - -**Default:** `"~/.redisinsight"` on desktop, `"/db"` on docker. \ No newline at end of file