mirror of
https://github.com/Crosstalk-Solutions/project-nomad.git
synced 2026-10-17 13:19:18 +02:00
Add NOMAD-specific getting-started docs for all 9 curated Supply Depot apps,
the catalog/install fixes each one surfaced, and a way to reach the docs from
each app card.
Docs:
- New in-app Markdoc page admin/docs/supply-depot-apps.md covering all 9 apps
(Stirling PDF, File Browser, Calibre-Web, IT Tools, Excalidraw, Homebox,
Vaultwarden, Jellyfin, Meshtastic Web): first run/login, where data lives,
and offline behaviour. Registered in docs_service DOC_ORDER.
- Manage > Docs dropdown item linking each app to its section
(/docs/supply-depot-apps#<anchor>): anchor map in constants/supply_depot_docs.ts,
heading anchors via Markdoc {% #id %}, and hash-scroll on the docs page.
Install / catalog fixes:
- Stirling PDF: open straight to the tools (SECURITY_ENABLELOGIN=false; the old
v1 DOCKER_ENABLE_SECURITY flag was dead).
- File Browser: seed a known admin/nomad login (bcrypt) instead of a random
log-only password; scope visibility to content folders via mount selection and
move the DB out of the browsable root.
- Calibre-Web: bundle an empty Calibre library and seed it on install so setup
doesn't dead-end at db config (_runPreinstallActions__CalibreWeb).
- Homebox: swap the archived hay-kot image for the maintained sysadminsmedia fork.
- Vaultwarden: generate a self-signed cert on install and serve HTTPS by default
(_runPreinstallActions__Vaultwarden + ROCKET_TLS + ui_location https:8480), so
the web vault has the secure context it requires.
- Jellyfin: pre-create storage/media/{Movies,TV Shows,Music,Photos} so each
library points at its own subfolder, avoiding the overlapping-path issue that
silently hides content (_runPreinstallActions__Jellyfin).
- Seeder run() now also syncs ui_location for non-modified curated services, so a
catalog link/scheme/port change reaches existing installs on update.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
20 lines
932 B
Markdown
20 lines
932 B
Markdown
# Empty Calibre library (Calibre-Web seed)
|
|
|
|
`metadata.db` is an empty Calibre library database, generated once with
|
|
`calibredb --with-library <dir> list` (calibre 9.9).
|
|
|
|
Calibre-Web cannot create a library from scratch. On a fresh NOMAD it would dead-end
|
|
at the "Database Configuration" page asking for an existing Calibre database. To avoid
|
|
that, the Calibre-Web pre-install action seeds this file into `storage/books` (only when
|
|
no `metadata.db` is already there) and hands ownership to the container's user, so the
|
|
user just points Calibre-Web at `/books` once and starts adding books.
|
|
|
|
This file is bundled into the admin image via the Dockerfile and copied at install time
|
|
by `DockerService._runPreinstallActions__CalibreWeb()`. To regenerate it:
|
|
|
|
```sh
|
|
docker run --rm -v "$PWD/lib:/books" --entrypoint bash lscr.io/linuxserver/calibre:latest \
|
|
-c "calibredb --with-library /books list"
|
|
# then copy lib/metadata.db here
|
|
```
|