redis / redis/RedisInsight

[Feature Request]: Honor .ssh/config file

Open
#1,880 5 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
TypeScript
Stars
8.8k
Forks
491
Avg merge
1d 22h
Merged PRs (30d)
49

Description

Problem description
The current provided ssh tunnel connection configuration is not flexible enough to accommodate a variety of hosts/keys, or more than one hop. It is particularly inconvenient to paste private key contents into the application.

I would like Redis Insight to support using the users ssh config file ( ~/.ssh/config by default) to specify connections.

A given configuration may be arbitrarily complex, but it can be contained within the ~/.ssh/config file.
For example, with the following contents in .ssh/config,

Host my-custom-host-alias
  HostName 1.2.3.4
  User me
  IdentityFile ~/.ssh/some-specific-key.pem
  ProxyJump some-other-host

it is possible to simply run ssh my-custom-host-alias and be connected as specified.

Ideally I would like to be able to specify my-custom-host-alias as the ssh tunnel host in Redis Insight, and have it use the same config to create the connection.
Currently, I receive the following error popup instead

Unable to create ssh connection. getaddrinfo ENOTFOUND my-custom-host-alias

How often do you encounter this problem
Any new connection, except to local servers. A few times a week for me.

Alternatives considered
Opening ssh tunnel in a separate terminal, remembering to close it when done.

Additional information
I did find someone had the same request in the old repo for Redis Desktop Manager, here https://github.com/RedisInsight/RedisDesktopManager/issues/1874
Seems it was closed back then, but I am hoping it can be incorporated into Redis Insight.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing Redis Insight's SSH tunnel connection setup and compare its current host handling with how ~/.ssh/config is interpreted by ssh. Verify the example alias, identity file, and ProxyJump behavior, then confirm that a configured alias creates the Redis connection without requiring a manually pasted private key.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
desktop, networking
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.