diff --git a/content/develop/connect/insight/_index.md b/content/develop/connect/insight/_index.md index 104d8a2b5..cc444dce8 100644 --- a/content/develop/connect/insight/_index.md +++ b/content/develop/connect/insight/_index.md @@ -119,6 +119,27 @@ With Redis Insight you can now also extend the core functionality by building yo Redis Insight includes an opt-in telemetry system. This help us improve the developer experience of the app. We value your privacy; all collected data is anonymized. +## 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: + +- **Docker**: In the `/data/logs` directory *inside the container*. +- **Mac**: In the `/Users//.redis-insight` directory. +- **Windows**: In the `C:\Users\\.redis-insight` directory. +- **Linux**: In the `/home//.redis-insight` directory. + +{{< note >}} +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/kubernetes/active-active/_index.md b/content/operate/kubernetes/active-active/_index.md index 6d9784251..74e9d973c 100644 --- a/content/operate/kubernetes/active-active/_index.md +++ b/content/operate/kubernetes/active-active/_index.md @@ -50,7 +50,9 @@ For versions 6.4.2 or earlier, this Active-Active setup method includes the foll To create an Active-Active Redis Enterprise deployment for Kubernetes with these new features, first [prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}) then [create an Active-Active database]({{< relref "/operate/kubernetes/active-active/create-reaadb.md" >}}). -{{}} If you are using a preview version of these features (operator version 6.4.2-4 or 6.4.2-5), you'll need to enable the Active-Active controller with the following steps. You need to do this only once per cluster. We recommend using the fully supported 6.4.2-6 version. +### Preview versions + +If you are using a preview version of these features (operator version 6.4.2-4 or 6.4.2-5), you'll need to enable the Active-Active controller with the following steps. You need to do this only once per cluster. We recommend using the fully supported 6.4.2-6 version. 1. Download the custom resource definitions (CRDs) for the most recent release (6.4.2-4) from [redis-enterprise-k8s-docs Github](https://github.com/RedisLabs/redis-enterprise-k8s-docs/tree/master/crds). @@ -60,13 +62,14 @@ To create an Active-Active Redis Enterprise deployment for Kubernetes with these kubectl apply -f crds/reaadb_crd.yaml kubectl apply -f crds/rerc_crd.yaml ``` + 1. Enable the Active-Active and remote cluster controllers on the operator ConfigMap. + ```sh kubectl patch cm operator-environment-config --type merge --patch "{\"data\": \ {\"ACTIVE_ACTIVE_DATABASE_CONTROLLER_ENABLED\":\"true\", \ \"REMOTE_CLUSTER_CONTROLLER_ENABLED\":\"true\"}}" -{{}} ### REAADB custom resource diff --git a/content/operate/kubernetes/active-active/prepare-clusters.md b/content/operate/kubernetes/active-active/prepare-clusters.md index 8e17d2105..a62bd3eb6 100644 --- a/content/operate/kubernetes/active-active/prepare-clusters.md +++ b/content/operate/kubernetes/active-active/prepare-clusters.md @@ -31,7 +31,9 @@ Next you'll [collect credentials](#collect-rec-credentials) for your participati For a list of example values used throughout this article, see the [Example values](#example-values) section. -{{}} If you are using a preview version of these features (operator version 6.4.2-4 or 6.4.2-5), you'll need to enable the Active-Active controller with the following steps. You need to do this only once per cluster. We recommend using the fully supported 6.4.2-6 version. +### Preview versions + +If you are using a preview version of these features (operator version 6.4.2-4 or 6.4.2-5), you'll need to enable the Active-Active controller with the following steps. You need to do this only once per cluster. We recommend using the fully supported 6.4.2-6 version. 1. Download the custom resource definitions (CRDs) for the most recent release (6.4.2-4) from [redis-enterprise-k8s-docs Github](https://github.com/RedisLabs/redis-enterprise-k8s-docs/tree/master/crds). @@ -41,14 +43,14 @@ For a list of example values used throughout this article, see the [Example valu kubectl apply -f crds/reaadb_crd.yaml kubectl apply -f crds/rerc_crd.yaml ``` + 1. Enable the Active-Active and remote cluster controllers on the operator ConfigMap. + ```sh kubectl patch cm operator-environment-config --type merge --patch "{\"data\": \ {\"ACTIVE_ACTIVE_DATABASE_CONTROLLER_ENABLED\":\"true\", \ \"REMOTE_CLUSTER_CONTROLLER_ENABLED\":\"true\"}}" -{{}} - ## Collect REC credentials To communicate with other clusters, all participating clusters will need access to the admin credentials for all other clusters. diff --git a/content/operate/rc/databases/configuration/high-availability.md b/content/operate/rc/databases/configuration/high-availability.md index c7db0d1fd..10e6314c4 100644 --- a/content/operate/rc/databases/configuration/high-availability.md +++ b/content/operate/rc/databases/configuration/high-availability.md @@ -44,7 +44,7 @@ Replication can affect performance as traffic increases to synchronize all copie For both Redis Cloud Essentials and Redis Cloud Pro, replication doubles the dataset size you need for your database. -For Redis Cloud Essentials, the size of the plan you choose includes replication. Therefore, if you choose replication, the dataset size you can use is half of the stated plan size. For example, if you choose a 1GB plan, Redis allocates 512 GB for the memory limit, and the other 512 MB for Replication. +For Redis Cloud Essentials, the size of the plan you choose includes replication. Therefore, if you choose replication, the dataset size you can use is half of the stated plan size. For example, if you choose a 1GB plan, Redis allocates 512 MB for the dataset size, and the other 512 MB for replication. For Redis Cloud Pro, you also need to double the amount of memory needed if you choose replication. diff --git a/content/operate/rc/security/_index.md b/content/operate/rc/security/_index.md index 4543d6504..1c7c563c1 100644 --- a/content/operate/rc/security/_index.md +++ b/content/operate/rc/security/_index.md @@ -32,6 +32,10 @@ Secure access to the Redis Cloud console by: - Enabling [SAML SSO]({{< relref "/operate/rc/security/access-control/saml-sso" >}}). +{{< note >}} +A user session on Redis Cloud expires after 30 minutes. You'll be signed out of Redis Cloud after 30 minutes of inactivity. +{{< /note >}} + ## Database security You have several options when it comes to securing your Redis Cloud databases. For more information, see [Cloud database security]({{< relref "/operate/rc/security/database-security/" >}}). Options include: diff --git a/content/operate/redisinsight/install/configuration.md b/content/operate/redisinsight/install/configuration.md new file mode 100644 index 000000000..89ba3685e --- /dev/null +++ b/content/operate/redisinsight/install/configuration.md @@ -0,0 +1,160 @@ +--- +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 diff --git a/content/operate/redisinsight/install/install-on-k8s.md b/content/operate/redisinsight/install/install-on-k8s.md index fd4ca22e4..172e7db49 100644 --- a/content/operate/redisinsight/install/install-on-k8s.md +++ b/content/operate/redisinsight/install/install-on-k8s.md @@ -173,7 +173,7 @@ spec: - /bin/sh - '-c' - | - chown -R 1001 /data + chown -R 1000 /data resources: {} volumeMounts: - name: redisinsight diff --git a/layouts/home.html b/layouts/home.html index 193db28f3..515fe3b7d 100644 --- a/layouts/home.html +++ b/layouts/home.html @@ -48,28 +48,28 @@

{{ .Title }}

diff --git a/layouts/partials/docs-nav-collapsed.html b/layouts/partials/docs-nav-collapsed.html index 6492e06e4..1bbec06bc 100644 --- a/layouts/partials/docs-nav-collapsed.html +++ b/layouts/partials/docs-nav-collapsed.html @@ -1,6 +1,16 @@
diff --git a/layouts/partials/docs-nav.html b/layouts/partials/docs-nav.html index 028a04d77..2831766ff 100644 --- a/layouts/partials/docs-nav.html +++ b/layouts/partials/docs-nav.html @@ -41,6 +41,28 @@ {{ $navRoot := cond (eq .Site.Home.Type "docs") .Site.Home .FirstSection -}} {{ $ulNr := 0 -}} {{ $ulShow := 1 -}} +
+ Commands + {{ if eq $navRoot.LinkTitle "Commands" }} +
    + {{ template "li" (dict "page" . "pages" (union $navRoot.Pages $navRoot.Sections).ByWeight) }} +
+ {{ end }} + APIs + {{ if eq $navRoot.LinkTitle "APIs" }} +
    + {{ template "li" (dict "page" . "pages" (union $navRoot.Pages $navRoot.Sections).ByWeight) }} +
+ {{ end }} +
+
+ Get started + {{ if eq $navRoot.LinkTitle "Get started" }} +
    + {{ template "li" (dict "page" . "pages" (union $navRoot.Pages $navRoot.Sections).ByWeight) }} +
+ {{ end }} +
Develop {{ if eq $navRoot.LinkTitle "Develop" }} @@ -61,13 +83,6 @@ {{ end }}
-
- Commands - {{ if eq $navRoot.LinkTitle "Commands" }} -
    - {{ template "li" (dict "page" . "pages" (union $navRoot.Pages $navRoot.Sections).ByWeight) }} -
- {{ end }}
diff --git a/layouts/partials/header/support-dropdown.html b/layouts/partials/header/support-dropdown.html index 0bd8d5c16..60e07d700 100644 --- a/layouts/partials/header/support-dropdown.html +++ b/layouts/partials/header/support-dropdown.html @@ -2,15 +2,12 @@ - \ No newline at end of file +