Skip to content

Commit

Permalink
docs: added documentation on new environment variable
Browse files Browse the repository at this point in the history
  • Loading branch information
Tbaile committed Jan 7, 2025
1 parent f3e4acf commit b403a3c
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The module provides the following API endpoints:
- `configure-module`: Configure the module
- `get-configuration`: Get the module configuration active
- `get-dns-records`: Get all the manual DNS records
- `set-dns-records`: Set the the DNS records
- `set-dns-records`: Set the DNS records
- `get-leases`: Get the DHCP leases active


Expand Down Expand Up @@ -151,6 +151,17 @@ api-cli run module/<module-id>/get-leases
}
```

## Restore public interfaces

When installing the module from the version `1.2.0` and above, the module will hide the interfaces that have public IP
addresses from the picker in the configuration. This is done to avoid the user to select an interface that is not
meant to be used for DHCP and local DNS services. The list of the possibles IPs that are marked as global is taken
from the [IANA specs](https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml)
used by Python `ipaddress` module.

To restore the old behavior and show all the interfaces in the picker, you can either remove the
`DNSMASQ_STRICT_INTERFACE_VALIDATION` environment variable from the module environment or set it to `0`.

## Uninstall

To uninstall the instance:
Expand Down

0 comments on commit b403a3c

Please sign in to comment.