sour-is/sshfwd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add readme

Browse Source
This commit is contained in:
Jonathan Lundy 2021-05-07 12:35:16 -06:00
parent 51a15cbe73
commit 348f865c05
2 changed files with 30 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -17,4 +17,4 @@ genkeys:
rm -f $(SSH_HOSTKEYS)/*.pub
forward:
ssh $(SSH_HOST) -p $(SSH_PORT) $(SSH_OPTS)
ssh -T $(SSH_HOST) -p $(SSH_PORT) $(SSH_OPTS)

29
README.md
View File

@ -1 +1,30 @@
# sshfwd
This is a reverse forward service that uses SSH as the transport. It works similar to ngrok or localtunnel.me.
You run the service on a internet addressible host and ssh to it. Using ssh remote forwards (ie. ssh -R) the port on the remote host will be forwared to
the configured port on your local machine.
on Remote host:
```sh
$ make genkeys # generate the services host keys.
$ SSH_HOSTKEYS=hostkeys SSH_LISTEN=:2222 sshfwd # run service on port 2222
```
on your local machine:
```sh
$ ssh -T remote.example.com -p 2222 -R 0.0.0.0:1234:localhost:3000
```
now if you access `remote.example.com:1234` it will be the same as accessing `localhost:3000`
# Pubkeys
if the env variable `SSH_AUTHKEYS` is set it will require that the client authenticates with one of the keys in the `SSH_AUTHKEYS` directory.
```sh
$ SSH_LISTEN=:2222 SSH_HOSTKEYS=hostkeys SSH_AUTHKEYS=authkeys sshfwd
```