What is RediNav?
It is a rich, powerful and secure Redis desktop client to connect to your Redis (tm) servers. It allows executing all operations you may need in your daily work with Redis - search/add/remove/edit keys, export and import keys, clone or rename keys and so on. Please check the extended list of features below.
Terminal UI (execute arbitrary Redis commands and Lua scripts)
SSH tunneling and SSL/TLS support (up to latest secure version)
Infinite number of saved connections
Direct connection to Redis (TM) server port
Redis (TM) password authentication
Adjustable connection and execution timeout
Dark and White (default) themes
Easy to navigate connections, databases and keys
Lazy loading namespaces (performance)
Ability to save key content to a local file
Redis Cluster mode ON support
Ability to set a connection in “read-only” mode
Utilize “namespaces” as folder-like structure
Enable disable dangerous operations (safety)
Dump keys, namespace or entire database
Import keys from JSON
Multi-member selection for member based keys
Multi-field selection for hash keys
Key content search
Database level key name filtering
How to ...
Create a Connection
Click "Add connection" button located in the top toolbar. A modal dialog is opened, where you define the connection properties: host (domain name or IP address), optionally Redis password and/or private key content, in case of connecting to the server through an SSH tunnel or over SSL/TLS protocols.
Additionally, you can set some advanced connection settings, like timeouts, namespace separator and other useful settings, like setting the connection to Read Only status. Note please, this is only client side, it does not change server configuration in any way, just disables all "writing" operations in the client interface.
Non secure connection
Non secure connection is when you connect to Redis server without using SSH tunneling or SSL/TLS. This scenario is suitable for local networks or VPN environment, but is not recommended for other remote access use cases.
Redis Password authentication
Redis server provides a very simple authentication mechanism (through server configuration settings). It is a plain text password sent over the wire. For this reason it should not be used in a production environment (unless the connection is secured via SSL/TLS encryption).
To make things more secure it is recommended to use SSH tunneling or SSL/TLS connections. We support all modern, recent and secure versions of SSH/SSL/TLS protocols.
After awhile, you will have plenty of connections in the tree on the left side of the main window. For backup purposes or for any other reason (moving to another computer) you can export all defined connections and then import them back.
Note please, private keys and certificates (for SSH and SSL/TLS connections) are NOT exported, nor imported. You must edit all secure connections and add the key content again. This is done for security reasons to protect your information.
To export/import connections click the relevant button in the top toolbar.
Just click the defined connection in the tree on the left side. After a short time the connection icon must change its color, indicating a successful connection. If something goes wrong, you should see some helpful information in the Log Area.
Navigating connections, databases, namespaces and keys
All defined connections (servers), their databases, namespaces and keys form one single tree-like interface. You can have as many connected servers as you wish at the same time, freely navigating up and down the tree, as well as going deep into any and every server's database and keys, without disconnecting other servers.
This way you can easily and quickly navigate across many servers and their databases, providing an efficient way to observe, supervise and use your Redis servers' data.
A filter can be defined and applied on a per-database basis. Only keys matching the filter remain visible (including those the the namespace folders).
Note please, filter is applied when database keys are dumped to a JSON file (see below).
Supported key types
Supported key types: String, Hash, List, Set, ZSet
Read more about Redis data types here.
Adding and deleting key(s)
To add a key to a database, right-click on database item and click "Add key" item.
To remove a key, right-click on the key item and select "Delete".
Remove operation allows multiple key selection - select as many keys as you want (as long as they are members of a single namespace or database) and the right-click the selection. Cross namespace/database/server multi-key selection is not allowed.
To edit a key, click the key and a Tab will be opened in the Data Area. Clicking another key will close the current tab and open another one for the new key. If you want to have multiple keys opened for editing at the same time, right-click the key and select "Open in new tab".
Edit interface is pretty much self-explanatory. Explore the user interface and find these possible operations and more:
→ Rename key
→ Clone key
→ Delete key
→ Reload key data
→ Set key TTL
→ Set key to NOT expire
→ Save key data to local file
→ Add key members
→ Remove key members (multiple selection allowed)
→ Format textual data (JSON, PHP Serialize, Minify)
→ Search key data (for all but String keys)
→ Paginated members list (only for certain key types)
Cloning a key
If you want to copy/clone a key (including its content), select the desired key, right-click to open the context menu and click "Clone". A dialog is opened, asking for the new key name (by default adding "-copy" at the end of current key).
Dumping/Importing keys data
Keys can be dumped to a JSON file. You can dump single key, multiple keys at once, a whole namespace or even all the keys in a given database. In case of namespace and database dump, current filter is applied and only visible keys are dumped.
A JSON dump can be imported into a selected database, just right-click the database item, click "Import keys.." and select the JSON file from the disk.
Caution: attempting to dump big database may result in a very slow operation, especially if the server is remote and connection is slow. With that said, it is better to use some third party command line tools for backup and restore Redis data.
A special tab can be opened to gather live server information. Right-click on a connection (it doesn't have to be connected at that very moment) and select "Server information". A new tab is opened with a tabular interface, collecting all remotely accessible information about the server (updated on every 5 seconds, unless FREEZE button is toggled):
→ General Server info
→ Clients List (all connected clients at the moment)
You can open a terminal UI to connect to Redis server and run native commands as well as Lua scripts. For commands you get 2 modes - single command mode and mutli-command mode.
Single command mode keeps a history of commands executed (for now, only per session, future versions will make it persistent across application runs). Just type the command and hit Enter - the result goes to the output pane below.
Multi-command mode allows executing a batch of Redis commands in sequence, which you can also import from a file.
Additionally, you can type or load a Lua script and run it - again, the output/response goes to output pane.
Redis cluster mode ON is supported (auto detected) with few limitations. See the list of restricted operations and limitations that may apply:
- clone key disabled
- rename key disabled
- multi-key deletion MAY not function well