incremental update

This commit is contained in:
AJ ONeal 2015-12-30 23:13:06 +00:00
parent a220461b44
commit 9de7d807d2
1 changed files with 36 additions and 7 deletions

View File

@ -30,7 +30,9 @@ npm install --global holepunch
npm install --save holepunch npm install --save holepunch
``` ```
## Commandline (CLI) ## Examples
### Commandline (CLI)
```bash ```bash
holepunch --help holepunch --help
@ -40,6 +42,39 @@ holepunch --help
holepunch --plain-ports 80,65080 --tls-ports 443,65443 holepunch --plain-ports 80,65080 --tls-ports 443,65443
``` ```
### API
```javascript
var punch = require('holepunch');
punch({
debug: true
, plainPorts: [{ internal: 80, external: 80 }]
, tlsPorts: [{ internal: 443, external: 443 }]
, ipifyUrls: ['api.ipify.org'],
, protocols: ['none', 'upnp', 'pmp']
, rvpnConfigs: []
}).then(function () {
});
```
## API
```javascript
punch(opts)
debug // print extra debug info
tcpPorts // these ports will be tested via tcp / http
tlsPorts // these ports will be tested via tls / https
udpPorts // not implemented, not tested
loopback // test ports via http / https
```
## Commandline
TODO `--prebound-ports 22` TODO `--prebound-ports 22`
``` ```
@ -68,12 +103,6 @@ Options:
-h, --help Display help and usage details -h, --help Display help and usage details
``` ```
## API
```javascript
var punch = require('holepunch');
```
## Non-Root ## Non-Root
You **do not need root** to map ports, but you may need root to test them. You **do not need root** to map ports, but you may need root to test them.