Frank
e3eb5334cb
- Dankserver stack: RomM, Copyparty, Calibre-Web, node-exporter - Dankclaw stack: Gluetun VPN (SearXNG tunnel), SearXNG+Valkey, ComfyUI (CPU backend), OpenWebUI, Hermes, Gitea+Postgres (migrated), Caddy reverse proxy, Grafana+Prometheus+Loki+Alloy observability - Caddyfiles with .local hostname convention and basicauth homepage - bind-mount storage policy, no named volumes - deploy.sh mirroring vllmScripts git workflow (push -> pull -> restart -> health) - docs/ Obsidian vault: per-service docs from frank-default-small research subagents (promtail EOL -> Alloy; gitea SECRET_KEY preservation; ComfyUI --cpu) - bats test suite at 6 seams — 22 tests green
46 lines
1.6 KiB
Markdown
46 lines
1.6 KiB
Markdown
# RomM
|
|
|
|
RomM (ROM Manager) is a self-hosted rom manager and player for retro game collections. It scans a ROM library, enriches it with metadata and cover art, and serves it through a clean web UI.
|
|
|
|
**Host:** Dankserver — **Hostname:** `romm.dankserver.local` — **Docs:** https://docs.romm.app
|
|
|
|
## Facts (from research)
|
|
|
|
| Item | Value |
|
|
|------|-------|
|
|
| Image | `ghcr.io/rommapp/romm:latest` |
|
|
| Port | 8085 (host) → 8080 (container) |
|
|
| Data volume | config, cache, covers, metadata DB |
|
|
| ROMs volume | bind mount to the game library |
|
|
| Frontend | React; backend FastAPI/Node |
|
|
| Metadata | Screenscraper, IGDB, MobyGames, RAHasher (optional) |
|
|
|
|
## Configuration
|
|
|
|
- Set `ROMM_USERNAME`, `ROMM_PASSWORD`, `ROMM_SECRET_KEY` on first boot (creates the admin user).
|
|
- `DISABLE_AUTH: true` disables authentication for LAN-only deployments (not recommended behind Caddy auth).
|
|
- Bind-mount the ROM library read-only unless RomM should also manage folder structure.
|
|
- Metadata providers need API keys; set them in the RomM admin UI after first login.
|
|
|
|
## Volumes
|
|
|
|
| Container path | Host path (convention) |
|
|
|----------------|------------------------|
|
|
| `/romm/library` | `/opt/romm/library` |
|
|
| `/romm/resources` | `/opt/romm/resources` |
|
|
|
|
## Healthcheck
|
|
|
|
Expose a `/health` endpoint; RomM serves the UI on `/`.
|
|
|
|
## Gotchas
|
|
|
|
- The first login sets the admin password; do not rely on the env credentials after that.
|
|
- Database is SQLite by default — back it up with the resources volume.
|
|
- RAHasher build increases image build time; skip unless RetroAchievements hashes are needed.
|
|
|
|
## See Also
|
|
|
|
- [[Dankserver Stack]]
|
|
- [[Calibre-Web]] — sibling library web UI
|