maggesandClaude Sonnet 5
e2fefcdf9c
- versions.env pins podman, conmon, crun, netavark, aardvark-dns, passt, and fuse-overlayfs to verified upstream source checksums; SlackBuild recipes, scripts/build-packages.sh, checksums.sh, release.sh, and update-versions.sh implement the reproducible pipeline; GitHub Actions workflows build in a Slackware container and publish releases without committing any binaries. - plugin/podman.plg installs/updates/removes all eight packages (the seven components plus the plugin's own unraid-podman scaffolding package) via upgradepkg, using the official Unraid array-event hook mechanism (event/disks_mounted, event/stopping) instead of editing /boot/config/go. rc.podman and the sbin/ helper scripts implement storage creation, config seeding/sync, preflight checks, autostart with per-container Safe-Mode, and package verify/update/rollback. - webui/plugins/podman implements the Dashboard, Containers, Pods, Images, Volumes, Networks, Logs, Terminal, Compose, and Settings panels against the approved mockup (webui/mockups/prototype.html), talking to podman system service exclusively via PodmanClient.php (libpod REST API over the Unix socket), with two documented exceptions: Terminal's one-shot exec model and Compose's use of the podman compose CLI, since libpod has no REST equivalent for either. - docs/ARCHITECTURE.md and docs/ROADMAP.md record the design decisions and honest current status (syntax-checked, unit- and integration-tested against fake sockets/servers; not yet run against a real Unraid/Podman/Slackware system). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
73 lines
3.8 KiB
Markdown
73 lines
3.8 KiB
Markdown
# webui/
|
|
|
|
Dynamix-style WebUI pages, following Unraid's plugin GUI convention of
|
|
`/usr/local/emhttp/plugins/<name>/`. `webui/plugins/podman/` is staged to
|
|
that path by the `unraid-podman` scaffolding package (see
|
|
`packages/unraid-podman/unraid-podman.SlackBuild`), which podman.plg installs
|
|
alongside the seven compiled components.
|
|
|
|
**Status: implemented**, covering all ten sections from
|
|
[docs/ARCHITECTURE.md, section 18](../docs/ARCHITECTURE.md#18-zukünftige-webui):
|
|
Dashboard, Containers, Pods, Images, Volumes, Networks, Logs, Terminal,
|
|
Compose, Settings. Not yet exercised against a real Unraid/Podman install —
|
|
see [docs/ROADMAP.md](../docs/ROADMAP.md) for what "implemented" does and
|
|
doesn't cover yet.
|
|
|
|
`webui/mockups/prototype.html` is the static, non-PHP clickable mockup this
|
|
implementation was built against — kept as the visual reference; it is not
|
|
staged into the package.
|
|
|
|
## Structure
|
|
|
|
```
|
|
webui/
|
|
├── mockups/
|
|
│ └── prototype.html # static approved mockup, not shipped
|
|
└── plugins/
|
|
└── podman/
|
|
├── Podman.page # page shell: header, sub-nav, one container per panel
|
|
├── include/
|
|
│ ├── PodmanClient.php # libpod REST API client (talks to podman.sock only)
|
|
│ ├── Config.php # reads podman.cfg (mirrors podman-common.sh)
|
|
│ ├── bootstrap.php # shared include + error handling for ajax/*.php
|
|
│ └── helpers.php # formatting + JSON-response helpers
|
|
├── ajax/ # one endpoint per resource, each require()s bootstrap.php
|
|
│ ├── containers.php # list/start/stop/restart/remove/logs
|
|
│ ├── pods.php
|
|
│ ├── images.php
|
|
│ ├── volumes.php
|
|
│ ├── networks.php
|
|
│ ├── exec.php # Terminal — see its header comment for API scope
|
|
│ ├── compose.php # Compose — the one deliberate CLI exception, see header
|
|
│ ├── settings.php # plugin's own config, not a libpod resource
|
|
│ └── system.php # Dashboard aggregation
|
|
├── javascript/
|
|
│ ├── app.js # shared AJAX helper + sub-tab router
|
|
│ └── <panel>.js # one module per panel, registers with app.js
|
|
├── styles/podman.css # design tokens ported 1:1 from the mockup
|
|
├── event/ # official Unraid array-event hooks (see plugin/event/)
|
|
└── images/ # plugin icon assets
|
|
```
|
|
|
|
## Design constraints (see ARCHITECTURE.md for full rationale)
|
|
|
|
- Every panel talks to `podman system service` over its Unix socket via
|
|
`PodmanClient` — no `exec()`/`shell_exec()` of the `podman` binary
|
|
anywhere in `include/` or in the Containers/Pods/Images/Volumes/Networks/
|
|
Logs endpoints.
|
|
- **Two documented, deliberate exceptions**, not oversights:
|
|
- `ajax/exec.php` (Terminal) uses the real exec REST API, but as
|
|
one-command-in/output-out rather than a true interactive PTY — libpod's
|
|
interactive exec needs a persistent hijacked connection that doesn't
|
|
fit PHP-FPM's request lifecycle. See that file's header comment.
|
|
- `ajax/compose.php` (Compose) shells out to the `podman compose` CLI via
|
|
`proc_open()` with an argv array (never a shell string) — because no
|
|
REST endpoint for Compose exists in libpod at all. See that file's
|
|
header comment.
|
|
- The API socket is root-equivalent; no unauthenticated network exposure
|
|
beyond what Unraid's own WebUI auth already provides — see
|
|
[.github/SECURITY.md](../.github/SECURITY.md).
|
|
- Dark/light mode via CSS custom properties (`prefers-color-scheme` +
|
|
`[data-theme]` override), matching Unraid's own theme mechanism — no
|
|
separate theme toggle inside the plugin page.
|