DHCP-Netboot
This Docker container lets you PXE boot a bunch of installers and utilities on your local network, without much mucking about configuring DHCP and TFTP…
Platform availability
Available on 1 of 10 platforms
- Unraid
- TrueNAS (not listed)
- Umbrel (not listed)
- ZimaOS (not listed)
- Proxmox (not listed)
- Helm (not listed)
- Mac (not listed)
- Windows (not listed)
- Linux (not listed)
- Any server (not listed)
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
33/100 Low
- Maintained
- 0last commit 1571 days ago
- Popular
- 41106 GitHub stars
- Easy to install
- 351 install platform, install notes, Docker image
- Light to run
- No data
- Security check
- 85no serious findings, CI
Based on 4 of 5 factors.
Availability: platform listings confirmed today, links checked 35 days ago
- GitHub stars
- 106
- Open issues
- 11
- Last commit
- 2022-08-03
- License
- GPL-3.0
- Activity
- stale
Checked 10 days ago - source: GitHub (samdbmg/dhcp-netboot.xyz)
Resources & Compatibility
ARM (e.g. Raspberry Pi) is not supported.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- Install the npm package first Run npm install dhcp before trying to start the DHCP server or client. This installs the code the app needs, so the later commands can actually run. source
- Use sudo and set your real network values Start the CLI with sudo and replace the example --range, --server, --router, and --dns values with your network's real addresses. These settings decide which IP addresses devices receive, so wrong values can leave your devices unable to connect. source
- Use verbose flags while testing Run commands with -v or --verbose so the app shows readable steps, and use -vv if you need deeper internal logs. This helps you confirm the DHCP server is starting and handing out leases before you assume it is broken. source
Fetched 54 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
Common questions
Do I need to replace my router’s DHCP server?
No, it uses a ProxyDHCP service so your existing DHCP server can keep assigning IP addresses normally. When a PXE client sends a DHCP request, the container also announces itself as a TFTP boot target.
Which firewall ports must be open for it to work?
Allow UDP 67 for DHCP, UDP 69 for TFTP, and UDP 4011 for PXE. Also allow TCP 80 for the built-in web server, then remove the firewall rules when finished.
How do I configure the IP range it uses?
Set the DHCP_RANGE_START environment variable to the first address on your network. dnsmasq determines the correct subnet mask from your local network setup.
Why does the Docker run command require --net=host and NET_ADMIN?
The container needs low-level access to the target network instead of Docker’s internal bridge so it can respond to PXE DHCP requests. It also needs to expose the DHCP, TFTP, PXE, and HTTP ports directly.
Answers sourced from github.com
Community
- Netboot (not PXE) experiences - Raspberry Pi Forums (forum)
- Can't get netboot to work on RPi5 - Raspberry Pi Forums (forum)
- Ventoy Forums - iventoy first try, dhcp proxy mode ? dhcp modes ? (forum)
- Easiest way to setup a NetBoot/PXE-Server : r/selfhosted - Reddit (reddit)
- Best DHCP Standalone server : r/selfhosted - Reddit (reddit)
Collected 48 days ago - public community threads