kad-traversedeprecated

nat traversal extension for kad

Usage no npm install needed!

<script type="module">
  import kadTraverse from 'https://cdn.skypack.dev/kad-traverse';
</script>

README

Kad Traverse

Build Status Coverage Status NPM

NAT traversal extension for Kad.

Usage

Install kad-traverse with NPM.

npm install kad-traverse --save

Register the desired traversal strategy plugins in the order you wish to attempt them. If one succeeds, then strategies registered after will not execute.

const kad = require('kad');
const traverse = require('kad-traverse');
const node = kad({ /* options */ });

node.plugin(traverse([
  new traverse.UPNPStrategy(/* options */),
  new traverse.NATPMPStrategy(/* options */),
  new traverse.ReverseTunnelStrategy(/* options */)
]));

node.listen(8080); // will try strategies after binding

Strategies

License

Kad Traverse - NAT traversal plugins for Kad
Copyright (C) 2017 Gordon Hall

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.