pi-agent-dashboard / docker
AGENTS.md349 starsChanged 23 days agoMITView on GitHub
Files in this directory. One row per file. Non-source area. Subdir files owned by their own AGENTS.md (acme-test/, fixtures/, scripts/). See change: migrate-file-index-to-agents-tree. See change: fold-oversized-agents-directories.
- Reads credentials
In this repository14 other files it gives its agents.
- AGENTS.mdAGENTS.md
- docs/AGENTS.mdAGENTS.md
- .github/codeql/AGENTS.mdAGENTS.md
- .github/codeql/extensions/AGENTS.mdAGENTS.md
- .github/verdaccio/AGENTS.mdAGENTS.md
- .github/workflows/AGENTS.mdAGENTS.md
- mockups/AGENTS.mdAGENTS.md
- presentations/AGENTS.mdAGENTS.md
- public/AGENTS.mdAGENTS.md
- qa/AGENTS.mdAGENTS.md
- scripts/AGENTS.mdAGENTS.md
- spike/AGENTS.mdAGENTS.md
- tests/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
The file
Files
DOX — docker
Files in this directory. One row per file. Non-source area. Subdir files owned by their own AGENTS.md (acme-test/, fixtures/, scripts/). See change: migrate-file-index-to-agents-tree. See change: fold-oversized-agents-directories.
| File | Purpose |
.env.example | Container env knobs, each commented. API keys, DASHBOARD_PORT, PI_GATEWAY_PORT, PI_GATEWAY_BIND,… → see .env.example.AGENTS.md |
.gitignore | Excludes .env + compose.override.yml (user-specific). See change: docker-packaging. |
compose.dev.yml | Dev overlay. Bind-mounts source, anonymous node_modules volume keeps Linux node-pty, exposes 5173, NODE_ENV=development, command start --dev. See change: docker-packaging. |
compose.override.yml.example | Power-user template. Path-identical workspace binds, :ro example, PI_DASHBOARD_PIN_DIRS. Copy to compose.override.yml. See change: docker-packaging. |
compose.kroki.yml | Kroki diagram rendering overlay. Adds yuzutech/kroki with KROKI_SAFE_MODE=secure and no host ports, atomically sets KROKI_URL=http://kroki:8000 on pi-dashboard. See change: diagram-rendering. |
compose.test.acme.yml | Opt-in ACME DNS-01 overlay via TEST_EXTRA_COMPOSE. Pebble + challtestsrv + cf-shim + acme-dns double, .test aliases, NODE_EXTRA_CA_CERTS… → see compose.test.acme.yml.AGENTS.md |
compose.test.peer.yml | Opt-in two-dashboard overlay via TEST_EXTRA_COMPOSE: second dashboard pi-dashboard-peer (own tmpfs peer-state ⇒ own identity, mDNS on, not published), both containers get dummy bridge0 = 192.168.64.1/24 (NET_ADMIN). → see compose.test.peer.yml.AGENTS.md |
compose.test.cap.yml | Overlay-mode capability layer. Grants cap_add: [SYS_ADMIN] for mount -t overlay in test-entrypoint.sh. → see compose.test.cap.yml.AGENTS.md |
compose.test.yml | Test overlay on compose.yml. Sets PI_DASHBOARD_NO_MDNS=1, DASHBOARD_PORT="${DASHBOARD_PORT:-18000}",… → see compose.test.yml.AGENTS.md |
compose.yml | Base compose. Service pi-dashboard, init:true, env-driven ports, named volumes pi-state→/home/pi/.pi… → see compose.yml.AGENTS.md |
Dockerfile | Multi-stage. base: node:26-bookworm-slim +… → see Dockerfile.AGENTS.md |
peer-entrypoint.sh | Peer-overlay entrypoint: creates dummy bridge0 from PI_PEER_BRIDGE_ADDR (installs iproute2 on demand), then exec test-entrypoint.sh. See change: harden-peer-address-identity. |
entrypoint.sh | Runs seed-auth.js, seeds spawnStrategy into config.json first-run-only, starts tmux server, enrolls zrok v2… → see entrypoint.sh.AGENTS.md |
harness-audit.sh | Records docker events (create/start/die/destroy/kill) for the pi-dash-test-* label set into a file, so a container destroyed by a non-repo actor (#451 part 1) leaves evidence. harness-audit.sh <outfile>; start before test-up.sh. See change: stabilize-browser-e2e. Project-scoped mode harness-audit.sh <outfile> <project> (what test-up.sh launches before compose up): records only that project, lines carry id=<container id>, appends boot <ISO> <project> <id>; ARMED rule — unarmed until its container is seen, then exits on the first empty poll (PI_HARNESS_AUDIT_POLL_SECS, default 30); hard cap PI_HARNESS_AUDIT_MAX_SECS (default 12 h); exits at once when docker events cannot be opened. Unscoped mode unchanged. See change: add-missing-ci-legs (#451). |
lib-ports.sh | Sourced pure-helper lib. Exports derive_hash(cwd) (cksum), derive_project(cwd) -> pi-dash-test-<hash>,… → see lib-ports.sh.AGENTS.md |
README.md | User guide. Quick-start, config table, path-identical workspace mounts, volume perf profiles, gateway access, dev mode, Electron remote mode. See change: docker-packaging. Gains Memory Sizing & Container Limits: 1536 MB heap implies ~2.5-3 GB RSS (~1.07 GB lives outside V8); a limit below that is SIGKILLed before V8 reaches its ceiling — no heap dump, no GC telemetry, no FATAL ERROR line. Floor 4 GB; compose.yml already ships MEM_LIMIT:-4g. 4 GB is SHARED with co-tenants. Bare host ≤2 GB is a named gap. See change: bound-session-heap-and-gc-telemetry. Gains Credential key volume (pi-key): key file on its own volume, generation/refusal rules, docker run MUST mount /home/pi/.pi-key as a NAMED volume, back up separately, Compose secrets are 0444 → copy to 0600, not a sandbox, Linux keyring licence ships. See change: encrypt-credentials-at-rest. |
supervise-daemon.sh | supervise_daemon <pidfile> [label] — keeps PID 1 alive for a DETACHED dashboard daemon, sourced by BOTH… → see supervise-daemon.sh.AGENTS.md |
test-down.sh | Teardown. Re-derives COMPOSE_PROJECT_NAME from $PWD via lib-ports.sh cksum. → see test-down.sh.AGENTS.md |
test-entrypoint.sh | Test entrypoint wrapper. HOST_CWD set → mounts overlayfs (lower /mnt/test-lower ro, upper/work tmpfs) at… → see test-entrypoint.sh.AGENTS.md Seeds the windowed-session fixture via scripts/seed-sessions-window.mjs under PI_E2E_SEED. See change: fix-connect-snapshot-frame-loss. PI_E2E_TRUST_MODE=pair seeds network.trustMode=pair + pairing.acceptLanRequests=true before boot (variant harness; passthrough in test-up.sh + compose.test.yml). See change: surface-network-denial-on-health. |
test-up.sh | Spin-up. Sources lib-ports.sh. Exports HOST_CWD=$PWD. Derives stable port pair + COMPOSE_PROJECT_NAME… → see test-up.sh.AGENTS.md |
TESTING.md | Runbook for disposable isolated test harness. Quick start. → see TESTING.md.AGENTS.md |
up.sh | Workspace launcher. Parses PI_WORKSPACES path-separator list, one path-identical -v dir:dir RW bind per… → see up.sh.AGENTS.md |
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

