Miles Ward
e3452fe976
Full rename to match the openpxe.com brand. The product now reads as a
polished open-source project rather than a personal-tool nickname:
the anvil/forge metaphor is gone, replaced with the rainbow-horizon
brand mark from the marketing site.
## Naming changes
**PXEForge → OpenPXE** everywhere it's user-visible or developer-
facing:
- All 8 crate package names (`pxeforge-*` → `openpxe-*`).
- The bin crate dir + binary (`crates/pxeforge` → `crates/openpxe`,
`bin = "openpxe"`).
- Env vars: `PXEFORGE_*` → `OPENPXE_*` (no compat shim — pre-beta).
- Tracing targets: `pxeforge::*` → `openpxe::*`.
- Prometheus metrics: `pxeforge_*` → `openpxe_*` (pre-beta; nobody
has dashboards on these yet).
- Container image: `gitea.milesward.dev/mward4/openpxe:0.3.0`.
- All in-tree paths: `/var/lib/openpxe/{isos,work,smb}`,
`/usr/share/openpxe/ipxe`, `/etc/openpxe/...`.
- Unraid template renamed `pxeforge.xml` → `openpxe.xml`.
- README, NEXT_PHASE.md, architecture.md, comments, and the WebUI
brand string.
**Gated Deployment → Queued Deployment** as the user-facing concept:
- `Settings::TimeoutAction::GatedDeployment` →
`QueuedDeployment` (with `#[serde(alias = "gated_deployment")]`
so v0.2.0 settings.json files keep deserializing).
- Rust types: `Gate` → `QueueEntry`, `GateQueue` → `DeploymentQueue`,
`GateInner` → `QueueEntryInner`.
- File: `crates/core/src/gate.rs` → `crates/core/src/queue.rs`.
- HTTP routes: `/api/gate/*` → `/api/queue/*`. The JSON list key
flipped from `"gates"` to `"entries"` to match.
- iPXE shortcut: `/boot/_gate.ipxe` → `/boot/_queue.ipxe`. The
top-level menu's item id is now `queue` instead of `gate`.
- WebUI sidebar tab: "Forge Gate" → "Queue".
- Field on `AppState`: `gates` → `queue`.
## Brand assets
The anvil + forging-sparks logos are dropped:
- `logo.svg` is now a 24×24 medallion filled with the
`rainbow-horizon` gradient from openpxe.com (sliding hue rotation
via SMIL on the gradient stops, no JS needed).
- `anvil-forge.svg` renamed to `loader.svg` and rebuilt as a 64×64
louder version of the same disc — used for page-load transitions
and the imaging-progress widget. Adds a subtle scale pulse and a
white inner-glow so it has dimensionality on either theme.
## CSS rename
- `.forge-progress` → `.queue-progress`
- `.forge-progress .anvil` → `.queue-progress .mark`
- `@keyframes forge-sheen` → `queue-sheen`
- `.loader .anvil` → `.loader .mark`
- "Heating the forge…" loader text → "Loading…"
The rest of the layout is untouched. Light/dark theme tokens and the
sidebar/topbar structure carry over from v0.2.0 unchanged — the
brief was "keeping the UI similar."
## Validation
- `cargo build --workspace` — clean.
- `cargo clippy --workspace --all-targets` — no warnings.
- `cargo test --workspace` — **66 tests passing**, same as v0.2.0.
- Local smoke run against the rebuilt release binary verifies:
- `/boot.ipxe` emits `Queued Deployment` + `item queue` + chains
`/boot/_queue.ipxe`
- `/api/queue` returns `{count, entries}`
- `/metrics` emits `openpxe_queue_count` (renamed)
- `/assets/logo.svg` and `/assets/loader.svg` serve the new
rainbow brand SVGs
- `/api/status` reports version `0.3.0`
## Migration notes for operators on v0.2.0
- Container image path changed: pull
`gitea.milesward.dev/mward4/openpxe:0.3.0` (not `pxeforge:`).
- Bind mounts: `/var/lib/openpxe/{isos,work,smb}` (not `pxeforge`).
Move the host path or update the template.
- Env vars: replace `PXEFORGE_*` with `OPENPXE_*`. The Unraid
template at `deploy/unraid/openpxe.xml` is already updated.
- `settings.json` carries over transparently — the
`gated_deployment` value is accepted as an alias.
- HTTP API: any external scripts that hit `/api/gate/*` need to
switch to `/api/queue/*`. The JSON envelope key is `entries`
instead of `gates`.
76 lines
3.7 KiB
XML
76 lines
3.7 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
Unraid Docker template for OpenPXE.
|
|
|
|
Drop this file into /boot/config/plugins/dockerMan/templates-user/
|
|
on your Unraid box (or import via the Docker tab → "Add Container" →
|
|
"Template Repositories" if you publish it on a Gitea raw URL).
|
|
|
|
IMPORTANT: OpenPXE needs host networking for DHCP/TFTP raw broadcasts.
|
|
Bridge mode will NOT work — clients can't see broadcast DHCP from a
|
|
bridged container. The template forces NetworkType=host below.
|
|
|
|
Required ports (already host-bound by the binary; no Unraid mapping
|
|
needed in host mode):
|
|
udp/67 DHCP proxy
|
|
udp/69 TFTP
|
|
udp/4011 PXE Boot Server
|
|
tcp/80 HTTP (web UI + iPXE scripts + ISO range streaming)
|
|
tcp/445 SMB (only when Windows boot is toggled on)
|
|
|
|
Web UI: http://<unraid-ip>/ (port 80)
|
|
-->
|
|
<Container version="2">
|
|
<Name>OpenPXE</Name>
|
|
<Repository>gitea.milesward.dev/mward4/openpxe:latest</Repository>
|
|
<Registry>https://gitea.milesward.dev/mward4/-/packages/container/openpxe</Registry>
|
|
<Network>host</Network>
|
|
<MyIP/>
|
|
<Shell>sh</Shell>
|
|
<Privileged>false</Privileged>
|
|
<Support>https://gitea.milesward.dev/mward4/OpenPXE/issues</Support>
|
|
<Project>https://gitea.milesward.dev/mward4/OpenPXE</Project>
|
|
<Overview>
|
|
Air-gapped network PXE boot server. Container-native Rust
|
|
implementation — DHCP proxy + TFTP + iPXE chainload + HTTP ISO
|
|
streaming, all in one process. Web UI for ISO upload, NFS share
|
|
mounting, and Queued Deployment ("horse-race" simultaneous launch
|
|
of one ISO across many waiting clients).
|
|
|
|
NEVER touches the client OS trust store: no test-signed drivers,
|
|
no testsigning toggle, no httpdisk.sys. Windows boot uses vanilla
|
|
Microsoft-signed WinPE + SMB share.
|
|
</Overview>
|
|
<Category>Network:Other Network:Management</Category>
|
|
<WebUI>http://[IP]/</WebUI>
|
|
<TemplateURL/>
|
|
<Icon>https://gitea.milesward.dev/mward4/OpenPXE/raw/branch/main/crates/webui/src/logo.svg</Icon>
|
|
<ExtraParams>--cap-add=NET_BIND_SERVICE</ExtraParams>
|
|
<PostArgs/>
|
|
<CPUset/>
|
|
<DateInstalled/>
|
|
<DonateText/>
|
|
<DonateLink/>
|
|
<Requires>
|
|
Host networking. Unraid's built-in DHCP server (if any) must
|
|
not collide with a network that already has DHCP — OpenPXE runs
|
|
in proxy mode and coexists, but only one DHCP _proxy_ should reply
|
|
per broadcast domain.
|
|
</Requires>
|
|
<Config Name="ISOs" Target="/var/lib/openpxe/isos" Default="/mnt/user/appdata/openpxe/isos"
|
|
Mode="rw" Description="Where uploaded and seeded .iso files live."
|
|
Type="Path" Display="always" Required="true" Mask="false">/mnt/user/appdata/openpxe/isos</Config>
|
|
<Config Name="Work dir" Target="/var/lib/openpxe/work" Default="/mnt/user/appdata/openpxe/work"
|
|
Mode="rw" Description="Settings, NFS state, and runtime scratch. Persisted across restarts."
|
|
Type="Path" Display="always" Required="true" Mask="false">/mnt/user/appdata/openpxe/work</Config>
|
|
<Config Name="SMB share root" Target="/var/lib/openpxe/smb" Default="/mnt/user/appdata/openpxe/smb"
|
|
Mode="rw" Description="Where extracted Windows install media lives. Only used when Windows toggle is on."
|
|
Type="Path" Display="advanced" Required="false" Mask="false">/mnt/user/appdata/openpxe/smb</Config>
|
|
<Config Name="Public IP" Target="OPENPXE_PUBLIC_IP" Default=""
|
|
Mode="" Description="IP advertised to PXE clients. Leave blank to auto-detect; set explicitly on multi-homed Unraid hosts."
|
|
Type="Variable" Display="always" Required="false" Mask="false"></Config>
|
|
<Config Name="Log filter" Target="OPENPXE_LOG" Default="info,openpxe=debug"
|
|
Mode="" Description="tracing-subscriber EnvFilter expression."
|
|
Type="Variable" Display="advanced" Required="false" Mask="false">info,openpxe=debug</Config>
|
|
</Container>
|