Skip to content

Commit f1da25a

Browse files
author
ruogui.ygr
committed
Add AgentSocket description to README.md
Signed-off-by: ruogui.ygr <[email protected]>
1 parent d3c6869 commit f1da25a

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ Create a configuration file:
2222
```javascript
2323
{
2424
"KeyFiles": ["/path/to/key.priv"],
25+
26+
// AgentSocket can be empty or path to the ssh-agent socket.
27+
// "AgentSocket": "/path/to/ssh_agent.sock",
28+
// Or with the following to cooperate with envsubst(1):
29+
// "AgentSocket": "$SSH_AUTH_SOCK",
30+
2531
"KnownHostFiles": ["/path/to/known_hosts"],
2632
"Tunnels": [{
2733
// Forward tunnel (locally binded socket proxies to remote target).
@@ -44,4 +50,8 @@ ssh $USER@$HOST -i /path/to/key.priv -R $BIND_ADDRESS:$BIND_PORT:$DIAL_ADDRESS:$
4450

4551
Start the daemon (assuming `$GOPATH/bin` is in your `$PATH`):
4652

47-
```sshtunnel /path/to/config.json```
53+
```bash
54+
sshtunnel /path/to/config.json
55+
# With the following to cooperate with envsubst(1):
56+
# sshtunnel <(envsubst < /path/to/config.json)
57+
```

0 commit comments

Comments
 (0)