From 4581b5f52fe550149d892c7cf5c12a71677361a2 Mon Sep 17 00:00:00 2001 From: <> Date: Thu, 16 Nov 2023 06:43:04 +0000 Subject: [PATCH] Deployed 9ebb741c with MkDocs version: 1.5.3 --- images/docker-netbootxyz/index.html | 4 ++-- sitemap.xml.gz | Bin 1783 -> 1783 bytes 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/images/docker-netbootxyz/index.html b/images/docker-netbootxyz/index.html index aca7fe044f..d542b16a12 100644 --- a/images/docker-netbootxyz/index.html +++ b/images/docker-netbootxyz/index.html @@ -1,4 +1,4 @@ - netbootxyz - LinuxServer.io
Skip to content

linuxserver/netbootxyz

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

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.

netbootxyz

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-<version tag>
arm64 ✅ arm64v8-<version tag>
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.n * 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
+ netbootxyz - LinuxServer.io       
 
 
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
   
linuxserver/netbootxyz
 
Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
 
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.
 
netbootxyz
 
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-<version tag> 
 
 arm64 ✅ arm64v8-<version tag> 
 
 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.n * 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\"
@@ -102,4 +102,4 @@
   --pull \
   -t lscr.io/linuxserver/netbootxyz:latest .
 
 
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
 
docker run --rm --privileged multiarch/qemu-user-static:register --reset
-
 
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
 
Versions
 
     
  • 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.
    •  
 
 
  Last update: October 24, 2023 
 Created: October 24, 2019  
 
 
 
  
  
 
 
 
      
\ No newline at end of file
+

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 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.
Last update: November 16, 2023
Created: October 24, 2019
\ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index d4b00516605fee6036ad6e09802e6a6df64ac5c2..214d2999b48e0303a149d1683493739f0b208af9 100644 GIT binary patch delta 14 Vcmey)`<<6nzMF&N)kfA&Yyc^=1z-RG delta 14 Vcmey)`<<6nzMF%idL!#6HUKAy1n~d>