Updated 2019-10-14

UPnP

Enable UPnP to quickly allow inbound peer connections without manual router configuration. Use UPnP in home or small office environments where a wireless router or modem provides NAT isolation.

UPnP automatically detects that a node is running in a UPnP environment and provides port forwarding.

Tip

UPnP support is often disabled by default in networking firmware. If disabled by default, explicitly enable UPnP support.

Enabling UPnP

Use the --nat-method command line option to enable UPnP.

Notes

  • Option UPNP might introduce delays during node startup, especially on networks where no UPnP gateway device can be found.
  • --nat-method cannot be used with the Besu Docker image.

When UPnP is enabled:

  • Enode advertised to other nodes during discovery is the external IP address and port.
  • External address and port are returned by the admin_NodeInfo JSON-RPC API method for the enode and listenAddr properties.

While Hyperledger Besu is running, UPnP does not support:

  • IP address changes
  • Disabling UPnP. To disable UPnP, restart the node without the --nat-method option or set to NONE.