thaloco/banger
1
Fork 0
Code Pull requests Releases Packages Activity Actions

Refresh daemon docs and mark web UI experimental

Browse source 
internal/daemon/doc.go and ARCHITECTURE.md were written before the
subpackage extractions and still referenced old structure (in-progress
phrasing, missing opstate/dmsnap/fcproc/imagemgr/session/workspace,
mentions of opRegistry by its old name). Both now describe the current
shape: composition root + six leaf subpackages, lock ordering rooted
at vmLocks[id], and the one intra-package dependency (workspace →
session for ShellQuote + FormatStepError).

README.md and AGENTS.md mark the local web UI as experimental. It is
still enabled by default at 127.0.0.1:7777, but the docs now state
plainly that its surface is not stable or hardened and not intended for
anything beyond single-user localhost use. AGENTS.md also points at
ARCHITECTURE.md for the subpackage layout.

No code changes; tests still green.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Thales Maciel 2026-04-15 16:44:11 -03:00
parent 1d51370d26
commit ca4865447c
No known key found for this signature in database
GPG key ID: 33112E6833C34679
4 changed files with 99 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,6 +1,6 @@
# banger
`banger` manages Firecracker development VMs with a local daemon, managed image artifacts, and a localhost web UI.
`banger` manages Firecracker development VMs with a local daemon, managed image artifacts, and an experimental localhost web UI.
## Requirements
@ -152,12 +152,17 @@ If you want reusable orchestration primitives instead of the `vm run` convenienc
`vm session attach` is currently exclusive and same-host only. The daemon exposes a local Unix socket bridge using `stdio_mux_v1`, so only one active attach is allowed at a time. Pipe-mode sessions keep enough guest-side state for the daemon to rebuild that bridge after a daemon restart.
## Web UI
## Web UI (experimental)
`bangerd` serves a local web UI by default at:
`bangerd` serves an experimental local web UI by default at:
- `http://127.0.0.1:7777`
The UI is convenient for local observability but is **not a stable or
supported interface**. Its endpoints, layout, and behaviour may change
without notice, and it has not been hardened for anything beyond single-user
localhost use. Do not expose the listen address to a shared network.
See the effective URL with:
```bash