local-etc-hosts-updater/README.md

25 lines
840 B
Markdown
Raw Normal View History

2024-05-13 14:17:53 +05:00
# local-etc-hosts-updater
Queries the mDNS record for a given .local address, and maps it to the given subdomains inside a hosts file
2024-05-21 14:07:09 +05:00
Linux >5.1 only due to SO_BINDTOIFINDEX socket option.
2024-05-13 14:17:53 +05:00
## Usage
### CLI Args
2024-05-18 00:03:16 +05:00
`local-etc-hosts-updater <local_domain> <ip_version> <scope_id>`
2024-05-13 14:17:53 +05:00
- `local_domain` is the local domain to be queried
- `ip_version` is an enum.
- 4 will query for an IPv4 address in the `192.168.0.0/16` subnet
- 6 will query for a ULA IPv6 address in the `fd00::/8` subnet
- 0 will do both
2024-05-21 14:07:09 +05:00
- `scope_id` is either the name of the interface, or the corresponding numeric interface index. The index is largely for unrooted android limitations.
2024-05-13 14:17:53 +05:00
### ENV vars
- `OLD_HOSTS_PATH` path to the current hosts file
- `TARGET_DOMAIN` public domain for the subdomains
- `SUBDOMAIN_LIST` space separated list of subdomains to map