Sign inSign up

redis/redisinsight

Verified Publisher

By Redis

•Updated 13 days ago

Redis Insight - our best official GUI for Redis

Image
Databases & storage
54

1M+

redis/redisinsight repository overview

⁠General information

Redis Insight is an ideal tool for developers who build with any Redis deployments – including Redis Open Source, Redis Stack, Redis Enterprise Software, Redis Enterprise Cloud, and Amazon ElastiCache – and who want to optimize their development process. Redis Insight lets you visually browse and interact with data, take advantage of the advanced command line interface and diagnostic tools, and so much more⁠.

If you enjoy Redis Insight, star our repository⁠ to let us see the value you find in what we do.

⁠Run Redis Insight on Docker

You can install Redis Insight using one of the options described below.

  1. If you do not want to persist your Redis Insight data:
docker run -d --name redisinsight -p 5540:5540 redis/redisinsight:latest
  1. If you want to persist your Redis Insight data, first attach the Docker volume to the /data path and then run the following command:
docker run -d --name redisinsight -p 5540:5540 redis/redisinsight:latest -v redisinsight:/data

If the previous command returns a permission error, ensure that the user with ID = 1000 has the necessary permissions to access the volume provided (redisinsight in the command above).

Next, point your browser to http://localhost:5540.

Redis Insight also provides a health check endpoint at http://localhost:5540/api/health/ to monitor the health of the running container.

⁠Configuration environment variables

VariablePurposeDefaultAdditional info
RI_APP_PORTThe port that Redis Insight listens on.
  • Docker: 5540
  • desktop: 5530
See Express Documentation⁠
RI_APP_HOSTThe host that Redis Insight connects to.
  • Docker: 0.0.0.0
  • desktop: 127.0.0.1
See Express Documentation⁠
RI_SERVER_TLS_KEYPrivate key for HTTPS.n/aPrivate key in PEM format⁠. Can be a path to a file or a string in PEM format.
RI_SERVER_TLS_CERTCertificate for supplied private key.n/aPublic certificate in PEM format⁠. Can be a path to a file or a string in PEM format.
RI_ENCRYPTION_KEYKey to encrypt data with.n/aAvailable only for Docker.
Redis insight stores sensitive information (database passwords, Workbench history, etc.) locally (using sqlite3⁠). This variable allows you to store sensitive information encrypted using the specified encryption key.
Note: The same encryption key should be provided for subsequent docker run commands with the same volume attached to decrypt the information.
RI_LOG_LEVELConfigures the log level of the application.infoSupported logging levels are prioritized from highest to lowest:
  • error
  • warn
  • info
  • http
  • verbose
  • debug
  • silly
RI_FILES_LOGGERLogs to file.trueBy default, you can find log files in the following folders:
  • Docker: /data/logs
  • desktop: <user-home-dir>/.redisinsight-app/logs
RI_STDOUT_LOGGERLogs to STDOUT.true
RI_PROXY_PATHConfigures a subpath for a proxy.n/aAvailable only for Docker.
RI_DATABASE_MANAGEMENTWhen set to false, this disables the ability to manage database connections (adding, editing, or deleting).true

⁠Preconfigure database connections

Redis Insight allows you to preconfigure database connections using environment variables or a JSON file, enabling centralized and efficient configuration. There are two ways to preconfigure database connections in Redis Insight Electron and Docker:

  1. Use environment variables.
  2. Use a JSON file.

⁠Preconfigure database connections using environment variables

Redis Insight allows you to preconfigure database connections using environment variables.

NOTES:

  • To configure multiple database connections, replace the asterisk (*) in each environment variable with a unique identifier for each database connection. If setting up only one connection, you can omit the asterisk, and Redis Insight will default to using 0 as the ID.
  • If you modify environment variables, the changes will take effect after restarting Redis Insight.
  • If you restart Redis Insight without these environment variables, all previously added database connections will be removed.
VariablePurposeDefaultAdditional info
RI_REDIS_HOST*Host of a Redis database.N/A
RI_REDIS_PORT*Port of a Redis database.6379
RI_REDIS_ALIAS*Alias of a database connection.{host}:{port}
RI_REDIS_USERNAME*Username to connect to a Redis database.default
RI_REDIS_PASSWORD*Password to connect to a Redis database.No password
RI_REDIS_TLS*Indicates whether TLS certificates should be used to connect.FALSEAccepts TRUE or FALSE
RI_REDIS_TLS_CA_BASE64*CA certificate in base64 format.N/ASpecify a CA certificate in this environment variable or provide a file path using RI_REDIS_TLS_CA_PATH*.
RI_REDIS_TLS_CA_PATH*Path to the CA certificate file.N/A
RI_REDIS_TLS_CERT_BASE64*Client certificate in base64 format.N/ASpecify a client certificate in this environment variable or provide a file path using RI_REDIS_TLS_CERT_PATH*.
RI_REDIS_TLS_CERT_PATH*Path to the Client certificate file.N/A
RI_REDIS_TLS_KEY_BASE64*Private key for the client certificate in base64 format.N/AIndicate a private key in this environment variable or use another variable to get it from a file.
RI_REDIS_TLS_KEY_PATH*Path to private key file.N/A

⁠Preconfigure database connections using a JSON file

Redis Insight also allows you to preconfigure database connections using a JSON file.

NOTES

  • The JSON file format should match the one used when exporting database connections from Redis Insight.
  • The id field in the JSON file should include unique identifiers to avoid conflicts for database connections.
  • Changes to the JSON file will take effect after restarting Redis Insight.
  • If the JSON file is removed, all database connections added via the file will be removed.

⁠Redis Insight API

http://localhost:5540/api/docs⁠

Tag summary

Content type

Image

Digest

sha256:aa21bbd19…

Size

105.2 MB

Last updated

13 days ago

docker pull redis/redisinsight

This week's pulls

Pulls:

162,235

Last week

Learn more⁠