Skip to content

Commit

Permalink
Add some more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
coadler committed Aug 23, 2024
1 parent 711ace2 commit ecf46fd
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,38 @@ Install:
```bash
go install github.com/coder/wush/cmd/wush@latest
```

On the host machine:

```bash
$ wush receive
Picked DERP region Toronto as overlay home
Your auth key is:
> 112v1RyL5KPzsbMbhT7fkEGrcfpygxtnvwjR5kMLGxDHGeLTK1BvoPqsUcjo7xyMkFn46KLTdedKuPCG5trP84mz9kx
Use this key to authenticate other wush commands to this instance.
05:18:59 Wireguard is ready
05:18:59 SSH server listening
```

On the client machine:

```bash
$ wush
┃ Enter the receiver's Auth key:
| > 112v1RyL5KPzsbMbhT7fkEGrcfpygxtnvwjR5kMLGxDHGeLTK1BvoPqsUcjo7xyMkFn46KLTdedKuPCG5trP84mz9kx
Auth information:
> Server overlay STUN address: Disabled
> Server overlay DERP home: Toronto
> Server overlay public key: [sEIS1]
> Server overlay auth key: [w/sYF]
Bringing Wireguard up..
Wireguard is ready!
Received peer
Peer active with relay nyc
Peer active over p2p 172.20.0.8:44483
coder@colin:~$
```
## Technical Details
...
2 changes: 1 addition & 1 deletion cmd/wush/ssh.go
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ func sshCmd() *serpent.Command {
Flag: "wait-p2p",
Description: "Waits for the connection to be p2p.",
Default: "false",
Value: serpent.BoolOf(&sshStdio),
Value: serpent.BoolOf(&waitP2P),
},
},
}
Expand Down

0 comments on commit ecf46fd

Please sign in to comment.