Skip to content

Commit 880f0e2

Browse files
authored
Merge pull request #3 from davrodpin/update-website
Update mole website
2 parents 51f053d + 76a3476 commit 880f0e2

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/index.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@ layout: default
44

55
**Mole** is a _cli_ application to create _ssh_ tunnels, forwarding a local port to a remote address through a _ssh_ server.
66

7-
It tries to leverage the user's ssh config file, *$HOME/.ssh/config*, to find
8-
options to be used to connect to the ssh server when those options are not
9-
given (e.g. user name, identity key path and port).
107

8+
**Highlighted Features**
9+
10+
* [Auto local address selection](#let-mole-to-randomly-select-the-local-endpoint): find a port available and start linstening to it, so the `-local` flag doesn't need to be given every time you run the app.
11+
* [Aliases](#create-an-alias-so-there-is-no-need-to-remember-the-tunnel-settings-afterwards): save your tunnel settings under an alias, so it can be reused later.
12+
* Leverage the SSH Config File: use some options (e.g. user name, identity key and port), specified in *$HOME/.ssh/config* whenever possible, so there is no need to have the same SSH server configuration in multiple places.
13+
1114
# Use Cases
1215

1316
_...or why on Earth would I need something like this?_
@@ -175,7 +178,7 @@ DEBU[0000] tunnel: [local:127.0.0.1:8080, server:10.0.0.12:2222, remote:172.17.0
175178
INFO[0000] listening on local address local_address="127.0.0.1:8080"
176179
```
177180

178-
### Connect to a remote ip address 127.0.0.1 by specifying only the remote port
181+
### Connect to a remote service that is running on 127.0.0.1 by specifying only the remote port
179182

180183
```sh
181184
$ mole -v -local 127.0.0.1:8080 -remote :80 -server example1

0 commit comments

Comments
 (0)