Skip to content

Commit a54cc82

Browse files
committed
Add ssh agent docs
1 parent 0cd1955 commit a54cc82

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

docs/quick-start.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,47 @@ rediss://user:password@host:port
8484
## Connect to private redis-server via SSH tunnel
8585
### Basic SSH tunneling
8686
SSH tab is supposed to allow you to use a SSH tunnel. It's useful if your redis-server is not publicly accessible.
87-
To use a SSH tunnel select checkbox "Use SSH Tunnel". There are different security options; you can use a plain password or OpenSSH private key.
87+
To use a SSH tunnel select checkbox "SSH Tunnel". There are different security options; you can use a plain password or OpenSSH private key.
8888

8989
>!!! note "for Windows users:"
9090
Your private key must be in .pem format.
9191

92-
<img src="http://resp.app/static/docs/rdm_ssh.png?v=2" />
92+
<img height="350" src="http://resp.app/static/docs/resp_ssh.png?v=1" />
93+
94+
### SSH Agent
95+
Starting from version 2022.3 RESP.app supports SSH Agents. This allows using password managers like [1Password](https://developer.1password.com/docs/ssh/agent)
96+
to securely store your SSH keys with 2FA.
97+
98+
>!!! note "for Windows users:"
99+
On Windows RESP.app supports only [Microsoft OpenSSH](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_overview) that's why "Custom SSH Agent Path" option is not available.
100+
101+
##### How to connect to 1Password SSH-Agent from DMG version of RESP.app
102+
It's possible to set default SSH Agent for all connections in RESP.app by overriding environment variable `SSH_AUTH_SOCK`.
103+
If you need to use custom ssh agent only for specific connections follow steps above:
104+
105+
1. Create symlink to agent.sock
106+
```
107+
mkdir -p ~/.1password && ln -s ~/Library/Group\ Containers/2BUA8C4S2C.com.1password/t/agent.sock ~/.1password/agent.sock
108+
```
109+
2. In RESP.app check "Use SSH Agent" checkbox and click on the "Select File" button next to "Custom SSH Agent Path" field
110+
3. Press `⌘ + Shift + .` to show hidden files and folders in the dialog
111+
4. Select file `~/.1password/agent.sock`
112+
5. Save connection settings
113+
114+
##### How to connect to SSH-Agent from AppStore version of RESP.app
115+
116+
Due to AppStore sandboxing RESP.app cannot access default or custom SSH Agents defined by `SSH_AUTH_SOCK` variable.
117+
To overcome this limitation you need to create proxy unix socket inside RESP.app sandbox container:
118+
119+
1. Install socat with homebrew
120+
```
121+
brew install socat
122+
```
123+
2. Create proxy unix-socket with socat:
124+
```
125+
socat UNIX-LISTEN:$HOME/Library/Containers/com.redisdesktop.rdm/Data/agent.sock UNIX-CONNECT:"$HOME/Library/Group Containers/2BUA8C4S2C.com.1password/t/agent.sock"
126+
```
127+
93128

94129
### Advanced SSH tunneling
95130
If you need advanced SSH tunneling you should setup a SSH tunnel manually and connect via localhost:

0 commit comments

Comments
 (0)