diff --git a/README.md b/README.md index 7c4777e..c360e8a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # miniupnp-script A script to use miniupnpc to setup port forwarding for a homeserver + +## How to use ? + +Install the requirements by running: +```bash +pip install -r requirements.txt +``` + +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: +```yaml +service-name: + internal_port: 1234 + external_port: 5678 + protocol: 'TCP' +``` + +Once the config is filled accordingly you can execute the script with +```bash +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 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..8c13c2d --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +miniupnpc