Skip to content

Commit d5dff8d

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

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ Create a configuration file:
2222
```javascript
2323
{
2424
"KeyFiles": ["/path/to/key.priv"],
25+
"AgentSocket": "/path/to/ssh_agent.sock",
26+
// Or with the following to cooperate with envsubst(1):
27+
// "AgentSocket": "$SSH_AUTH_SOCK",
2528
"KnownHostFiles": ["/path/to/known_hosts"],
2629
"Tunnels": [{
2730
// Forward tunnel (locally binded socket proxies to remote target).
@@ -44,4 +47,8 @@ ssh $USER@$HOST -i /path/to/key.priv -R $BIND_ADDRESS:$BIND_PORT:$DIAL_ADDRESS:$
4447

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

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

0 commit comments

Comments
 (0)