Files
truenas-stacks/dev/rackpeek/README.md
2026-05-21 23:16:11 +00:00

47 lines
1.2 KiB
Markdown

# RackPeek source of truth
This directory is the git-tracked RackPeek inventory for the homelab.
## Files
- `config.yaml` — current RackPeek v3 inventory assembled from the homelab docs
## Data sources
Update this inventory from the canonical repo docs first:
- `docs/architecture/ARCHITECTURE_OVERVIEW.md`
- `docs/architecture/SERVICES_DIRECTORY.md`
- `docs/architecture/NETWORKING_MODEL.md`
- `docs/servers/PLAUSIBLEDENABILITY.md`
- `docs/servers/SERENITY.md`
- `docs/servers/NOMAD.md`
- `docs/servers/ROCINANTE.md`
For UniFi-managed network gear, refresh from the validated read-only helper after reconciling the docs:
- `automation/bin/unifi_network.py`
## Runtime wiring
The `dev/docker-compose.yaml` RackPeek service mounts this repo directory directly at `/app/config` on PD:
- host path: `/mnt/docker-ssd/docker/compose/dev/rackpeek`
- container path: `/app/config`
Data protection keys remain outside git at:
- `/mnt/tank/docker/appdata/app/rackpeek/dpkeys`
## Validation
From a repo checkout with Docker available:
```bash
docker run --rm \
-p 18283:8080 \
-e RPK_YAML_DIR=/app/config \
-v "$PWD/dev/rackpeek:/app/config" \
aptacode/rackpeek:latest
```
Then verify:
```bash
curl http://127.0.0.1:18283/health
```
Expected response: `rackpeek`