Skip to content

Commit a178faf

Browse files
authored
Merge pull request #60 from masahide/fix-name
Update README for proxy mode compatibility with OpenSSH and 1Password
2 parents cbebdb4 + 9b4ba28 commit a178faf

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,14 +104,16 @@ Variable name: SSH_AUTH_SOCK
104104
Variable value: /mnt/c/Users/<UserName>/OmniSSHAgent.sock
105105
```
106106

107-
## Using with OpenSSH ssh-agent NamedPipe (1Password, etc.) in Proxy Mode
107+
## Using with OpenSSH ssh-agent NamedPipe (also compatible with 1Password) in Proxy Mode
108108

109-
This mode uses [OpenSSH ssh-agent NamedPipe](https://learn.microsoft.com/windows-server/administration/openssh/openssh_keymanagement) or [1Password's ssh-agent function](https://developer.1password.com/docs/ssh/agent/) as a backend, as shown in the diagram below.
109+
This mode uses the [OpenSSH ssh-agent NamedPipe](https://learn.microsoft.com/windows-server/administration/openssh/openssh_keymanagement) as a backend. It can also be used with [1Passwords ssh-agent function](https://developer.1password.com/docs/ssh/agent/), as shown in the diagram below.
110110
![NamedPipe-Proxy-mode](https://github.com/masahide/OmniSSHAgent/blob/main/doc/NamedPipeProxyMode.png?raw=true)
111111

112-
By enabling "Proxy mode for 1Password key-agent" in the configuration, OmniSSHAgent functions as a proxy for 1Password or OpenSSH's NamedPipe SSH agent.
112+
By enabling **"Proxy mode for OpenSSH agent (also compatible with 1Password)"** in the configuration, OmniSSHAgent functions as a proxy for Windows OpenSSH's NamedPipe SSH agent.
113+
This mode also works with the 1Password key-agent.
114+
115+
**Note:** When "Proxy mode for OpenSSH agent (also compatible with 1Password)" is enabled, OmniSSHAgent operates solely as a proxy, and private keys cannot be added directly to it.
113116

114-
Note: When "Proxy mode for 1Password key-agent" is enabled, OmniSSHAgent operates solely as a proxy, meaning private keys cannot be added.
115117

116118
## Supported Key File Formats
117119
- PuTTY private key file (.ppk)

frontend/src/Settings.svelte

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -202,12 +202,12 @@
202202
<Switch
203203
bind:checked={data.ProxyModeOfNamedPipe}
204204
on:SMUISwitch:change={proxyToggle}
205-
value="Enable proxy mode for 1Password key-agent"
205+
value="Enable proxy mode for OpenSSH agent (also compatible with 1Password)"
206206
/>
207207
<span
208208
>{data.ProxyModeOfNamedPipe
209-
? "Enable proxy mode for 1Password key-agent"
210-
: "Disable proxy mode for 1Password key-agent"}</span
209+
? "Enable proxy mode for OpenSSH agent (also compatible with 1Password)"
210+
: "Disable proxy mode for OpenSSH agent (also compatible with 1Password)"}</span
211211
>
212212
</FormField>
213213
</div>

0 commit comments

Comments
 (0)