Skip to content

Latest commit

 

History

History
149 lines (89 loc) · 7.89 KB

README.md

File metadata and controls

149 lines (89 loc) · 7.89 KB
Raw

Lightweight DCHPv6 service

A dnsmasq docker image pre-configured for a lightweight DHCPv6 service usage. Using webproc as light WebUI.

Docker Image Version Docker Image Size Build Status License

About

It started with a statement, a lack of features with internet home magic boxes. A lot of providers are offering IPv6. A good thing. But it's only designed to work for websurfing, with a classical SLAAC autoconfiguration into subnet announced by RA, sometimes with the possibility to customize RDNSS options with your own-selected DNS instead of ISP provided ones. Also, and unfortunately eachtime, there is no way to set static IPv6 definitions in a centralized way (aka DHCPv6).

A very useful feature when you're using a local DNS for your local network's devices :). That's why, with this (packaged) DHCPv6 service you should be able to overcome this lack of feature. Just drop it in your network, and that's it.

Another important point: with DHCPv6, you are mastering your IPv6 assignation policy. As you should know, SLAAC is suffering of some well-known flaws regarding IPv6 autoconfiguration. Some of devices are still generating theirs own IPv6 addresses using the deprecated RFC 8064, RFC 4862 (aka autoconfiguration based on MAC address (EUI-64)), and this is a kind of privacy issue we don't really like when going on internet!

Usage scenario

As said, this image is useful for home networks.

Your ISP home box-modem-router-whatyouwant is only giving you DHCPv4 service and you want DHCPv6 service for the reasons spelt out above, in order to be a good nerd using a full dual stack IPv4/IPv6 network at home. Let your magic router manage DHCPv4, it's an out of the box service (no need to be touched -> KISS principle \o/), and deploy this docker image on your NAS, Raspberry Pi, or home-hosted server to get DHCPv6. Why don't use dnsmasq features to totally manage DHCPv4 AND DHCPv6? You can. But in my opinion, it's no more KISS. Why? Imagine that your docker hosting server is down, then no more IPv4 is served to your devices, and you feel annoyed to no more access the internet. So let the router manage IPv4, and deploy this docker image for DHCPv6. At least without DHCPv6, SLAAC remains.

Obviously, this docker image can be set up as you want in order to follow your needs: it's only dnsmasq.

Run

  1. Get the image:

    docker pull styx0x6/dhcpv6

  2. Run a container:

    docker run --name dhcpv6 -d --restart always --cap-add=NET_ADMIN -p 6789:6789/tcp -p 547:547/udp -v <VOLUME_DNSMASQ>/log/dnsmasq.log:/var/log/dnsmasq.log -v <VOLUME_DNSMASQ>/dnsmasq.d/:/etc/dnsmasq.d/ [-e "WP_MAX_LINES=<WP_MAX_LINES>"] [-e "DNSMASQ_LOG=<DNSMASQ_LOG>"] [-e "HTTP_USER=<HTTP_USER>"] [-e "HTTP_PASS=<HTTP_PASS>"] styx0x6/dhcpv6

    where:

    • <VOLUME_DNSMASQ>, the set volume for your container into your running environment.

    optional:

    • <WP_MAX_LINES>, the maximum number of log lines to show in WebUI. Default is 5000.
    • <DNSMASQ_LOG>, the dnsmasq log facility. log-facility= directive in dnsmasq.conf. Default is /var/log/dnsmasq.log. To send logging to stdout you can set it to - .i.e. -e "DNSMASQ_LOG=-".

    optional, only if you want to use basic authentication for webproc (these env var are directly used by webproc):

    • <HTTP_USER>, username.
    • <HTTP_PASS>, password. Take care, it's a basic feature, your password will not be stored securely.

  3. Manage it via http://<docker_host>:6789:

webproc

Build

  • Get the code:

    git clone https://github.com/styx0x6/dhcpv6

  • Build your own docker image:

    docker build -t dhcpv6 .

Configuration files

dnsmasq configuration files

Static files that should not be modified:

  • /etc/default/dnsmasq used to launch the dnsmasq service.
  • /etc/dnsmasq.conf the default dnsmasq configuration file, only used to load *.conf files under /etc/dnsmasq.d/.
  • /etc/dnsmasq.d/0.service.conf used to configure the DHCPv6 service.

User configuration files:

  • /etc/dnsmasq.d/1.dhcpv6.conf used to define the DHCPv6 configuration for your networks. You can find here filtered-out options to set in this file or the full official dnsmasq.conf example.

As this Docker image is nothing else than a dnsmasq packaging, it works obviously also with IPv4 definitions.

dnsmasq official documentation

Helpful resources:

Links

Changelog

All details are here: [CHANGELOG]

Contributing

Feel free to submit issues and enhancement via pull requests!

[Bugs & Support]
[How to contribute to a project on Github] by Marc Diethelm.

Third-Party Tools

This docker image is based on Jaime Pillora's work:

https://github.com/jpillora/docker-dnsmasq https://hub.docker.com/r/jpillora/dnsmasq

This Docker image includes bundled packages and below are their associated licensing terms:

Other used stuff: