ssh_tunnel_proxy 1.2.1 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
# ssh_tunnel_proxy
|
|
2
2
|
Initiate a ssh reverse tunnel proxy with forwarding ports
|
|
3
3
|
|
|
4
|
-
ssh_tunnel_proxy can function as a stand-alone api, nodejs command line script or part of an electron_js app. To
|
|
5
|
-
|
|
6
|
-
If a ngrok api key is provided the ngrok api endpoint method is invoked to obtain the hostport of the tunnel. A list of port forwards is provided to the connect_api function and ports validated to restrict connections to system ports on the remote host to a set of pre-defined ports such as http,https. After establishing a ssh connection to the remote server, local proxy port forwards are opened. If the connection is interrupted then the ssh_connect method will attempt to re-establish the connection.
|
|
4
|
+
ssh_tunnel_proxy can function as a stand-alone api, nodejs command line script or as part of an electron_js app. To setup a ssh tunnel, parameters are suppled for host, port, authentication and a list of proxy ports. If a ngrok api key is provided the host and port of the ngrok tunnel are obtained. A list of port forwards is provided and is validated to restrict connections to system ports on the remote host to a list of pre-defined ports such as http or https. After establishing a ssh connection on the remote server, local proxy port forwards are opened. If the connection is interrupted or connection errors occur, attempts are made re-establish the tunnel.
|
|
7
5
|
|
|
8
6
|
Example command line usage:
|
|
9
7
|
|
|
@@ -31,11 +29,14 @@ config file, located at:
|
|
|
31
29
|
"ngrok_api": "<ngrok api key>"
|
|
32
30
|
}]
|
|
33
31
|
|
|
32
|
+
```
|
|
34
33
|
start tunnel with default config, located at ~/.config/ssh_tunnel_proxy/config.json
|
|
34
|
+
|
|
35
35
|
```
|
|
36
36
|
node main.js -c -d
|
|
37
|
+
```
|
|
37
38
|
|
|
38
|
-
The following code is an example of use of the api with electronjs and
|
|
39
|
+
The following code is an example of use of the api with electronjs and is to be installed in main.js, preload.js and the render process.
|
|
39
40
|
main.js:
|
|
40
41
|
```js
|
|
41
42
|
|