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`.
115 lines
4.1 KiB
Bash
Executable File
115 lines
4.1 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# build-and-publish-unraid.sh — one-shot: clone OpenPXE, build the image,
|
|
# push it to your local Gitea container registry. Run this ON the Unraid
|
|
# box (or any host that can reach Gitea on http://localhost:3000 or its
|
|
# LAN IP). No Cloudflare in the way; the proxy doesn't matter for this
|
|
# path.
|
|
#
|
|
# Inputs (env vars, all optional except GITEA_TOKEN):
|
|
# GITEA_TOKEN personal access token with `write:package` scope
|
|
# GITEA_HOST default: localhost:3000 (use 192.168.1.49:3000 if
|
|
# you're on the LAN but not on the Unraid host)
|
|
# GITEA_OWNER default: mward4
|
|
# GITEA_REPO default: OpenPXE
|
|
# IMAGE_TAG default: 0.1.0 (also tagged :latest)
|
|
# PLATFORM default: linux/amd64 (Unraid is x86_64)
|
|
# WORKDIR default: /tmp/openpxe-build (deleted on success)
|
|
#
|
|
# What it does:
|
|
# 1. git clone <gitea>/mward4/OpenPXE.git into WORKDIR
|
|
# 2. fetch iPXE binaries (scripts/fetch-ipxe.sh)
|
|
# 3. docker build deploy/docker/Dockerfile -> openpxe:$TAG (and :latest)
|
|
# 4. docker login to GITEA_HOST using the token
|
|
# 5. docker push to <gitea>/<owner>/openpxe:<tag> and :latest
|
|
# 6. docker logout, scrub creds, clean WORKDIR
|
|
#
|
|
# After this, on any Unraid Docker template, set:
|
|
# Repository: <gitea>/mward4/openpxe:0.1.0 (or :latest)
|
|
# Network: host (DHCP/TFTP need raw L2)
|
|
|
|
set -euo pipefail
|
|
|
|
GITEA_HOST=${GITEA_HOST:-localhost:3000}
|
|
GITEA_OWNER=${GITEA_OWNER:-mward4}
|
|
GITEA_REPO=${GITEA_REPO:-OpenPXE}
|
|
IMAGE_TAG=${IMAGE_TAG:-0.1.0}
|
|
PLATFORM=${PLATFORM:-linux/amd64}
|
|
WORKDIR=${WORKDIR:-/tmp/openpxe-build}
|
|
|
|
# Lowercase the image name — OCI distribution rejects uppercase paths.
|
|
IMAGE_NAME="$(printf '%s' "$GITEA_REPO" | tr '[:upper:]' '[:lower:]')"
|
|
FULL_TAG="$GITEA_HOST/$GITEA_OWNER/$IMAGE_NAME:$IMAGE_TAG"
|
|
LATEST_TAG="$GITEA_HOST/$GITEA_OWNER/$IMAGE_NAME:latest"
|
|
|
|
if [[ -z "${GITEA_TOKEN:-}" ]]; then
|
|
echo "ERROR: set GITEA_TOKEN to a token with write:package scope." >&2
|
|
echo " Gitea -> Settings -> Applications -> Generate New Token." >&2
|
|
exit 2
|
|
fi
|
|
|
|
# Required tools — fail loudly upfront so the operator doesn't wait
|
|
# 20 minutes on a build that was going to fail at `docker push`.
|
|
for tool in git docker; do
|
|
command -v "$tool" >/dev/null 2>&1 \
|
|
|| { echo "ERROR: '$tool' not found in PATH" >&2; exit 2; }
|
|
done
|
|
|
|
# Use a private docker config so the credential never lands in
|
|
# ~/.docker/config.json on the Unraid box. We blow it away in the
|
|
# trap below.
|
|
DOCKER_CONFIG="$(mktemp -d)"
|
|
export DOCKER_CONFIG
|
|
trap 'rm -rf "$DOCKER_CONFIG"; rm -rf "$WORKDIR"' EXIT
|
|
|
|
echo
|
|
echo "==> Workspace : $WORKDIR"
|
|
echo "==> Gitea host : $GITEA_HOST"
|
|
echo "==> Image to push : $FULL_TAG"
|
|
echo "==> Platform : $PLATFORM"
|
|
echo
|
|
|
|
# Step 1: clone (shallow — we don't need history for a build).
|
|
rm -rf "$WORKDIR"
|
|
git -c "http.extraHeader=Authorization: token $GITEA_TOKEN" \
|
|
clone --depth 1 \
|
|
"http://$GITEA_HOST/$GITEA_OWNER/$GITEA_REPO.git" "$WORKDIR"
|
|
|
|
cd "$WORKDIR"
|
|
|
|
# Step 2: fetch iPXE binaries. The Dockerfile's first stage will also do
|
|
# this, but doing it once here means a re-run with a hot Docker cache
|
|
# skips the apt-get install + GitHub fetch entirely.
|
|
bash scripts/fetch-ipxe.sh
|
|
|
|
# Step 3: build. We don't need buildx for a same-arch build on Unraid,
|
|
# but we use --pull so a stale cached `rust:1.82-bookworm` doesn't bake
|
|
# in a CVE that's been fixed upstream.
|
|
docker build \
|
|
--pull \
|
|
--platform "$PLATFORM" \
|
|
--file deploy/docker/Dockerfile \
|
|
--tag "$FULL_TAG" \
|
|
--tag "$LATEST_TAG" \
|
|
.
|
|
|
|
# Step 4: login. --password-stdin keeps the token out of `ps` output and
|
|
# bash history. The token still lands in $DOCKER_CONFIG/config.json
|
|
# (base64-encoded) but that dir is ours and gets nuked by the trap.
|
|
printf '%s' "$GITEA_TOKEN" | docker login \
|
|
--username "$GITEA_OWNER" \
|
|
--password-stdin \
|
|
"$GITEA_HOST"
|
|
|
|
# Step 5: push both tags.
|
|
docker push "$FULL_TAG"
|
|
docker push "$LATEST_TAG"
|
|
|
|
# Step 6: logout (best-effort; if it fails the trap still scrubs).
|
|
docker logout "$GITEA_HOST" || true
|
|
|
|
echo
|
|
echo "==> Done. Pull from Unraid templates with:"
|
|
echo " $FULL_TAG"
|
|
echo " $LATEST_TAG"
|
|
echo
|