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.
Supported Architectures
Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/netbootxyz 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
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest
Version Tags
This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
Tag
Description
latest
Web application for full self hosting
tftp
TFTP server only with NETBOOT.XYZ boot files
Application Setup
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.
Router Setup Examples
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
1
configure
2
set service dhcp-server use-dnsmasq enable
3
set service dns forwarding options "dhcp-match=set:bios,60,PXEClient:Arch:00000"
4
set service dns forwarding options "dhcp-boot=tag:bios,netboot.xyz.kpxe,,SERVERIP"
5
set service dns forwarding options "dhcp-match=set:efi32,60,PXEClient:Arch:00002"
6
set service dns forwarding options "dhcp-boot=tag:efi32,netboot.xyz.efi,,SERVERIP"
7
set service dns forwarding options "dhcp-match=set:efi32-1,60,PXEClient:Arch:00006"
8
set service dns forwarding options "dhcp-boot=tag:efi32-1,netboot.xyz.efi,,SERVERIP"
9
set service dns forwarding options "dhcp-match=set:efi64,60,PXEClient:Arch:00007"
10
set service dns forwarding options "dhcp-boot=tag:efi64,netboot.xyz.efi,,SERVERIP"
11
set service dns forwarding options "dhcp-match=set:efi64-1,60,PXEClient:Arch:00008"
12
set service dns forwarding options "dhcp-boot=tag:efi64-1,netboot.xyz.efi,,SERVERIP"
13
set service dns forwarding options "dhcp-match=set:efi64-2,60,PXEClient:Arch:00009"
14
set service dns forwarding options "dhcp-boot=tag:efi64-2,netboot.xyz.efi,,SERVERIP"
15
commit; save
Copied!
DD-WRT
Administration -> Services -> Additional DNSMasq Options Set the following lines:
1
dhcp-match=set:bios,60,PXEClient:Arch:00000
2
dhcp-boot=tag:bios,netboot.xyz.kpxe,,YOURSERVERIP
3
dhcp-match=set:efi32,60,PXEClient:Arch:00002
4
dhcp-boot=tag:efi32,netboot.xyz.efi,,YOURSERVERIP
5
dhcp-match=set:efi32-1,60,PXEClient:Arch:00006
6
dhcp-boot=tag:efi32-1,netboot.xyz.efi,,YOURSERVERIP
7
dhcp-match=set:efi64,60,PXEClient:Arch:00007
8
dhcp-boot=tag:efi64,netboot.xyz.efi,,YOURSERVERIP
9
dhcp-match=set:efi64-1,60,PXEClient:Arch:00008
10
dhcp-boot=tag:efi64-1,netboot.xyz.efi,,YOURSERVERIP
11
dhcp-match=set:efi64-2,60,PXEClient:Arch:00009
12
dhcp-boot=tag:efi64-2,netboot.xyz.efi,,YOURSERVERIP
Copied!
Tomato
Advanced -> DHCP/DNS -> Dnsmasq Custom configuration Set the following lines:
1
dhcp-match=set:bios,60,PXEClient:Arch:00000
2
dhcp-boot=tag:bios,netboot.xyz.kpxe,,YOURSERVERIP
3
dhcp-match=set:efi32,60,PXEClient:Arch:00002
4
dhcp-boot=tag:efi32,netboot.xyz.efi,,YOURSERVERIP
5
dhcp-match=set:efi32-1,60,PXEClient:Arch:00006
6
dhcp-boot=tag:efi32-1,netboot.xyz.efi,,YOURSERVERIP
7
dhcp-match=set:efi64,60,PXEClient:Arch:00007
8
dhcp-boot=tag:efi64,netboot.xyz.efi,,YOURSERVERIP
9
dhcp-match=set:efi64-1,60,PXEClient:Arch:00008
10
dhcp-boot=tag:efi64-1,netboot.xyz.efi,,YOURSERVERIP
11
dhcp-match=set:efi64-2,60,PXEClient:Arch:00009
12
dhcp-boot=tag:efi64-2,netboot.xyz.efi,,YOURSERVERIP
Copied!
OpenWRT
1
uci set [email protected][0].dhcp_match=set:bios,60,PXEClient:Arch:00000
2
uci set [email protected][0].dhcp_boot=tag:bios,netboot.xyz.kpxe,,YOURSERVERIP
3
uci set [email protected][0].dhcp_match=set:efi32,60,PXEClient:Arch:00002
4
uci set [email protected][0].dhcp_boot=tag:efi32,netboot.xyz.efi,,YOURSERVERIP
5
uci set [email protected][0].dhcp_match=set:efi32-1,60,PXEClient:Arch:00006
6
uci set [email protected][0].dhcp_boot=tag:efi32-1,netboot.xyz.efi,,YOURSERVERIP
7
uci set [email protected][0].dhcp_match=set:efi64,60,PXEClient:Arch:00007
8
uci set [email protected][0].dhcp_boot=tag:efi64,netboot.xyz.efi,,YOURSERVERIP
9
uci set [email protected][0].dhcp_match=set:efi64-1,60,PXEClient:Arch:00008
10
uci set [email protected][0].dhcp_boot=tag:efi64-1,netboot.xyz.efi,,YOURSERVERIP
11
uci set [email protected][0].dhcp_match=set:efi64-2,60,PXEClient:Arch:00009
12
uci set [email protected][0].dhcp_boot=tag:efi64-2,netboot.xyz.efi,,YOURSERVERIP
13
uci commit
14
/etc/init.d/dnsmasq restart
Copied!
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.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
1
---
2
version: "2.1"
3
services:
4
  netbootxyz:
5
    image: lscr.io/linuxserver/netbootxyz
6
    container_name: netbootxyz
7
    environment:
8
      - PUID=1000
9
      - PGID=1000
10
      - MENU_VERSION=1.9.9 #optional
11
      - PORT_RANGE=30000:30010 #optional
12
      - SUBFOLDER=/ #optional
13
    volumes:
14
      - /path/to/config:/config
15
      - /path/to/assets:/assets #optional
16
    ports:
17
      - 3000:3000
18
      - 69:69/udp
19
      - 8080:80 #optional
20
    restart: unless-stopped
Copied!
docker cli (click here for more info)
1
docker run -d \
2
  --name=netbootxyz \
3
  -e PUID=1000 \
4
  -e PGID=1000 \
5
  -e MENU_VERSION=1.9.9 `#optional` \
6
  -e PORT_RANGE=30000:30010 `#optional` \
7
  -e SUBFOLDER=/ `#optional` \
8
  -p 3000:3000 \
9
  -p 69:69/udp \
10
  -p 8080:80 `#optional` \
11
  -v /path/to/config:/config \
12
  -v /path/to/assets:/assets `#optional` \
13
  --restart unless-stopped \
14
  lscr.io/linuxserver/netbootxyz
Copied!
Parameters
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.
Ports (-p)
Parameter
Function
3000
Web configuration interface.
69/udp
TFTP Port.
80
NGINX server for hosting assets.
Environment Variables (-e)
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
Specify the port range tftp will use for data transfers (see Wikipedia)​
SUBFOLDER=/
Specify a sobfolder if running this behind a reverse proxy (IE /proxy/)
Volume Mappings (-v)
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
Parameter
Function
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.
Umask for running applications
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.
User / Group Identifiers
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:
1
  $ id username
2
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!
Docker Mods
​​
​ ​
​​
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.
Support Info
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
Versions
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.