mahmad/local-etc-hosts-updater
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add Readme

Browse source
This commit is contained in:
Muaz Ahmad 2024-05-13 14:17:53 +05:00
parent 56ba739871
commit b1bdd346b3
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md Normal file
View file

@ -0,0 +1,22 @@
# local-etc-hosts-updater
Queries the mDNS record for a given .local address, and maps it to the given subdomains inside a hosts file
## Usage
### CLI Args
`local-etc-hosts-updater <local_domain> <ip_version> <interface>`
- `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
- `interface` is the interface name to query, it is required for ipv6
### 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