hero-masq

Copyright 2020 Drew Foehn drew@foe.hn License: MIT

Lightweight web frontend for dnsmasq.

Built with Next.js, Apollo GraphQL, React and Material Ui

To test locally:

git clone https://github.com/pixeldrew/hero-masq.git
cd hero-masq/
cp .env.default .env
npm install
npm run dev

ENV Options are as follows:

PORT=3000 # port to access webapp
USER_NAME=admin #admin username
PASSWORD=dnsMasq01 #admin password
JWT_SECRET=auniquetokenmakeitcomplex123 #jwt encoding token, keep this secret
HOST_IP=192.168.0.2/24 # host ip
ROUTER_IP=192.168.0.1 # gateway ip to send to DHCP clients
DNSMASQ_CONF_LOCATION="/usr/local/etc/dnsmasq.d/" # location to save configuration
SERVICE_MANAGER=service # supports "service" for freebsd/debian installs or the docker controller "supervisor"
DNS=1.1.1.1 # upstream dns server used by dnsmasq

How This Works

Dnsmasq should be running on the host you're running the frontend from.

Dnsmasq configuration is written to ${DNSMASQ_CONF_LOCATION}/hero-masq.conf. The dnsmasq service is then restarted. In order for this to work, make sure you have correctly configure the env property SERVICE_MANAGER, also the default dnsmasq.conf should have a conf-dir line like this:

conf-dir=/etc/dnsmasq.d,*.conf

Docker

A standalone docker image with dnsmasq has been created. If you want dnsmasq to give dhcp replies it requires the docker container to have it's network to be configured as host. See the docker-compose.yml example for more advanced example like using a dns-crypt proxy as the upstream dns server. From 1.0.4 builds for pixeldrew/hero-masq are being made for both armv7 and amd64.

To run in docker:

# docker run --name hero-masq_hero-masq_1 --network=host --cap-add=NET_ADMIN -P -e ROUTER_IP=192.168.0.1 -e PASSWORD=adminpassword -e JWT_SECRET=somethingrandom -e HOST_IP=192.168.0.2/24 -d pixeldrew/hero-masq

Docker-compose (make sure you update the environment section in the supplied docker-compose.yml to match yours)

# docker-compose up --build

If you're not running in Docker, I suggest running this in an iocage or something similar as root permissions are needed to write dnsmasq configs and to reload the configs.

Why?

I built this when I found out my new router couldn't run DD-WRT and only had a DHCP server with no integragated DNS. I like having a local dns so I have user friendly machine name access.

Future

See .plan if you're looking to help out