Skip to content

Commit ecf46fd

Browse files
committed
Add some more docs
1 parent 711ace2 commit ecf46fd

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,38 @@ Install:
1313
```bash
1414
go install github.com/coder/wush/cmd/wush@latest
1515
```
16+
17+
On the host machine:
18+
19+
```bash
20+
$ wush receive
21+
Picked DERP region Toronto as overlay home
22+
Your auth key is:
23+
> 112v1RyL5KPzsbMbhT7fkEGrcfpygxtnvwjR5kMLGxDHGeLTK1BvoPqsUcjo7xyMkFn46KLTdedKuPCG5trP84mz9kx
24+
Use this key to authenticate other wush commands to this instance.
25+
05:18:59 Wireguard is ready
26+
05:18:59 SSH server listening
27+
```
28+
29+
On the client machine:
30+
31+
```bash
32+
$ wush
33+
┃ Enter the receiver's Auth key:
34+
| > 112v1RyL5KPzsbMbhT7fkEGrcfpygxtnvwjR5kMLGxDHGeLTK1BvoPqsUcjo7xyMkFn46KLTdedKuPCG5trP84mz9kx
35+
Auth information:
36+
> Server overlay STUN address: Disabled
37+
> Server overlay DERP home: Toronto
38+
> Server overlay public key: [sEIS1]
39+
> Server overlay auth key: [w/sYF]
40+
Bringing Wireguard up..
41+
Wireguard is ready!
42+
Received peer
43+
Peer active with relay nyc
44+
Peer active over p2p 172.20.0.8:44483
45+
coder@colin:~$
46+
```
47+
48+
## Technical Details
49+
50+
...

cmd/wush/ssh.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ func sshCmd() *serpent.Command {
156156
Flag: "wait-p2p",
157157
Description: "Waits for the connection to be p2p.",
158158
Default: "false",
159-
Value: serpent.BoolOf(&sshStdio),
159+
Value: serpent.BoolOf(&waitP2P),
160160
},
161161
},
162162
}

0 commit comments

Comments
 (0)