Add a configuration to allow forward to a different local host (#15)

* Add a configuration to allow forward to a different local host

* Minor documentation / formatting change

Co-authored-by: Eric Zhang <ekzhang1@gmail.com>
This commit is contained in:
Antonio Mika
2022-04-11 23:45:07 -04:00
committed by GitHub
parent 634af3f6af
commit 99fc4f7ddb
4 changed files with 30 additions and 13 deletions

View File

@@ -47,7 +47,7 @@ You can forward a port on your local machine by using the `bore local` command.
bore local 5000 --to bore.pub
```
You can optionally pass in a `--port` option to pick a specific port on the remote to expose, although the command will fail if this port is not available.
You can optionally pass in a `--port` option to pick a specific port on the remote to expose, although the command will fail if this port is not available. Also, passing `--local-host` allows you to expose a different host on your local area network besides the loopback address `localhost`.
The full options are shown below.
@@ -59,14 +59,15 @@ USAGE:
bore local [OPTIONS] --to <TO> <LOCAL_PORT>
ARGS:
<LOCAL_PORT> The local port to listen on
<LOCAL_PORT> The local port to expose
OPTIONS:
-h, --help Print help information
-p, --port <PORT> Optional port on the remote server to select [default: 0]
-s, --secret <SECRET> Optional secret for authentication
-t, --to <TO> Address of the remote server to expose local ports to
-V, --version Print version information
-h, --help Print help information
-l, --local-host <HOST> The local host to expose [default: localhost]
-p, --port <PORT> Optional port on the remote server to select [default: 0]
-s, --secret <SECRET> Optional secret for authentication
-t, --to <TO> Address of the remote server to expose local ports to
-V, --version Print version information
```
### Self-Hosting