Very silly README

This commit is contained in:
John Doty 2022-10-17 20:43:33 -07:00
parent 86ea099b2c
commit 4470108f3e

23
README.md Normal file
View file

@ -0,0 +1,23 @@
# fwd
A port-forwarding utility.
Here's how it works:
1. You install `fwd` on the server.
2. You install `fwd` on the client.
3. You run `fwd` on the client to connect to the server, like so:
```bash
doty@my.laptop$ fwd some.server
```
`fwd` will connect to `some.server` via ssh, and then show you a screen listing all of the ports that the server is listening on locally.
Use the up and down arrow keys (or `j`/`k`) to select the port you're interested in and press `e` to toggle forwarding of that port.
Now, connections to that port locally will be forwarded to the remote server.
If the port is something that might be interesting to a web server, you can press `<ENTER>` with the port selected to open a browser pointed at that port.
If something is going wrong, pressing `l` will toggle logs that might explain it.
Press `q` to quit.