|
| 1 | +# netboot.xyz |
| 2 | + |
| 3 | +> netboot.xyz lets you PXE boot various operating system installers and utilities from a single tool over the network using iPXE. Boot Linux, BSD, Windows, and dozens of live CDs from one lightweight menu — no physical media required. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +- [Introduction](https://netboot.xyz/docs): Overview of netboot.xyz, its menus (network installs, live CDs, utilities), and supported architectures (x86, x86_64, arm64) |
| 8 | +- [Quick Start](https://netboot.xyz/docs/quick-start): Download a bootloader and PXE boot your first operating system in minutes |
| 9 | +- [Downloads](https://netboot.xyz/downloads): Pre-compiled iPXE bootloader images for Legacy BIOS and UEFI |
| 10 | + |
| 11 | +## Booting Methods |
| 12 | + |
| 13 | +- [Boot from USB](https://netboot.xyz/docs/booting/usb): Write a netboot.xyz image to a USB drive on Linux, macOS, or Windows |
| 14 | +- [Boot from TFTP](https://netboot.xyz/docs/booting/tftp): Set up PXE booting on a local network with a TFTP server and DHCP options |
| 15 | +- [Boot from iPXE](https://netboot.xyz/docs/booting/ipxe): Chainload netboot.xyz from an existing iPXE installation |
| 16 | +- [Boot from ISO](https://netboot.xyz/docs/booting/iso): Use the netboot.xyz ISO image directly |
| 17 | +- [Boot from UEFI](https://netboot.xyz/docs/booting/uefi): Place the UEFI executable on the EFI system partition and boot without media |
| 18 | +- [Boot with QEMU](https://netboot.xyz/docs/booting/qemu): Boot netboot.xyz inside a QEMU virtual machine |
| 19 | +- [Boot from VMs](https://netboot.xyz/docs/booting/vms): Use netboot.xyz in VMware Fusion, Proxmox VE, and Hyper-V |
| 20 | + |
| 21 | +## Self Hosting |
| 22 | + |
| 23 | +- [Self Hosting](https://netboot.xyz/docs/selfhosting): Run your own netboot.xyz server using Ansible or Docker |
| 24 | +- [Docker Container Overview](https://netboot.xyz/docs/docker/): The netboot.xyz Docker container with web UI, TFTP, and local asset mirroring |
| 25 | +- [Setting up the Container](https://netboot.xyz/docs/docker/usage): Install and run the Docker container |
| 26 | +- [Container Parameters](https://netboot.xyz/docs/docker/parameters): All available Docker environment variables and volume mounts |
| 27 | +- [DHCP Configuration](https://netboot.xyz/docs/docker/dhcp): Configure DHCP to point clients at the self-hosted container |
| 28 | +- [Custom Menus](https://netboot.xyz/docs/docker/custom-menus): Create custom iPXE menus via the web interface |
| 29 | + |
| 30 | +## Knowledge Base |
| 31 | + |
| 32 | +### Hardware |
| 33 | + |
| 34 | +- [UEFI Secure Boot](https://netboot.xyz/docs/kb/hardware/secureboot): Use pre-built Secure Boot images to network boot without disabling Secure Boot |
| 35 | +- [Steam Deck](https://netboot.xyz/docs/kb/hardware/steamdeck): PXE boot on the Steam Deck via USB-C hub with Ethernet |
| 36 | +- [Synology NAS](https://netboot.xyz/docs/kb/hardware/synology): Run netboot.xyz as a Docker container on a Synology NAS |
| 37 | +- [JetKVM](https://netboot.xyz/docs/kb/hardware/jetkvm): Using netboot.xyz with the JetKVM hardware KVM device |
| 38 | + |
| 39 | +### Networking |
| 40 | + |
| 41 | +- [Asuswrt-Merlin](https://netboot.xyz/docs/kb/networking/asuswrt-merlin): Configure PXE booting on an Asus router running Asuswrt-Merlin |
| 42 | +- [Ubiquiti EdgeRouter](https://netboot.xyz/docs/kb/networking/edgerouter): Set up netboot.xyz PXE booting on a Ubiquiti EdgeRouter |
| 43 | +- [Mikrotik RouterOS](https://netboot.xyz/docs/kb/networking/mikrotik): Configure DHCP and TFTP on Mikrotik RouterOS |
| 44 | +- [TFTP Filename Issues](https://netboot.xyz/docs/kb/networking/tftp-filename-issues): Troubleshoot TFTP filename interpretation issues with older PXE clients |
| 45 | + |
| 46 | +### Cloud Providers |
| 47 | + |
| 48 | +- [DigitalOcean](https://netboot.xyz/docs/kb/providers/digitalocean): Using netboot.xyz on DigitalOcean |
| 49 | +- [Google Compute Engine](https://netboot.xyz/docs/kb/providers/gce): Boot netboot.xyz on GCE using a custom iPXE disk image |
| 50 | +- [Vultr](https://netboot.xyz/docs/kb/providers/vultr): Boot netboot.xyz on Vultr via ISO upload or iPXE chain URL |
| 51 | +- [Linode](https://netboot.xyz/docs/kb/providers/linode): Using netboot.xyz on Linode |
| 52 | +- [Equinix Metal](https://netboot.xyz/docs/kb/providers/equinixmetal): Using netboot.xyz with Equinix Metal bare metal servers |
| 53 | +- [Cherry Servers](https://netboot.xyz/docs/kb/providers/cherryservers): Using netboot.xyz with Cherry Servers dedicated bare metal |
| 54 | +- [Oracle Cloud Infrastructure](https://netboot.xyz/docs/kb/providers/oci): Using netboot.xyz on Oracle Cloud Infrastructure |
| 55 | +- [OpenStack](https://netboot.xyz/docs/kb/providers/openstack): Boot netboot.xyz on OpenStack using Glance and Nova |
| 56 | + |
| 57 | +### PXE Installation Guides |
| 58 | + |
| 59 | +- [Ubuntu](https://netboot.xyz/docs/kb/pxe/ubuntu): PXE boot the Ubuntu installer with autoinstall support |
| 60 | +- [Debian](https://netboot.xyz/docs/kb/pxe/debian): PXE boot the Debian installer with preseed automation |
| 61 | +- [AlmaLinux](https://netboot.xyz/docs/kb/pxe/almalinux): PXE boot AlmaLinux using Kickstart for automated installation |
| 62 | +- [Rocky Linux](https://netboot.xyz/docs/kb/pxe/rockylinux): PXE boot Rocky Linux using Kickstart for automated installation |
| 63 | +- [Windows](https://netboot.xyz/docs/kb/pxe/windows): Install Windows 11 over the network using WinPE and the Docker container |
| 64 | + |
| 65 | +## Troubleshooting |
| 66 | + |
| 67 | +- [Troubleshooting Guide](https://netboot.xyz/docs/troubleshooting): Common issues and solutions |
| 68 | +- [Common Error Codes](https://netboot.xyz/docs/troubleshooting/common-error-codes): Understanding and resolving common netboot.xyz errors |
| 69 | +- [Performance Optimization](https://netboot.xyz/docs/troubleshooting/performance-optimization): Optimize for faster boot times and downloads |
| 70 | + |
| 71 | +## Reference |
| 72 | + |
| 73 | +- [FAQ](https://netboot.xyz/docs/faq): Frequently asked questions including supported operating systems and utilities |
| 74 | +- [Contributing](https://netboot.xyz/docs/contributing): How to contribute new OS versions or features to the project |
| 75 | +- [Build Automation](https://netboot.xyz/docs/community/build-automation): How the automated CI/CD build system keeps OS versions current |
| 76 | +- [Changelog](https://netboot.xyz/docs/community/changelog): Release history and changes |
0 commit comments