Skip to content

Commit e1bcf0b

Browse files
committed
Update readme with note on passphrases, and on system ssh-agent integration
1 parent 4537276 commit e1bcf0b

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ Strict host key checking can be turned off.
1818

1919
(default-session-options {:strict-host-key-checking :no})
2020

21+
By default, your current username and id_rsa key are used. If your key has a
22+
passphrase, and you are on OSX, then you should be asked for access to your
23+
keychain. If you are on any other OS, you will need to explicitly add your key
24+
to the clj-ssh's ssh-agent with the appropriate add-identity call.
25+
2126
More advance usage is possible.
2227

2328
(with-ssh-agent []
@@ -49,6 +54,10 @@ time.
4954

5055
## FAQ
5156

57+
Q: Why doesn't clj-ssh integrate with the OS's ssh agent?
58+
59+
A: Java has no access to the Unix domain socket used by the system ssh-agent.
60+
5261
Q: What does "4: Failure @ com.jcraft.jsch.ChannelSftp.throwStatusError(ChannelSftp.java:2289)" during an sftp transfer signify?
5362

5463
A: Probably a disk full, or permission error.

0 commit comments

Comments
 (0)