mward4/OpenPXE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 40 Wiki Activity

Updated Readme.md

Browse Source
This commit is contained in:
mward4
2026-06-05 04:23:42 -04:00
parent dcdf0b6fd0
commit 019acc71ac
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -7
View File
@@ -23,7 +23,7 @@
--- ---
OpenPXE turns bare-metal provisioning into a single container with a web UI. It's a OpenPXE turns bare-metal provisioning into a single container with a web UI. It's a work in progress
ground-up Rust reimplementation of [iVentoy (ventoy/PXE)](https://github.com/ventoy/PXE), ground-up Rust reimplementation of [iVentoy (ventoy/PXE)](https://github.com/ventoy/PXE),
designed for Docker/OCI and OpenShift instead of a Windows desktop — so it drops onto designed for Docker/OCI and OpenShift instead of a Windows desktop — so it drops onto
an Unraid box, a Linux server, or a Kubernetes cluster and just runs. an Unraid box, a Linux server, or a Kubernetes cluster and just runs.
@@ -32,7 +32,7 @@ Upload `.iso` files (or point at a remote share), and any machine on the network
them — Linux installers, live tools, or stock Windows setup — with **zero iPXE knowledge them — Linux installers, live tools, or stock Windows setup — with **zero iPXE knowledge
required by the operator.** required by the operator.**
> **Status — v0.5.5, late pre-beta.** The full PXE stack, web UI, remote ISO libraries > **Status — v0.5.8, late pre-beta.** The full PXE stack, web UI, remote ISO libraries
> (SMB/NFS/SFTP), Windows deployment, queued fleet rollout, SAML SSO, and Prometheus > (SMB/NFS/SFTP), Windows deployment, queued fleet rollout, SAML SSO, and Prometheus
> metrics are implemented and test-covered. The release checklist gates every tag on the > metrics are implemented and test-covered. The release checklist gates every tag on the
> full test suite + `clippy`. Currently in real-hardware validation. > full test suite + `clippy`. Currently in real-hardware validation.
@@ -120,14 +120,14 @@ docker build -f deploy/docker/Dockerfile -t openpxe:0.5.5 .
# proxy mode so the container sees DHCPDISCOVER broadcasts; set PUBLIC_IP to this # proxy mode so the container sees DHCPDISCOVER broadcasts; set PUBLIC_IP to this
# host's LAN address so advertised boot URLs are reachable. # host's LAN address so advertised boot URLs are reachable.
docker run -d --name openpxe --network host \ docker run -d --name openpxe --network host \
-e OPENPXE_PUBLIC_IP=10.0.0.5 \ -e OPENPXE_PUBLIC_IP=10.0.0.5:4200 \
-e OPENPXE_DHCP_MODE=proxy \ -e OPENPXE_DHCP_MODE=proxy \
-v $PWD/data/isos:/var/lib/openpxe/isos \ -v $PWD/data/isos:/var/lib/openpxe/isos \
-v $PWD/data/work:/var/lib/openpxe/work \ -v $PWD/data/work:/var/lib/openpxe/work \
openpxe:0.5.5 openpxe:0.5.8
# Open the UI and drop an ISO in. # Open the UI and drop an ISO in.
open http://10.0.0.5 open http://10.0.0.5:4200
``` ```
> On macOS/Windows, Docker runs inside a Linux VM, so "host network" means the VM — use > On macOS/Windows, Docker runs inside a Linux VM, so "host network" means the VM — use
@@ -147,8 +147,8 @@ cargo run --release # needs root or CAP_NET_BIND_SERVICE for :80/:6
docker run --rm \ docker run --rm \
-v /my/iso-library:/seed:ro \ -v /my/iso-library:/seed:ro \
-v openpxe-data:/var/lib/openpxe/isos \ -v openpxe-data:/var/lib/openpxe/isos \
-e OPENPXE_PUBLIC_IP=10.0.0.5 \ -e OPENPXE_PUBLIC_IP=10.0.0.5:4200 \
openpxe:0.5.5 seed --from /seed # add --dry-run to preview openpxe:0.5.8 seed --from /seed # add --dry-run to preview
``` ```
## Remote ISO libraries ## Remote ISO libraries