5ca79c80ef
* Adds .dockerfile ignore for .git to prevent issues building in submodules Co-authored-by: Case Larsen <CTLarsen@lbl.gov> |
||
|---|---|---|
| .github | ||
| docker-build-root | ||
| etc/netbootxyz/custom | ||
| roles/netbootxyz | ||
| script | ||
| .ansible-lint | ||
| .dockerignore | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| Dockerfile-build | ||
| Dockerfile-build.production | ||
| LICENSE | ||
| README.md | ||
| endpoints.yml | ||
| inventory | ||
| site.yml | ||
| user_overrides.yml | ||
| version.txt | ||
README.md
netboot.xyz
Bootloader Downloads
Combined Legacy and UEFI iPXE Bootloaders
| Type | Bootloader | Description |
|---|---|---|
| ISO | netboot.xyz.iso | Used for CD/DVD, Virtual CDs, DRAC/iLO, VMware, Virtual Box |
| USB | netboot.xyz.img | Used for creation of USB Keys |
Legacy (PCBIOS) iPXE Bootloaders
| Type | Bootloader | Description |
|---|---|---|
| Kernel | netboot.xyz.lkrn | Used for booting from GRUB/EXTLINUX |
| Floppy | netboot.xyz.dsk | Virtual floppy disk for DRAC/iLO, VMware, Virtual Box, etc |
| DHCP | netboot.xyz.kpxe | DHCP boot image file, uses built-in iPXE NIC drivers |
| DHCP-undionly | netboot.xyz-undionly.kpxe | DHCP boot image file, use if you have NIC issues |
UEFI iPXE Bootloaders
| Type | Bootloader | Description |
|---|---|---|
| DHCP | netboot.xyz.efi | DHCP boot image file, uses built-in iPXE NIC drivers |
| DHCP-snp | netboot.xyz-snp.efi | EFI w/ Simple Network Protocol, attempts to boot all net devices |
| DHCP-snponly | netboot.xyz-snponly.efi | EFI w/ Simple Network Protocol, only boots from device chained from |
ARM64 iPXE Bootloaders
| Type | Bootloader | Description |
|---|---|---|
| DHCP | netboot.xyz-arm64.efi | DHCP boot image file, uses built-in iPXE NIC drivers |
| DHCP-snp | netboot.xyz-arm64-snp.efi | EFI w/ Simple Network Protocol, attempts to boot all net devices |
| DHCP-snponly | netboot.xyz-arm64-snponly.efi | EFI w/ Simple Network Protocol, only boots from device chained from |
Raspberry Pi iPXE Bootloaders
| Type | Bootloader | Description |
|---|---|---|
| USB/SD Card | netboot.xyz-rpi4-sdcard.img | Raspberry Pi 4 - USB/SD Card Image |
| DHCP-snp | netboot.xyz-rpi4-snp.efi | Raspberry Pi 4 - EFI Image |
SHA256 checksums are generated during each build of iPXE and are located here. You can also view the scripts that are embedded into the images here.
What is netboot.xyz?
netboot.xyz is a convenient place to boot into any type of operating system or utility disk without the need of having to go spend time retrieving the ISO just to run it. 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.
If you already have iPXE up and running on the network, you can hit netboot.xyz at anytime by typing for Legacy (PCBIOS) mode:
chain --autofree http://boot.netboot.xyz/ipxe/netboot.xyz.lkrn
or when in UEFI mode:
chain --autofree http://boot.netboot.xyz/ipxe/netboot.xyz.efi
You can also load using HTTPS, but by default builds of iPXE do not have HTTPS support compiled in. This will load the appropriate netboot.xyz kernel with all of the proper options enabled.
Documentation
See netboot.xyz for all documentation. Some links to get started with are:
If you'd like to contribute to the documentation, the netboot.xyz documentation is located at netboot.xyz-docs.
Self Hosting netboot.xyz
For those users who want to deploy their own netboot.xyz environment, you can leverage the same scripts that are used to deploy the hosted environment. The source scripts are all Ansible templates and can be generated and customized to your preference.
Please see the self-hosting docs for more information but in short:
Deploying using Ansible
To generate, run:
ansible-playbook -i inventory site.yml
The build output will be located in /var/www/html by default.
Deploying with Docker
docker build -t localbuild -f Dockerfile-build .
docker run --rm -it -v $(pwd):/buildout localbuild
The build output will be in the generated folder buildout
Local Overrides
Ansible will handle source generation as well as iPXE disk generation with your settings. It will generate Legacy (PCBIOS) and UEFI iPXE disks that can be used to load into your netboot.xyz environment. If you want to override the defaults, you can put overrides in user_overrides.yml. See user_overrides.yml for examples.
Using the overrides file, you can override all of the settings from the defaults/main.yml so that you can easily change the boot mirror URLs when the menus are rendered. If you prefer to do this after the fact, you can also edit the boot.cfg to make changes, but keep in mind those changes will not be saved when you redeploy the menu.
Self Hosted Custom Options
In addition to being able to host netboot.xyz locally, you can also create your own custom templates for custom menus within netboot.xyz. Please see Custom User Menus for more information.
What Operating Systems are currently available on netboot.xyz?
Operating Systems
Utilities
Feedback
Feel free to open up an issue on Github or ping us on Discord. Follow us on Twitter and like us on Facebook!