Skip to content

Commit 7a6a8e9

Browse files
committed
Update upnp docs
1 parent be1143d commit 7a6a8e9

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

source/_components/upnp.markdown

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,34 @@ To integrate this into Home Assistant, add the following section to your `config
2323
```yaml
2424
# Example configuration.yaml entry with custom external portal
2525
upnp:
26-
external_port: 80
26+
ports:
27+
hass: 8000
28+
8080: 8080
2729
```
2830
2931
If you which to have the statistics without having port mapping done through IGD, add the option **port_mapping**.
3032
3133
Configuration variables:
3234
33-
- **external_port** (*Optional*): Expose Home Assistant to the internet over this TCP port. Defaults to Home Assistant configured port.
34-
- **port_mapping** (*Optional*): Disables port mapping maintains the network statistics sensors)
35-
- **unit** (*Optional*): UPnP sensors unit. Valid units are 'Bytes', 'KBytes', 'MBytes' and 'GBytes'.
35+
{% configuration binary_sensor.template %}
36+
ports:
37+
description: Map of ports to map from internal to external. Pass 'hass' as internal port to use the port Home Assistant runs on.
38+
required: false
39+
type: map
40+
default: open same port on external router as that HASS runs locally and forwards it.
41+
port_mapping:
42+
description: If the component should try to map ports.
43+
required: false
44+
type: boolean
45+
default: false
46+
units:
47+
description: Define the units used for the UPNP sensor. Possible values are Bytes, KBytes, MBytes, GBytes.
48+
required: false
49+
type: string
50+
default: Mbytes
51+
local_ip:
52+
description: The local IP address of the computer running Home Assistant.
53+
required: false
54+
type: string
55+
default: Try to auto-detect IP of host.
56+
{% endconfiguration %}

0 commit comments

Comments
 (0)