Features • Getting Started • PXE Basics • Overview & netboot.xyz • Assets • Menu Scripting • ROM builds • Deployment • CI • Operations • Glossary
This project is a cold fork of Netboot.xyz with the goal of unifying and simplifying the upstream into an all-in-one solution. Its main purpose is to provide an editor for iPXE menus, build the boot mediums and serve them on the fly. Additional features include Wake-on-LAN, PXE menu testing and installation, and documentation in the webapp for developing custom PXE menus.
PXE booting is especially relevant for automating bare-metal installations and experimenting with new setups.
This webapp aims to:
- Serve the PXE menu with real-time edits and local overrides
- Serve install assets during PXE boot
- Author Kickstart (
ks.cfg) and cloud-init (user-data/meta-data) provisioning profiles, with a distro/version field and built-in syntax validation - Serve menus, assets, and the webapp over HTTPS (self-signed fallback cert generated on first boot, or mount your own)
- Manage Wake-on-LAN entries with live status/IP and a wake scheduler
- Show logs and live metrics
- Provide built-in docs for iPXE and UpOnLAN.xyz
- Support local testing/mirroring of releases and assets
- Create and manage a diskless KVM test VM (UEFI/OVMF) with CPU/RAM sizing, an optional qcow2 disk, a graphical console toggle, and an interactive serial console
- Build serial-enabled iPXE ROMs and boot media (offline, in the container — no external toolchain needed)
The documentation covers both using and operating UpOnLAN.xyz and the PXE/iPXE knowledge needed to deploy it safely. Start with Getting Started, then PXE Basics to understand the DHCP, TFTP, iPXE, HTTPS, firmware, and asset flow. The remaining guides explain UpOnLAN.xyz menu editing, ROM builds, deployment, operations, and troubleshooting.
UpOnLAN.xyz serves the boot environment; it does not configure DHCP. Network-boot setup therefore requires coordinating the documented UpOnLAN.xyz service with your network's DHCP configuration and testing the correct BIOS or UEFI boot target.
As prerequisites:
-
A
podman engineinstalled. -
A libvirt installed.
-
helm command
Usage: ./wakemeup.sh -a <action> [--local]
Allowed Actions
---------------
1. build - build uponlan image
2. deploy [--local] - deploy uponlan container; --local serves local menus/assets from release/output
3. destroy - destroy uponlan container
4. redeploy - redeploy uponlan container
5. logs - display logs from uponlan container
6. connect - connect to uponlan container
7. mirror-assets - build local asset output; set asset_target=<os> to build one set, e.g. asset_target=harvester ./wakemeup.sh -a mirror-assets
8. test - run tests/specs on the host + the full webapp suite inside the container
9. preview - show deployment context and run preflight checks (no deploy)
10. release-menu - build the menu release (release_menu.sh) for the version in release/menus/version.ipxe- 3 types of deployments:
./wakemeup.sh -a deploy # ghcr image + GitHub assets (no build)
./wakemeup.sh -a deploy --build # local build + GitHub assets
./wakemeup.sh -a deploy --local # local build + local assetsUse these when you want to test without guessing:
./wakemeup.sh -a mirror-assets
./wakemeup.sh -a release-menu 0.1.0
./wakemeup.sh -a deploy --local
./wakemeup.sh -a testRelease artifacts come in two layers, split under release/output/:
- menu layer:
release/output/menu/latest+release/output/menu/<version>/menus.tar.gzfromrelease/menus/ - asset layer:
release/output/assets/endpoints.yml+release/output/assets/<asset-key>/...fromrelease/assets/
mirror-assets builds the asset layer of release/output/.
scripts/release_menu.sh <version> builds the menu layer into release/output/.
deploy --local does not build the release artifacts. It serves the already prepared release/output/ on :8899 and deploys the Helm chart with --local.
test runs the release-flow specs in tests/specs/ on the host, then the full webapp suite inside the running container.
asset_target=harvester ./wakemeup.sh -a mirror-assetsUse asset_target to build just one asset set while debugging.
release/output/assets/endpoints.yml is the asset catalog consumed separately from menus.tar.gz.
release/output/ is the single local release layout. Its GitHub counterpart is decoupled: the menu ships as <version> releases and asset bundles as <key> releases (see Deployment).
See Deployment for remote and local deployment, ports, security, and release artifacts. See Operations for logs, recovery, backup, and destructive-operation behavior.
Editing a served iPXE menu does not normally require a new ROM: an existing iPXE boot binary can chain to the menu. Build when the boot binary itself must embed UpOnLAN.xyz's wrapper or start a custom default boot flow, or when you need boot media for a machine that cannot use the existing network-boot path.
In the webapp, open Menus, expand ROM Files, then select Build. Choose the required firmware/media options (Legacy, EFI, ISO, USB) and select Run. scripts/build_ipxe_roms.sh builds the selected custom iPXE binaries and, when selected, hybrid ISO or USB image media — offline, using the iPXE source vendored into the container image; generated files appear in the ROM Files list. See ROM Build for firmware and media selection guidance.