linuxserver/netbootxyz
Netbootxyz is a way to PXE boot various operating system installers or utilities from one place within the BIOS without the need of having to go retrieve the media to run the tool. iPXE is used to provide a user friendly menu from within the BIOS that lets you easily choose the operating system you want along with any specific types of versions or bootable flags.
Simply pulling
lscr.io/linuxserver/netbootxyz:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.The architectures supported by this image are:
Architecture | Available | Tag |
|---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ✅ | arm32v7-<version tag> |
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag | Available | Description |
|---|---|---|
latest | ✅ | Web application for full self hosting |
tftp | ✅ | TFTP server only with NETBOOT.XYZ boot files |
To use this image you need an existing DHCP server where you can set this TFTP server as your DHCP boot destination. This image does not contain a DHCP server nor do we aim to support one in the future. This is simply a TFTP server hosting the latest IPXE kernel builds from netboot.xyz. If you are interested in their project and lack the ability to setup a DHCP server to boot this payload they also have USB stick images you can use available on their downloads page.
PFSense
Services -> DHCP Server
Set both the option for "TFTP Server" and the options under the Advanced "Network Booting" section.
- check enable
- Next server- IP used for TFTP Server
- Default BIOS file name-
netboot.xyz.kpxe - UEFI 32 bit file name-
netboot.xyz.efi - UEFI 64 bit file name-
netboot.xyz.efi
OPNsense
Services -> DHCP Server
Under the Advanced "Network Booting" section.
- check enable
- Next server- IP of docker host
- Default BIOS file name-
netboot.xyz.kpxe - UEFI 32 bit file name-
netboot.xyz.efi - UEFI 64 bit file name-
netboot.xyz.efi
Unifi Security Gateway (with the controller)
Networks -> LAN (or the network you want to boot from) -> ADVANCED DHCP OPTIONS
- tick Enable network boot
- Server- YOURSERVERIP
- Filename-
netboot.xyz.kpxe
EdgeOS/VyOS
Connect via SSH
configure
set service dhcp-server use-dnsmasq enable
set service dns forwarding options "dhcp-match=set:bios,60,PXEClient:Arch:00000"
set service dns forwarding options "dhcp-boot=tag:bios,netboot.xyz.kpxe,,SERVERIP"
set service dns forwarding options "dhcp-match=set:efi32,60,PXEClient:Arch:00002"
set service dns forwarding options "dhcp-boot=tag:efi32,netboot.xyz.efi,,SERVERIP"
set service dns forwarding options "dhcp-match=set:efi32-1,60,PXEClient:Arch:00006"
set service dns forwarding options "dhcp-boot=tag:efi32-1,netboot.xyz.efi,,SERVERIP"
set service dns forwarding options "dhcp-match=set:efi64,60,PXEClient:Arch:00007"
set service dns forwarding options "dhcp-boot=tag:efi64,netboot.xyz.efi,,SERVERIP"
set service dns forwarding options "dhcp-match=set:efi64-1,60,PXEClient:Arch:00008"
set service dns forwarding options "dhcp-boot=tag:efi64-1,netboot.xyz.efi,,SERVERIP"
set service dns forwarding options "dhcp-match=set:efi64-2,60,PXEClient:Arch:00009"
set service dns forwarding options "dhcp-boot=tag:efi64-2,netboot.xyz.efi,,SERVERIP"
commit; save
DD-WRT
Administration -> Services -> Additional DNSMasq Options Set the following lines:
dhcp-match=set:bios,60,PXEClient:Arch:00000
dhcp-boot=tag:bios,netboot.xyz.kpxe,,YOURSERVERIP
dhcp-match=set:efi32,60,PXEClient:Arch:00002
dhcp-boot=tag:efi32,netboot.xyz.efi,,YOURSERVERIP
dhcp-match=set:efi32-1,60,PXEClient:Arch:00006
dhcp-boot=tag:efi32-1,netboot.xyz.efi,,YOURSERVERIP
dhcp-match=set:efi64,60,PXEClient:Arch:00007
dhcp-boot=tag:efi64,netboot.xyz.efi,,YOURSERVERIP
dhcp-match=set:efi64-1,60,PXEClient:Arch:00008
dhcp-boot=tag:efi64-1,netboot.xyz.efi,,YOURSERVERIP
dhcp-match=set:efi64-2,60,PXEClient:Arch:00009
dhcp-boot=tag:efi64-2,netboot.xyz.efi,,YOURSERVERIP
Tomato
Advanced -> DHCP/DNS -> Dnsmasq Custom configuration Set the following lines:
dhcp-match=set:bios,60,PXEClient:Arch:00000
dhcp-boot=tag:bios,netboot.xyz.kpxe,,YOURSERVERIP
dhcp-match=set:efi32,60,PXEClient:Arch:00002
dhcp-boot=tag:efi32,netboot.xyz.efi,,YOURSERVERIP
dhcp-match=set:efi32-1,60,PXEClient:Arch:00006
dhcp-boot=tag:efi32-1,netboot.xyz.efi,,YOURSERVERIP
dhcp-match=set:efi64,60,PXEClient:Arch:00007
dhcp-boot=tag:efi64,netboot.xyz.efi,,YOURSERVERIP
dhcp-match=set:efi64-1,60,PXEClient:Arch:00008
dhcp-boot=tag:efi64-1,netboot.xyz.efi,,YOURSERVERIP
dhcp-match=set:efi64-2,60,PXEClient:Arch:00009
dhcp-boot=tag:efi64-2,netboot.xyz.efi,,YOURSERVERIP
OpenWRT
uci set [email protected][0].dhcp_match=set:bios,60,PXEClient:Arch:00000
uci set [email protected][0].dhcp_boot=tag:bios,netboot.xyz.kpxe,,YOURSERVERIP
uci set [email protected][0].dhcp_match=set:efi32,60,PXEClient:Arch:00002
uci set [email protected][0].dhcp_boot=tag:efi32,netboot.xyz.efi,,YOURSERVERIP
uci set [email protected][0].dhcp_match=set:efi32-1,60,PXEClient:Arch:00006
uci set [email protected][0].dhcp_boot=tag:efi32-1,netboot.xyz.efi,,YOURSERVERIP
uci set [email protected][0].dhcp_match=set:efi64,60,PXEClient:Arch:00007
uci set [email protected][0].dhcp_boot=tag:efi64,netboot.xyz.efi,,YOURSERVERIP
uci set [email protected][0].dhcp_match=set:efi64-1,60,PXEClient:Arch:00008
uci set [email protected][0].dhcp_boot=tag:efi64-1,netboot.xyz.efi,,YOURSERVERIP
uci set [email protected][0].dhcp_match=set:efi64-2,60,PXEClient:Arch:00009
uci set [email protected][0].dhcp_boot=tag:efi64-2,netboot.xyz.efi,,YOURSERVERIP
uci commit
/etc/init.d/dnsmasq restart
Microsoft Server DHCP
- Run the DHCP program
- Under Scope/Scope Options
- check option 066 and enter the FQDN or IP of your TFTP boot server
- check option 067 and enter one of the following bootfile names:
- Default BIOS file name- netboot.xyz.kpxe
- UEFI 32 bit file name- netboot.xyz.efi
- UEFI 64 bit file name- netboot.xyz.efi
Anything else from a router standpoint is a crapshoot for supporting Dnsmasq options or proprietary PXE boot options, check Google for support (try your exact router model number with 'pxe boot') or look into setting up your own DHCP server in Linux.
This image also contains
netboot.xyz.efi which can be used to boot using UEFI network boot. The UEFI boot and menu will have limited functionality if you choose to use it.To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
version: "2.1"
services:
netbootxyz:
image: lscr.io/linuxserver/netbootxyz:latest
container_name: netbootxyz
environment:
- PUID=1000
- PGID=1000
- MENU_VERSION=1.9.9 #optional
- PORT_RANGE=30000:30010 #optional
- SUBFOLDER=/ #optional
volumes:
- /path/to/config:/config
- /path/to/assets:/assets #optional
ports:
- 3000:3000
- 69:69/udp
- 8080:80 #optional
restart: unless-stopped
docker run -d \
--name=netbootxyz \
-e PUID=1000 \
-e PGID=1000 \
-e MENU_VERSION=1.9.9 `#optional` \
-e PORT_RANGE=30000:30010 `#optional` \
-e SUBFOLDER=/ `#optional` \
-p 3000:3000 \
-p 69:69/udp \
-p 8080:80 `#optional` \
-v /path/to/config:/config \
-v /path/to/assets:/assets `#optional` \
--restart unless-stopped \
lscr.io/linuxserver/netbootxyz:latest
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate
<external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.Parameter | Function |
|---|---|
3000 | Web configuration interface. |
69/udp | TFTP Port. |
80 | NGINX server for hosting assets. |
Env | Function |
|---|---|
PUID=1000 | for UserID - see below for explanation |
PGID=1000 | for GroupID - see below for explanation |
MENU_VERSION=1.9.9 | Specify a specific version of boot files you want to use from NETBOOT.XYZ (unset pulls latest) |
PORT_RANGE=30000:30010 | |
SUBFOLDER=/ | Specify a sobfolder if running this behind a reverse proxy (IE /proxy/) |
Volume | Function |
|---|---|
/config | Storage for boot menu files and web application config |
/assets | Storage for NETBOOT.XYZ bootable assets (live CDs and other files) |
Miscellaneous Options
You can set any environment variable from a file by using a special prepend
FILE__.As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable
PASSWORD based on the contents of the /run/secrets/mysecretpassword file.For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional
-e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.When using volumes (
-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance
PUID=1000 and PGID=1000, to find yours use id user as below: $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
- Shell access whilst the container is running:
docker exec -it netbootxyz /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f netbootxyz
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' netbootxyz
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/netbootxyz:latest
- 12.10.22: - Rebasing to Alpine 3.16, migrate to s6v3.
- 29.04.21: - Rebasing to alpine 3.13, add SUBFOLDER env variable.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 13.12.19: - Swapping latest tag over to webapp stack for management.
- 10.12.19: - Adding tftp branch to provide tftp only option to latest users.
- 22.10.19: - Initial release.
Last modified 3mo ago