README
¶
docker-net-dhcp
A Docker network plugin that allocates container IP addresses (IPv4 and optionally IPv6) from an existing DHCP server — your router, a Fritz!Box, dnsmasq, anything — instead of Docker's self-managed IPAM pools. Containers come up on your LAN as first-class hosts, addressable like any other machine. Bridge, macvlan, and ipvlan attachment modes.
This is a maintained fork of
devplayer0/docker-net-dhcp(quiet since 2021, no longer builds on current Docker). This fork modernises the toolchain (Go 1.26, docker SDK v28, current Alpine), adds macvlan and ipvlan modes, fixes the daemon-restart deadlock and a state data-race, and gates every PR on a live integration suite (all three modes + DHCPv6, recovery, failure injection) with a coverage ratchet and supply-chain gates on release. The maintained image lives atghcr.io/claymore666/docker-net-dhcp.
[!WARNING] ⚠️ BREAKING CHANGE IN v1.5.0 — DO THIS FIRST ⚠️
sudo mkdir -p /var/lib/net-dhcpv1.5.0 is the first release that bind-mounts its state directory from the host (so leases survive an upgrade), and Docker will not create a missing bind source. Run the line above before
docker plugin install, on every host, new install or upgrade.If you skip it,
docker plugin installfails at start-up and leaves the plugin installed but disabled — and re-running the exact same install command then answers onlyplugin ... already exists, which says nothing about the cause. Recover with:sudo mkdir -p /var/lib/net-dhcp docker plugin enable ghcr.io/claymore666/docker-net-dhcp:v1.5.0Nothing is lost or corrupted. Full detail: the reference.
Quick start
Install the plugin:
# One-time, and REQUIRED — see the warning above. Docker will not
# create this directory for you, and `plugin install` fails at
# start-up without it.
sudo mkdir -p /var/lib/net-dhcp
docker plugin install ghcr.io/claymore666/docker-net-dhcp:v1.5.0
It requests host networking, the host PID namespace, the Docker
socket, a bind mount of the state directory above, and
CAP_NET_ADMIN/CAP_SYS_ADMIN/CAP_SYS_PTRACE — grant them to
proceed.
(If you hit invalid rootfs in image configuration, upgrade Docker.)
Create a bridge-mode network and run a container on it (assumes you
already have a host bridge my-bridge on your LAN — see
bridge mode for that one-time setup):
docker network create -d ghcr.io/claymore666/docker-net-dhcp:v1.5.0 \
--ipam-driver null -o bridge=my-bridge my-dhcp-net
docker run --rm -ti --network my-dhcp-net alpine ip address show
The null IPAM driver is mandatory — it stops Docker handing out
addresses that would collide with the real LAN.
Attachment modes
Selected by the mode driver option:
| mode | parent | host changes required |
|---|---|---|
bridge (default) |
a Linux bridge you maintain (-o bridge=<name>) |
yes — you bring the bridge |
macvlan |
a host NIC (-o parent=<iface>) |
none |
ipvlan (L2) |
a host NIC (-o parent=<iface>) |
none |
macvlan/ipvlan attach directly to a host NIC without a bridge — the right pick when you don't want to reconfigure the host's networking.
Documentation
A versioned documentation site is published at
https://claymore666.github.io/docker-net-dhcp/ (pick your plugin
version from the selector). The same content lives in docs/ in the repo:
- Driver reference — the manual. Every option, setting, and counter, plus lease behaviour, observability, Compose usage, and troubleshooting. Its At a glance section lists everything you can set on one screen.
- Bridge mode — host bridge setup + end-to-end walkthrough.
- macvlan / ipvlan modes — choosing between the two, quick start, and the mode-specific constraints.
- How it works — the mechanism, for contributors: the veth + DHCP-client flow, and how state survives a restart.
- Changelog — per-release notes and credits.
- Release runbook — maintainer-facing publish procedure.
Project & community
- Contributing: see below.
- Security policy / vulnerability reporting: SECURITY.md (do not open public issues for vulnerabilities).
- Bug reports & feature requests: the issue forms.
- Pull requests: the
PR template — target the
devbranch. - Governance & code of conduct: GOVERNANCE.md, CODE_OF_CONDUCT.md.
This fork publishes semver-tagged images to two registries — GHCR is
primary (ghcr.io/claymore666/docker-net-dhcp:vX.Y.Z, linux/amd64;
ARM via the build pipeline on request), mirrored to Docker Hub as
claymore666/net-dhcp:vX.Y.Z. Every snippet here uses the GHCR
reference. See the
Releases page.
Verifying releases
Every release (v1.1.0 onward) is signed and attested via Sigstore. The
published plugin image is signed with cosign (keyless), carries SLSA
build provenance, and ships an SBOM; the release-artifact checksums.txt
manifest is cosign-signed so one signature covers every attached file.
The full, copy-pasteable procedure lives in
Verifying releases (also on the
docs site),
and every GitHub Release
links to it. In brief (replace VERSION):
# image signature
cosign verify ghcr.io/claymore666/docker-net-dhcp:VERSION \
--certificate-identity-regexp '^https://github.com/claymore666/docker-net-dhcp/.github/workflows/release.yml@' \
--certificate-oidc-issuer https://token.actions.githubusercontent.com
# SLSA build provenance (image + release artifacts)
gh attestation verify oci://ghcr.io/claymore666/docker-net-dhcp:VERSION --repo claymore666/docker-net-dhcp
Contributing
Contributions are welcome.
- Questions, bugs, and feature requests: open a GitHub issue.
For bugs, please include the plugin version, your Docker version, the network
mode (
bridge,macvlan, oripvlan), and the relevant plugin log. Docker has noplugin logssubcommand — the log lives in two places and Plugin log shows how to read either:sudo journalctl -u docker | grep net-dhcpon a systemd host (the copy that survives an upgrade), or the file inside the plugin rootfs. - Code changes: open a pull request against the
devbranch (notmain). Requirements for an acceptable contribution:- Coding standard: Go code must be formatted with
gofmtand passgo vetandstaticcheck; shell and workflow files must passshellcheck/actionlint. These are enforced in CI. - Tests: new functionality is expected to ship with tests; a coverage
ratchet enforces this at release time. Run them with
go test ./...for the fast loop andsudo make integration-localfor the live suites — see Running the tests. Use that target rather thanmake integration-testdirectly: the latter does not rebuild, so it silently tests whatever plugin is already installed. - Authorship: commits and pull request descriptions must not carry
AI-assistant attribution — no
Co-authored-by:trailer naming an assistant or an assistant's no-reply address, no "Generated with …" line, no assistant session trailer or link — and the commit author must be a person. Using an assistant to help write a change is fine and needs no disclosure; what the project asks is that you sign the work as its author and stand behind it. This is enforced by theattributioncheck, which reads every commit in your PR — message and author identity, since a rebase preserves authorship — plus the PR description. In the description, code blocks and inline code are stripped before scanning, so you can quote a trailer to discuss one, as here; commit messages are scanned in full and have no such escape. - Green CI: every PR must pass the repository's required checks
before it can be merged. Branch protection holds the authoritative
list and your PR's checks panel shows it applied to your branch — at
the time of writing it is unit tests,
staticcheck, the live integration suite,govulncheck,actionlint, CodeQL (Analyze (go)andAnalyze (actions)), andattribution. (Docs-only PRs — diffs touching nothing but*.md— satisfy the integration check via a fast in-job skip; any code, script, or workflow change runs the full suite.) - Hosted cross-check: a separate, non-required workflow runs the integration suite on a stock GitHub-hosted runner on a weekly schedule (and on demand) to validate the plugin against a vanilla distro's Docker. It is a portability probe, not a PR gate — a red there flags the hosted environment, not your change.
- Coding standard: Go code must be formatted with
- Security vulnerabilities: do not open a public issue — follow the private process described in SECURITY.md.
This is an actively maintained fork. It is solo-maintained, so please allow a few days for a response.
License
GPL-3.0 — see LICENSE.md. This is a fork of
devplayer0/docker-net-dhcp, which is GPL-3.0; as a
derivative work it stays under the same license.