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`.
67 lines
2.3 KiB
YAML
67 lines
2.3 KiB
YAML
# docker-compose for local / homelab deployment.
|
|
#
|
|
# Two usage patterns:
|
|
#
|
|
# 1. Local MVP test — host network, proxy-DHCP off (don't fight your
|
|
# existing DHCP server on the LAN), TFTP + HTTP exposed on the host:
|
|
#
|
|
# docker compose up openpxe-dev
|
|
#
|
|
# 2. Real PXE deployment — host network, proxy-DHCP on, runs on a box
|
|
# plugged into the PXE network:
|
|
#
|
|
# # First set OPENPXE_PUBLIC_IP to this host's LAN address in .env
|
|
# docker compose up openpxe
|
|
#
|
|
# On Linux hosts, `network_mode: host` gives the container direct access to
|
|
# the physical NIC — required for DHCP proxy because CNI overlays and Docker
|
|
# bridges do not forward DHCPDISCOVER broadcasts into containers.
|
|
#
|
|
# On macOS / Windows hosts, `network_mode: host` is limited — the daemon
|
|
# runs in a Linux VM (Colima/Docker Desktop) so the "host" network is the
|
|
# VM, not your Mac. Proxy-DHCP is not feasible on macOS; use `openpxe-dev`
|
|
# with published ports and set DHCP-MODE=disabled.
|
|
|
|
services:
|
|
# Real PXE deployment (Linux hosts).
|
|
openpxe:
|
|
image: openpxe:0.1.0
|
|
build:
|
|
context: .
|
|
dockerfile: deploy/docker/Dockerfile
|
|
restart: unless-stopped
|
|
network_mode: host
|
|
environment:
|
|
# REQUIRED on multi-homed hosts. Set to this machine's LAN IP so the
|
|
# advertised iPXE URLs actually resolve from the PXE clients. Without
|
|
# this, OpenPXE will refuse to start rather than advertise a
|
|
# loopback address that can't be reached.
|
|
OPENPXE_PUBLIC_IP: ${OPENPXE_PUBLIC_IP:?set this to the host LAN IP}
|
|
OPENPXE_DHCP_MODE: proxy
|
|
OPENPXE_LOG: info
|
|
volumes:
|
|
- ./data/isos:/var/lib/openpxe/isos
|
|
- ./data/work:/var/lib/openpxe/work
|
|
|
|
# Dev / MVP container: published ports, DHCP disabled, HTTP on 8080.
|
|
# Use this on laptops where you want to curl the API or UI without
|
|
# running an actual PXE chain.
|
|
openpxe-dev:
|
|
image: openpxe:0.1.0
|
|
build:
|
|
context: .
|
|
dockerfile: deploy/docker/Dockerfile
|
|
environment:
|
|
OPENPXE_PUBLIC_IP: ${OPENPXE_PUBLIC_IP:-127.0.0.1}
|
|
OPENPXE_DHCP_MODE: disabled
|
|
OPENPXE_HTTP_PORT: "8080"
|
|
OPENPXE_TFTP_PORT: "6969"
|
|
OPENPXE_DHCP_PORT: "6767"
|
|
OPENPXE_LOG: info,openpxe=debug
|
|
ports:
|
|
- "8080:8080/tcp"
|
|
- "6969:6969/udp"
|
|
volumes:
|
|
- ./data/isos:/var/lib/openpxe/isos
|
|
- ./data/work:/var/lib/openpxe/work
|