3.1.17 • Published 10 months ago

@libp2p/upnp-nat v3.1.17

Weekly downloads
-
License
Apache-2.0 OR MIT
Repository
github
Last release
10 months ago

@libp2p/upnp-nat

libp2p.io Discuss codecov CI

UPnP NAT hole punching

About

The service exported by this module attempts to configure NAT hole punching via UPnP.

This will make your node publicly accessible from the internet.

For this to work there are some prerequisites:

  1. Your router must have UPnP support enabled
  2. Your libp2p node must be listening on a non-loopback IPv4 address
  3. You must not be double-NATed by your ISP

Example

import { createLibp2p } from 'libp2p'
import { tcp } from '@libp2p/tcp'
import { uPnPNAT } from '@libp2p/upnp-nat'

const node = await createLibp2p({
  addresses: {
    listen: [
      '/ip4/0.0.0.0/tcp/0'
    ]
  },
  transports: [
    tcp()
  ],
  services: {
    upnpNAT: uPnPNAT()
  }
})

Example - Manually specifying gateways and external ports

Some ISP-provided routers are under powered and may require rebooting before they will respond to SSDP M-SEARCH messages.

You can manually specify your external address and/or gateways, though note that those gateways will still need to have UPnP enabled in order for libp2p to configure mapping of external ports (for IPv4) and/or opening pinholes in the firewall (for IPv6).

import { createLibp2p } from 'libp2p'
import { tcp } from '@libp2p/tcp'
import { uPnPNAT } from '@libp2p/upnp-nat'

const node = await createLibp2p({
  addresses: {
    listen: [
      '/ip4/0.0.0.0/tcp/0'
    ]
  },
  transports: [
    tcp()
  ],
  services: {
    upnpNAT: uPnPNAT({
      // manually specify external address - this will normally be an IPv4
      // address that the router is performing NAT with
      externalAddress: '92.137.164.96',
      gateways: [
        // an IPv4 gateway
        'http://192.168.1.1:8080/path/to/descriptor.xml',
        // an IPv6 gateway
        'http://[xx:xx:xx:xx]:8080/path/to/descriptor.xml'
      ]
    })
  }
})

Install

$ npm i @libp2p/upnp-nat

API Docs

License

Licensed under either of

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

3.0.2-f4747450f

1 year ago

3.1.0-96f14e429

1 year ago

3.1.7-0555339ba

1 year ago

3.1.16-dbbc6ef1d

10 months ago

3.1.7-e1f868f03

1 year ago

3.1.11-4f37aff53

12 months ago

3.0.4-f767126e1

1 year ago

3.1.2-68ad3663e

1 year ago

3.1.9-5fe2a18fc

1 year ago

3.1.16-8efb065d2

10 months ago

3.1.3

1 year ago

3.1.2

1 year ago

3.1.16-ec73d59a6

10 months ago

3.1.1

1 year ago

3.1.0

1 year ago

3.1.7

1 year ago

3.1.16-cc7b34c0f

10 months ago

3.1.6

1 year ago

3.1.2-23685db5e

1 year ago

3.1.5

1 year ago

3.1.4

1 year ago

3.0.5-bf0f74d66

1 year ago

3.1.9-0699fb747

1 year ago

3.1.13-213a54a1e

11 months ago

3.1.8-2fbcdb687

1 year ago

3.1.13-3577af88a

11 months ago

3.1.9

1 year ago

3.0.2-d3e5a3382

1 year ago

3.1.8

1 year ago

3.1.16-d91ae66c6

10 months ago

3.1.11-4c64bd06d

12 months ago

3.0.4

1 year ago

3.0.3

1 year ago

3.0.2

1 year ago

3.0.1

1 year ago

3.0.5

1 year ago

3.0.3-ae75570c8

1 year ago

3.0.0

1 year ago

3.1.1-f9345a7a1

1 year ago

3.0.5-66c3ec5e1

1 year ago

3.1.1-4ab04faf0

1 year ago

3.0.4-b56d91884

1 year ago

3.1.11-53a9be54e

12 months ago

3.0.5-d61cbacec

1 year ago

2.0.11

1 year ago

2.0.12

1 year ago

3.1.6-f465c5473

1 year ago

3.1.16-b32bc8406

10 months ago

3.1.13-3df5bf2da

11 months ago

3.1.7-22e62d00f

1 year ago

3.1.12-3833353bd

12 months ago

3.1.13-afa5c9f59

12 months ago

3.0.2-5acfae333

1 year ago

3.1.7-9acccaaed

1 year ago

3.0.0-127abe24b

1 year ago

3.1.0-7a1665cd8

1 year ago

3.0.3-abe9bd154

1 year ago

3.1.8-dd71d8a86

1 year ago

3.1.1-2e35b6055

1 year ago

3.1.0-6e52ee346

1 year ago

3.1.3-754fe84db

1 year ago

3.1.3-ff951f1a0

1 year ago

3.1.1-7655833bb

1 year ago

3.1.5-9b1a3791d

1 year ago

3.0.2-285dab7d7

1 year ago

3.1.16-6a3ae02f5

10 months ago

3.1.13-185b23eac

11 months ago

3.0.4-15a70af5f

1 year ago

3.1.6-90cca822b

1 year ago

3.0.5-26313e695

1 year ago

3.1.7-96f79bc11

1 year ago

3.1.13-a5a33afd9

11 months ago

3.1.11-71267286

1 year ago

3.0.4-c90984ec7

1 year ago

3.1.15-ab014c0c0

10 months ago

3.0.4-e2ec7bdaa

1 year ago

3.0.2-52f0f2f13

1 year ago

3.0.2-3c63482e5

1 year ago

3.1.0-34b3c14b8

1 year ago

3.1.9-88b5c29ed

1 year ago

3.0.5-c1d0b7fa4

1 year ago

3.1.1-d8f003e6e

1 year ago

3.1.3-8331c8ea8

1 year ago

3.1.16-307d0ba58

10 months ago

3.1.1-35a52f029

1 year ago

3.1.5-a4f0db1e9

1 year ago

3.1.16-bb4ad31db

10 months ago

3.1.13-772b4011e

11 months ago

3.1.16-9f1be6742

10 months ago

3.1.2-1fc0e2662

1 year ago

3.1.13-6f96de86c

12 months ago

3.1.16-3528df829

10 months ago

3.0.4-06fc82da8

1 year ago

3.0.1-5c4a79e5a

1 year ago

3.1.13-cdc63e6cc

11 months ago

3.1.14-aa25d38ab

11 months ago

3.1.15-7788b4025

10 months ago

3.1.4-d98cc46e4

1 year ago

3.1.4-2b49a5f74

1 year ago

3.1.16-b8600fce8

10 months ago

3.1.7-e2f49432b

1 year ago

3.1.13-32627c876

11 months ago

3.1.13-f1de46607

11 months ago

3.1.6-e7e01f58f

1 year ago

3.1.9-a6c9aee5a

1 year ago

3.1.7-4939ef7ae

1 year ago

3.0.2-023ea575c

1 year ago

3.1.8-80fe31aa1

1 year ago

3.0.4-4bbcfa707

1 year ago

3.0.4-fe8af37a1

1 year ago

3.0.4-723bde6ce

1 year ago

3.1.0-21088c519

1 year ago

3.0.3-20d9ba73e

1 year ago

3.1.6-6f8cfeafb

1 year ago

3.1.15-776cb432d

10 months ago

3.1.16-5b004c0c4

10 months ago

3.1.16-8e87be9e6

10 months ago

3.1.3-700e4c0b5

1 year ago

3.1.12-f09bef843

12 months ago

3.1.6-5b084e968

1 year ago

3.1.7-52a46ecad

1 year ago

3.1.11-da4e9da82

12 months ago

3.1.1-d188511b9

1 year ago

3.1.5-2a3cec922

1 year ago

3.1.3-cc7fcfe98

1 year ago

3.1.4-1ab50cc0d

1 year ago

3.1.1-c4e862731

1 year ago

3.1.2-b818882e0

1 year ago

3.1.12

12 months ago

3.1.11-da7353a0b

12 months ago

3.1.11

1 year ago

3.1.14

11 months ago

3.1.13

12 months ago

3.1.16

10 months ago

3.1.15

11 months ago

3.1.17

10 months ago

3.1.13-9b33d202e

11 months ago

3.1.10

1 year ago

3.0.5-80ddad5bb

1 year ago

3.1.12-b9e32cc37

12 months ago

3.1.4-7718d020a

1 year ago

3.1.16-2a7425cdb

10 months ago

3.1.16-14dbebea8

10 months ago

3.1.9-600d0a561

1 year ago

3.1.8-48cd9b652

1 year ago

3.1.0-d72b51184

1 year ago

3.1.8-2c8ecb455

1 year ago

3.1.2-e7e280257

1 year ago

3.1.8-3f127b610

1 year ago

3.1.13-4b8c0a6bd

11 months ago

3.1.7-3d9b07c34

1 year ago

2.0.10

1 year ago

2.0.9-a657bbd2e

1 year ago

2.0.9-d34642db1

1 year ago

2.0.9-7383821e1

1 year ago

2.0.9-717731e49

1 year ago

2.0.8-3bc9769b8

1 year ago

2.0.8-3244ed086

1 year ago

2.0.9

1 year ago

2.0.8-aa8de9fd3

1 year ago

2.0.8-4521cf1f7

1 year ago

2.0.8-75301ac7d

1 year ago

2.0.8-e6b4158c6

1 year ago

2.0.5-a390db4a4

2 years ago

2.0.6-58784abf7

2 years ago

2.0.6-27b2fa6b6

1 year ago

2.0.6-b4f02a637

1 year ago

2.0.6-d9c7e0f7e

2 years ago

2.0.6-35b48025c

2 years ago

2.0.7-0d326d102

1 year ago

2.0.6-32c176fd5

2 years ago

2.0.7-e99e8f448

1 year ago

2.0.8-5d199f9b6

1 year ago

2.0.7-d7a818e8e

1 year ago

2.0.7

1 year ago

2.0.6

2 years ago

2.0.8

1 year ago

2.0.6-24fa1d5af

2 years ago

2.0.7-934a891f9

1 year ago

2.0.5-82bd42bcf

2 years ago

2.0.6-661d6586a

1 year ago

2.0.5-dad979f9b

2 years ago

2.0.6-80e798cdc

1 year ago

2.0.7-d4da56961

1 year ago

2.0.4-c5988cce8

2 years ago

2.0.4-fa83ee1c7

2 years ago

2.0.5

2 years ago

2.0.4-980038477

2 years ago

2.0.4-0c5957836

2 years ago

2.0.3-c258b35af

2 years ago

2.0.2-7f7ec82ae

2 years ago

2.0.2-b3272cfce

2 years ago

2.0.3

2 years ago

2.0.4

2 years ago

2.0.1-21fe841f2

2 years ago

2.0.2

2 years ago

2.0.1-c628c44c5

2 years ago

2.0.1-6ccbb06f0

2 years ago

2.0.1-4fd7eb2e1

2 years ago

2.0.1-34455b5f2

2 years ago

2.0.1

2 years ago

2.0.0-18dd3cb26

2 years ago

2.0.0-1210884ed

2 years ago

1.2.5-81ebe4e47

2 years ago

1.2.5-c010d575c

2 years ago

1.2.5-71e5f7a5b

2 years ago

1.2.5-e1ca9cced

2 years ago

1.2.5-5214dec4a

2 years ago

2.0.0-d101aac4b

2 years ago

2.0.0

2 years ago

1.2.5-2bbaf4361

2 years ago

1.2.5-a142bb642

2 years ago

2.0.0-7cd984569

2 years ago

1.2.5-b6681bd25

2 years ago

1.2.5-df330695a

2 years ago

1.2.5-dd7b329c4

2 years ago

1.2.5-2265e59ba

2 years ago

1.2.5-737b3ea5b

2 years ago

1.2.5-1675adee2

2 years ago

1.2.5-50b897139

2 years ago

1.2.5-e211b46cc

2 years ago

1.2.5-7655e5200

2 years ago

1.2.1-d1aec4d9f

2 years ago

1.1.0-8e4fdcde9

2 years ago

1.1.0-d1f1c2be7

2 years ago

1.0.22-169c9d85e

2 years ago

1.0.22-90d10b565

2 years ago

1.0.22-6011d3697

2 years ago

1.0.22-e69a2f1b6

2 years ago

1.1.0-9e0236627

2 years ago

1.2.0-0b55625d1

2 years ago

1.2.4-0edbfe7af

2 years ago

1.1.0-44791342

2 years ago

1.2.0-15eb66428

2 years ago

1.2.2-928801a80

2 years ago

1.0.22-769461d3b

2 years ago

1.2.1-151bc46fb

2 years ago

1.2.5-3c8dd5bbf

2 years ago

1.2.4-c5dba70a9

2 years ago

1.0.22-757fb2674

2 years ago

1.2.0-af85a7cad

2 years ago

1.2.2-73f2b6b6d

2 years ago

1.2.1-e1f0b307c

2 years ago

1.0.22-167bf2b3c

2 years ago

1.2.2-a8ec2bcb7

2 years ago

1.2.3-944935f8d

2 years ago

1.2.0

2 years ago

1.2.5

2 years ago

1.2.4

2 years ago

1.2.3

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.0.22-352699ab5

2 years ago

1.2.4-1dfb74e79

2 years ago

1.2.1-e9b6a242a

2 years ago

1.2.2-a130993ed

2 years ago

1.2.0-b0b6cae12

2 years ago

1.0.22-f6fe2cc3c

2 years ago

1.0.22-4bd8e4f79

2 years ago

1.1.0

2 years ago

1.2.0-3b9cbf7d8

2 years ago

1.0.22-440c9b360

2 years ago

1.0.22-f4e572cd6

2 years ago

1.1.0-94cac115a

2 years ago

1.2.5-359265a3a

2 years ago

1.0.22-62e32252a

2 years ago

1.2.0-abb9f90c7

2 years ago

1.2.2-34cf1f7cd

2 years ago

1.2.3-f30e2ee8d

2 years ago

1.2.4-7939dbd5c

2 years ago

1.2.2-40902d99b

2 years ago

1.0.22-7aec7bd45

2 years ago

1.0.22-12106b5b0

2 years ago

1.2.2-8b3114292

2 years ago

1.2.0-21cf7bc56

2 years ago

1.1.0-863b3de03

2 years ago

1.2.1-3319ff41e

2 years ago

1.2.2-4a994c5ef

2 years ago

1.0.22-7464dc00c

2 years ago

1.2.1-ce6da9896

2 years ago

1.2.0-6573cb8b0

2 years ago

1.2.2-a82ff8221

2 years ago

1.0.22-bc6556f96

2 years ago

1.0.22

2 years ago

1.0.21-1a41c28bb

2 years ago

1.0.21-8214dcfb0

2 years ago

1.0.21-48444f750

2 years ago

1.0.21-1cc6a9405

2 years ago

1.0.21-5b7380259

2 years ago

1.0.21-1cd5aae11

2 years ago

1.0.21-7de56f244

2 years ago

1.0.21-a3e8beabd

2 years ago

1.0.21-1eb5b2713

2 years ago

1.0.21

2 years ago

1.0.21-3c73707ff

2 years ago

1.0.20-9d4b0596f

2 years ago

1.0.20-43046b9ae

2 years ago

1.0.20-83c14d08f

2 years ago

1.0.20-7ae6063df

2 years ago

1.0.20-1488a7371

2 years ago

1.0.20-767b23e71

2 years ago

1.0.20-bfa7660d5

2 years ago

1.0.20-510d9ce65

2 years ago

1.0.20-4ad63bb79

2 years ago

1.0.20-d9366f9aa

2 years ago

1.0.20-a11e135c2

2 years ago

1.0.19-de3f7aeaf

2 years ago

1.0.20-9d13a2f6a

2 years ago

1.0.20

2 years ago

1.0.19-3d7a9da17

2 years ago

1.0.19-3bc94b403

2 years ago

1.0.19-c82432312

2 years ago

1.0.19-998fcaf94

2 years ago

1.0.19-e1923b0a7

2 years ago

1.0.19-90cfd25e2

2 years ago

1.0.19

2 years ago

1.0.18-c2181f0cf

2 years ago

1.0.18-2281f802b

2 years ago

1.0.18-fd1f8343d

2 years ago

1.0.18-eaf8ac7cf

2 years ago

1.0.18-acef72613

2 years ago

1.0.18-ea4f26285

2 years ago

1.0.18

2 years ago

1.0.17-31c78f4ed

2 years ago

1.0.17-08dabd390

2 years ago

1.0.16-b17824a1d

2 years ago

1.0.16-2c56203f9

2 years ago

1.0.17

2 years ago

1.0.16-936dbba10

2 years ago

1.0.16-732c436d4

2 years ago

1.0.16-2b2958fe6

2 years ago

1.0.16

2 years ago

1.0.15-3e515f007

2 years ago

1.0.15-d446c6c31

2 years ago

1.0.15-a2b41f793

2 years ago

1.0.15-ab5f05763

2 years ago

1.0.15-80278b36b

2 years ago

1.0.15-3ffecc5bf

2 years ago

1.0.15-afe15f669

2 years ago

1.0.15-4fc0a7d30

2 years ago

1.0.15-1f589c822

2 years ago

1.0.14-59a97b61b

2 years ago

1.0.14-1fc929c1c

2 years ago

1.0.14-330a5ed72

2 years ago

1.0.14-bf720c045

2 years ago

1.0.14-82901e785

2 years ago

1.0.15

2 years ago

1.0.14-e1798aa26

2 years ago

1.0.14-cad9cf007

2 years ago

1.0.14-f39ce5f13

2 years ago

1.0.14-fad3074b8

2 years ago

1.0.14-83ef3717e

2 years ago

1.0.14-ab466004b

2 years ago

1.0.14-a9cc0ee49

2 years ago

1.0.14-2122a713d

2 years ago

1.0.14-28e51652a

2 years ago

1.0.14-f71bc49bd

2 years ago

1.0.14

2 years ago

1.0.13-f0d2b52d0

2 years ago

1.0.13-8072a2e59

2 years ago

1.0.13-b1b77adb4

2 years ago

1.0.13-e1c01370b

2 years ago

1.0.13-bedfd0aa2

2 years ago

1.0.13-fb7c51c3c

2 years ago

1.0.11-9891ecd73

2 years ago

1.0.11-0321812e7

2 years ago

1.0.11-2370d1c39

2 years ago

1.0.12-0c7bbbb07

2 years ago

1.0.11-dab5cf724

2 years ago

1.0.11-03ff9fd82

2 years ago

1.0.11-1cb2408ac

2 years ago

1.0.13

2 years ago

1.0.12

2 years ago

1.0.11-e1db332a4

2 years ago

1.0.11-6f323de7d

2 years ago

1.0.11-c9ed1c7d6

2 years ago

1.0.10-72f0e09f7

2 years ago

1.0.10-f4dda4a3c

2 years ago

1.0.10-74fb5671d

2 years ago

1.0.10-2e464c099

2 years ago

1.0.11

2 years ago

1.0.10-dbc92ab74

2 years ago

1.0.10-08f6f607d

2 years ago

1.0.10-9376e61a1

2 years ago

1.0.10-74477f6ea

2 years ago

1.0.10-3e47d88fd

2 years ago

1.0.10-8c6654c3a

2 years ago

1.0.10-f27138ca1

2 years ago

1.0.9-092861e23

2 years ago

1.0.10

2 years ago

1.0.8-856ccd708

2 years ago

1.0.9

2 years ago

1.0.9-8bbd43628

2 years ago

1.0.8-ddaa59a60

2 years ago

1.0.8-4691f4173

2 years ago

1.0.8-ee7ffe9b9

2 years ago

1.0.8-821a38e24

2 years ago

1.0.8-900236724

2 years ago

1.0.8

2 years ago

1.0.7-528d73781

2 years ago

1.0.7-d011f6130

2 years ago

1.0.7-581574d6d

2 years ago

1.0.7-444d83751

2 years ago

1.0.7-388d02b33

2 years ago

1.0.7-ba7089984

2 years ago

1.0.7

2 years ago

1.0.6-28587d24f

2 years ago

1.0.6-5d1f68e92

2 years ago

1.0.6-4e0135c7d

2 years ago

1.0.6-c00378909

2 years ago

1.0.6-cd8cafcd5

2 years ago

1.0.6-6fd681d09

2 years ago

1.0.6-178fe2671

2 years ago

1.0.6-83dfc7dc8

2 years ago

1.0.6

2 years ago

1.0.5-f71f2e14e

2 years ago

1.0.5-984f13e42

2 years ago

1.0.5-07f3afe2d

2 years ago

1.0.5-ad6f70bf3

2 years ago

1.0.5-9eff7eff0

2 years ago

1.0.5-a7c6a93c6

2 years ago

1.0.5-230afea4b

2 years ago

1.0.5-f81be145a

2 years ago

1.0.5-01e9a5fe4

2 years ago

1.0.5

2 years ago

1.0.5-742915567

2 years ago

1.0.4-341581166

2 years ago

1.0.4-6d11e8268

2 years ago

1.0.3-d10506189

2 years ago

1.0.4

2 years ago

1.0.3-64a915ae9

2 years ago

1.0.3-3bf6387ff

2 years ago

1.0.3-93890c8f9

2 years ago

1.0.3-16588d27c

2 years ago

1.0.3-887c6ffe1

2 years ago

1.0.3-bcfa15993

2 years ago

1.0.3-10ea19700

2 years ago

1.0.3-09dd02987

2 years ago

1.0.3-5a9362e21

2 years ago

1.0.3

2 years ago

1.0.2-738dd40f1

2 years ago

1.0.2

2 years ago

1.0.1-7861ed882

2 years ago

1.0.1-9197f10ba

2 years ago

1.0.1-e7167fe52

2 years ago

1.0.1-f537b3731

2 years ago

1.0.1-8c169db1b

2 years ago

1.0.1-561797a89

2 years ago

1.0.1-cf963694f

2 years ago

1.0.1-bca8d6e68

2 years ago

1.0.1

2 years ago

1.0.1-53224004f

2 years ago

1.0.0-273d8177c

2 years ago

1.0.1-6c1f0ee81

2 years ago

1.0.0-a32e70bac

2 years ago

1.0.0-06e6d235f

2 years ago

1.0.0-bcf18265e

2 years ago

1.0.0-8e4fbe13a

2 years ago

1.0.0-7682861f9

2 years ago

1.0.0-551622a96

2 years ago

1.0.0

2 years ago

0.0.0-8f921ee97

2 years ago

0.0.0-74e84bc29

2 years ago

0.0.0-8bb6d5333

2 years ago

0.0.0-7877a50e0

2 years ago

0.0.0-68db79f6b

2 years ago

0.0.0-e2267d437

2 years ago

0.0.0-4a474d54d

2 years ago

0.0.0-0b4a2ee79

2 years ago

0.0.0-6b6ba9ab7

2 years ago

0.0.0-d729d66a5

2 years ago

0.0.0-bb6ceb192

2 years ago

0.0.0-d8f5bc211

2 years ago

0.0.0-13a870cbe

2 years ago

0.0.0-3dee5df4d

2 years ago

0.0.0-adea7bbbf

2 years ago

0.0.0-6625a27fc

2 years ago

0.0.0-9c67c5b3d

2 years ago

0.0.0-05b52d69c

2 years ago

0.0.0-97ab31c0c

2 years ago

0.0.0

2 years ago