Clone or download
Latest commit 2f204df Jun 19, 2018

UPnP PortMapper

Build Status Download UPnP PortMapper

UPnP PortMapper is an easy to use program that manages the port mappings (port forwarding) of a UPnP enabled internet gateway device (router) in the local network. You can easily view, add and remove port mappings.

Using port forwarding, it is possible to access servers (SSH, Web, Game servers, ...) running in a private network from the internet. Port mappings can be configured using the web administration interface of a router, but using the UPnP PortMapper is much more convenient: Just create a new preset or select an existing preset and click one button to add a port mapping for your current computer, the IP address is retrieved automatically!

The interface is written in English and German. PortMapper automatically selects the language according your operating system.


Download UPnP PortMapper

Download binaries from SourceForge. UPnP PortMapper requires JRE 8 (Java Runtime Environment) or later. You can download it at A JDK is only required for development.


To run PortMapper, double click on the JAR file or run

$ java -jar portmapper.jar

on the command line.



  • Update the firmware of your router to the latest version.

Router not found

  • Check if UPnP is activated in your router's settings.
  • Use a different UPnP library in the settings. Please note that DummyRouterFactory is just for testing.
  • Set Log level to TRACE in the settings, connect again and check the log.

Manually specify location URL

If you can connect to your router from one device but not from another you can directly specify the location URL.

Note: this is only supported for library weupnp (-lib org.chris.portmapper.router.weupnp.WeUPnPRouterFactory).

  1. Get location URL on the machine that can connect to the router by clicking the Info button (look for something like INFO - location =
  2. Specify the location URL as a command line argument:
$ java "-Dportmapper.locationUrl=<locationurl>" -jar portmapper.jar -lib org.chris.portmapper.router.weupnp.WeUPnPRouterFactory <args>

Adding port forwardings not possible

  • Check that your router allows write access via UPnP.
  • Try to add port forwardings manually via your router's user interface.
  • Use a different UPnP library in the settings. Please note that DummyRouterFactory is just for testing.

Known issues

  • Under Ubuntu Linux it is not possible to retrieve the IP address of the local host, the address must be entered manually.

Command line interface

PortMapper also has a command line interface. You can see the available options by adding parameter -h:

$ java -jar portmapper.jar -h
 -add                  : Add a new port mapping
 -delete               : Delete a new port mapping
 -description VAL      : Description of the port mapping
 -externalPort N       : External port of the port mapping
 -gui                  : Start graphical user interface
 -h (-help)            : Print usage help
 -info                 : Print router info
 -internalPort N       : Internal port of the port mapping
 -ip VAL               : Internal IP of the port mapping (default: localhost)
 -lib VAL              : UPnP library to use
 -list                 : Print existing port mappings
 -protocol [TCP | UDP] : Protocol of the port mapping
 -routerIndex N        : Router index if more than one is found (zero-based)


  • Create a new port mapping for a specific IP address
$ java -jar portmapper.jar -add -externalPort <port> -internalPort <port> -ip <ip-addr> -protocol tcp
  • Create a new port mapping for the local machine (just omit the IP)
$ java -jar portmapper.jar -add -externalPort <port> -internalPort <port> -protocol tcp
  • Delete a port forwarding
$ java -jar portmapper.jar -delete -externalPort <port> -protocol tcp
  • List existing port forwardings
$ java -jar portmapper.jar -list
  • Specify a UPnP library (see below for available libraries)
$ java -jar portmapper.jar -lib org.chris.portmapper.router.weupnp.WeUPnPRouterFactory -list

UPnP libraries

PortMapper includes three third party UPnP libraries. If the default does not work for your device, try using a different library.

  • Cling: org.chris.portmapper.router.cling.ClingRouterFactory (default)
  • weupnp: org.chris.portmapper.router.weupnp.WeUPnPRouterFactory
  • SBBI UPnP lib: org.chris.portmapper.router.sbbi.SBBIRouterFactory
  • org.chris.portmapper.router.dummy.DummyRouterFactory (for testing only)

Select language

PortMapper is translated to English (en) and German (de). It automatically detects the operating system's language using English as default. If you want use a different language, add command line option -Duser.language=de to java, e.g.:

$ java -Duser.language=de -jar portmapper.jar


Build PortMapper on the command line:

$ git clone
$ cd portmapper
$ ./gradlew build
$ java -jar build/libs/portmapper-*.jar

Generate license header for added files

$ ./gradlew licenseFormat


Your feedback is most welcome at the project page:

  • Found a bug? Create an issue!
  • Miss some important feature? Create an issue!
  • Need help using the UPnP PortMapper? Post a message in the Forum!
  • Want to help with developing? Contact me via!
  • Want to send me a mail? Use christoph at!