No description
Find a file
Polarolouis aa42f6ea1f
Filling the README
Added an how to use and Upcoming features to the readme.
2022-09-14 16:11:36 +02:00
config.example.yaml Added instructions in the config file and set up the UPnP to work 2022-09-14 15:50:34 +02:00
port-forwarder.py Added instructions in the config file and set up the UPnP to work 2022-09-14 15:50:34 +02:00
README.md Filling the README 2022-09-14 16:11:36 +02:00

miniupnp-script

A script to use miniupnpc to setup port forwarding for a homeserver

How to use ?

Fill in the configuration file : config.yaml. An example config is provided as config.example.yaml.

To declare a port forwarding use the following syntax:

service-name:
  internal_port: 1234
  external_port: 5678
  protocol: 'TCP'

Once the config is filled accordingly you can execute the script with

python3 port-forwarder.py

Upcoming features

  • Possibility to choose to activate one by one the services. Like:
OPEN 1234 -> 5678 by TCP for service-name ? (y/N)
  • Possibilty to choose to close one by one the services. Like:
CLOSE 1234 -> 5678 by TCP for service-name ? (y/N)
  • A -y to say yes to all
  • Have a list of the UPnP forwarding opened by the script