booter

module

v0.3.0 Latest Latest Go to latest Published: Oct 28, 2025 License: MPL-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/siderolabs/booter

Links

Open Source Insights

README ¶

booter

A tool to easily boot Talos machines using PXE.

Usage

Run booter in a container on the host network:

docker run --rm --network host \
  ghcr.io/siderolabs/booter:v0.1.0

Then, power on machines in the same subnet as booter with UEFI PXE boot enabled.
Recommended boot order: disk first, then network.

To connect the machines to Omni, go to the Omni Overview page, click “Copy Kernel Parameters”, and run booter with the copied arguments:

docker run --rm --network host \
  ghcr.io/siderolabs/booter:v0.1.0 \
  <KERNEL_ARGS>

To see more options:

docker run --rm --network host ghcr.io/siderolabs/booter:v0.1.0 --help

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd
booter command Package main implements the main entrypoint for the server.	Package main implements the main entrypoint for the server.
internal
constants Package constants contains global backend constants.	Package constants contains global backend constants.
server Package server implements the DHCP + iPXE server servers.	Package server implements the DHCP + iPXE server servers.
server/config Package config serves machine configuration to the machines that request it via talos.config kernel argument.	Package config serves machine configuration to the machines that request it via talos.config kernel argument.
server/constants Package constants provides constants for the server package.	Package constants provides constants for the server package.
server/dhcp Package dhcp implements DHCP proxy and other DHCP related functionality.	Package dhcp implements DHCP proxy and other DHCP related functionality.
server/imagefactory Package imagefactory provides an abstraction to the image factory for the server.	Package imagefactory provides an abstraction to the image factory for the server.
server/ipxe Package ipxe provides iPXE functionality.	Package ipxe provides iPXE functionality.
server/machineconfig Package machineconfig builds the machine configuration for the server.	Package machineconfig builds the machine configuration for the server.
server/omni
server/server Package server implements the HTTP and GRPC servers.	Package server implements the HTTP and GRPC servers.
server/tftp Package tftp implements a TFTP server.	Package tftp implements a TFTP server.
util Package util provides utility functions.	Package util provides utility functions.
version Package version contains variables such as project name, tag and sha.	Package version contains variables such as project name, tag and sha.