Netboot.xyz (container)

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

Image details

Pulls: 21.1M

Architecture: amd64, arm64

Image size: 75 MB

Latest: 0.7.6

User: linuxserver

Created: Oct 24, 2019

Updated: 1 years ago

Status: active

Configuration

Type

Container

Image

linuxserver/netbootxyz:latest

Ports

3000/tcp69/udp

Volumes

/config : /opt/mediadepot/apps/netbootxyz/assets : /media/storage/software/netbootxyz/etc/localtime : /etc/localtime

Env vars

PGID=15000PUID=15000

Labels

traefik.enable=truetraefik.http.services.netbootxyz.loadbalancer.server.port=3000traefik.http.routers.netbootxyz.entrypoints=websecuretraefik.http.routers.netbootxyz.tls.certresolver=mydnschallenge

Template by mediadepot

Standalone Install

Select an install method, to see config/commands for deploying Netboot.xyz (container)

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select Netboot.xyz (container), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

More install options in our documentation.

The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
Fleet - an online web interface which displays all of our maintained images.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

DEPRECATION NOTICE

This image is deprecated. We will not offer support for this image and it will not be updated.
Consider switching to https://github.com/netbootxyz/docker-netbootxyz for the official container which is a drop-in replacement.

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

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: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-\
arm64	✅	arm64v8-\
armhf	❌

Version Tags

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

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

Advanced full support

For USG variants force provisioning a json containing the same config used for EdgeOS (shown below) will fully support netboot.
For UDM variants, creating a valid dnsmasq config and placing in /run/dnsmasq.conf.d will load the config, but will not survive reboots or firmware updates source.

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

Dnsmasq/DD-WRT/OpenWRT/Tomato/PIHOLE

Various locations to set Additional/Custom DNSMASQ options in UI or config files 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

Ensure you restart the DNSMASQ service after the changes.

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.
>!NOTE >Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  netbootxyz:
    image: lscr.io/linuxserver/netbootxyz:latest
    container_name: netbootxyz
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - MENU_VERSION=1.9.9 #optional
      - PORT_RANGE=30000:30010 #optional
      - SUBFOLDER=/ #optional
      - NGINX_PORT=80 #optional
      - WEB_APP_PORT=3000 #optional
    volumes:
      - /path/to/netbootxyz/config:/config
      - /path/to/assets:/assets #optional
    ports:
      - 3000:3000
      - 69:69/udp
      - 8080:80 #optional
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=netbootxyz \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e MENU_VERSION=1.9.9 `#optional` \
  -e PORT_RANGE=30000:30010 `#optional` \
  -e SUBFOLDER=/ `#optional` \
  -e NGINX_PORT=80 `#optional` \
  -e WEB_APP_PORT=3000 `#optional` \
  -p 3000:3000 \
  -p 69:69/udp \
  -p 8080:80 `#optional` \
  -v /path/to/netbootxyz/config:/config \
  -v /path/to/assets:/assets `#optional` \
  --restart unless-stopped \
  lscr.io/linuxserver/netbootxyz:latest

Parameters

Containers 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
`-p 3000:3000`	Web configuration interface.
`-p 69:69/udp`	TFTP Port.
`-p 80`	NGINX server for hosting assets.
`-e PUID=1000`	for UserID - see below for explanation
`-e PGID=1000`	for GroupID - see below for explanation
`-e TZ=Etc/UTC`	specify a timezone to use, see this list.
`-e MENUVERSION=1.9.9`	Specify a specific version of boot files you want to use from NETBOOT.XYZ (unset pulls latest)
`-e PORTRANGE=30000:30010`	Specify the port range tftp will use for data transfers (see Wikipedia)
`-e SUBFOLDER=/`	Specify a subfolder if running this behind a reverse proxy (IE /proxy/)
`-e NGINXPORT=80`	Specify a different internal port for the asset server
`-e WEBAPPPORT=3000`	Specify a different internal port for the configuration UI
`-v /config`	Storage for boot menu files and web application config
`-v /assets`	Storage for NETBOOT.XYZ bootable assets (live CDs and other files)

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

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:

```bash
docker exec -it netbootxyz /bin/bash
```

To monitor the logs of the container in realtime:

```bash
docker logs -f netbootxyz
```

Container version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' netbootxyz
```

Image version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/netbootxyz:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

Update images:

* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull netbootxyz
    ```

Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d netbootxyz
    ```

You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

Update the image:

```bash
docker pull lscr.io/linuxserver/netbootxyz:latest
```

Stop the running container:

```bash
docker stop netbootxyz
```

Delete the container:

```bash
docker rm netbootxyz
```

Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:

```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-netbootxyz.git
cd docker-netbootxyz
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/netbootxyz:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions
17.05.25: - Deprecate
30.06.24: - Rebase to Alpine 3.20.
24.02.24: - Add new port settings for the webserver and app.
08.12.23: - Rebase to Alpine 3.19.
17.11.23: - Rebase to Alpine 3.18.
01.07.23: - Deprecate armhf. As announced here
05.03.23: - Rebase to Alpine 3.17.
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.

Serve Netboot.xyz (container) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxy Domain App port Upstream

Proxying netboot-xyz-container.example.com to http://netbootxyz:3000

Add this to your Caddyfile

netboot-xyz-container.example.com {
	reverse_proxy http://netbootxyz:3000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

In Portainer, go to Containers, click the container, then Logs. Or run docker logs netbootxyz
Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Published on a random port

This template exposes 3000/tcp without setting a host port, so Docker picks a random free one on every deploy.

Find it in the Ports column of Portainer's container list, or with docker port netbootxyz

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

Fix the ownership: sudo chown -R 15000:15000 /opt/mediadepot/apps/netbootxyz (and the same for the other mapped folders)
Or set the PUID and PGID variables (defaults 15000:15000) to match your own user, found with id $USER
Seeing "read-only file system"? /etc/localtime is mounted read-only on purpose, the app isn't meant to write there.

Image won't pull

Test the pull directly on the host: docker pull linuxserver/netbootxyz:latest

"manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
"toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
"no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

This image supports: amd64, arm64
Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Bug within the app: Open an issue within netbootxyz's repo
Template not working: Open an issue on mediadepot/templates
This website not working: Open an issue on lissy93/portainer-templates

A single container

Netboot.xyz (container) runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Netboot.xyz (container) needs bundled into one download. This template pulls linuxserver/netbootxyz:latest, which Docker fetches once (about 75 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Netboot.xyz (container)'s comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 0.7.6. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:

3000, published on a random host port
69 over UDP, published on a random host port

Volumes

A volume is where Netboot.xyz (container) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

/config from /opt/mediadepot/apps/netbootxyz on the host
/assets from /media/storage/software/netbootxyz on the host
/etc/localtime from /etc/localtime on the host, read-only

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Netboot.xyz (container) takes 2 of them, all with defaults you can leave alone or tweak:

PGID, defaults to 15000
PUID, defaults to 15000

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Netboot.xyz (container) sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container netbootxyz. That's what you'll spot in the containers list and use in commands like docker logs netbootxyz.

Labels

Labels are small notes pinned to the container. They don't change how Netboot.xyz (container) behaves, but other tools read them, most often a reverse proxy like Traefik working out which apps to route where. This template sets:

traefik.enable=true
traefik.http.services.netbootxyz.loadbalancer.server.port=3000
traefik.http.routers.netbootxyz.entrypoints=websecure
traefik.http.routers.netbootxyz.tls.certresolver=mydnschallenge

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Netboot.xyz (container) up. Add the template list to Portainer once, then deploying Netboot.xyz (container) is a click rather than a wall of config.

Netboot.xyz (container)

Image details

Configuration

Standalone Install

Install on Portainer

Template Import URL

Container Documentation

DEPRECATION NOTICE

linuxserver/netbootxyz

Supported Architectures

Version Tags

Application Setup

Router Setup Examples

PFSense

OPNsense

Unifi Security Gateway (with the controller)

EdgeOS/VyOS

Dnsmasq/DD-WRT/OpenWRT/Tomato/PIHOLE

Microsoft Server DHCP

Usage

docker-compose (recommended, click here for more info)

docker cli (click here for more info)

Parameters

Environment variables from files (Docker secrets)

Umask for running applications

User / Group Identifiers

Docker Mods

Support Info

Updating Info

Via Docker Compose

Via Docker Run

Image Update Notifications - Diun (Docker Image Update Notifier)

Building locally

Versions

Recent versions

Proxy configurator

Troubleshooting

Check the logs first

Published on a random port

Permission denied on volumes

Image won't pull

"exec format error"

Raise an issue

Config glossary

A single container

The app image

Where the image comes from

Version tags

Which machines it runs on

Ports

Volumes

Environment variables

Users and permissions

Networking

Container name

Labels

Portainer app templates

Similar apps