hiro/autossh
1
0
Fork 0
mirror of https://github.com/vale981/autossh synced 2025-03-05 09:21:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

adds readme

Browse source
This commit is contained in:
Sam Eaton 2016-04-07 19:56:14 -06:00
parent 91b27e11bd
commit 9811a67d71
2 changed files with 62 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -1,2 +1,3 @@
node_modules
*.log
README.html

61
README.md Normal file
View file

@ -0,0 +1,61 @@
# autossh
Persistent SSH tunnels
### Install
Using npm
```
npm i -S autossh
```
### Usage
#### To Start
``` javascript
const autossh = require('autossh');
autossh({
host: '111.22.333.444',
username: 'root',
localPort: 64444,
remotePort: 5432
})
.on('error', err => {
console.error('ERROR: ', err);
})
.on('init', () => {
console.log('connected. Ready to do other stuff.');
});
```
...is equivalent to...
``` bash
ssh -NL 64444:localhost:5432 root@111.22.333.444
```
#### To Kill
The autossh process will automatically die if the node process is closed, but you can manually kill the process using `kill`.
**Example**
``` javascript
const myAutossh = autossh({
host: '111.22.333.444',
username: 'root',
localPort: 64444,
remotePort: 5432
})
.on('error', err => {
console.error('ERROR: ', err);
})
.on('init', () => {
console.log('connected. Ready to do other stuff.');
});
myAutossh.kill();
```