Developer
c9c72be0b6
PR 4a of the runtime service registry change. - Remove addon pages (/addons/:addonId, AddonPage, addons/*) superseded by service pages. - Remove grafana_url/prometheus_url from backend config, compose, .env.example, and README (URLs now live on service records; VITE_ frontend deep-link vars retained). - Add Services page (/services) with create/list/delete + sidebar nav, so services are configurable in the tool itself and service pages are reachable. - Update docs/REQUIREMENTS.md service-registry section; add CHANGELOG.md with the breaking-upgrade note (MANAGE_ENCRYPTION_KEY required; grafana/prometheus env vars removed; default widget seeding removed). Verification: backend ruff clean, pytest 222 passed; frontend lint 0 errors, build success, 70 tests passed.
2.3 KiB
2.3 KiB
Changelog
All notable changes to Manage. Breaking changes are marked with BREAKING.
[Unreleased]
Added — Service registry
- Runtime service registry persisted in the backend SQLite database. External services (Grafana, Prometheus, Jellyfin, Nextcloud, SSH task runner) are now configured in the app instead of via environment variables.
- Services page (
/services) to create, list, and delete service instances. - Service detail pages (
/services/:serviceType/:serviceId) to edit name/enabled state, rotate secrets, and view the widgets a service provides. - Service definitions live as Pydantic modules in
backend/.../integrations/, each declaring its config schema, secret fields, and widget kinds. - Multi-instance support: multiple Grafana/Jellyfin/etc. instances per type.
- SSH task runner service records run history in a new
service_task_runstable, shown on the runner's service page.
Changed
- Dashboard widgets are now service-bound (reference a service instance + widget kind) or built-in (backups, static text). The "Add widget" flow is pick-service → pick-widget-kind → configure.
- Deleting a service cascade-deletes widgets that reference it.
Security
- Service secrets (API keys, tokens, passphrases) are encrypted at rest with Fernet.
BREAKING
-
MANAGE_ENCRYPTION_KEYis now required to start the backend. Generate one with:python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())" -
The
GRAFANA_URLandPROMETHEUS_URLbackend environment variables were removed; Grafana/Prometheus URLs now live on service records configured in the UI. Re-create them on the Services page after upgrading. -
The legacy widget/addon-pages model (
/addons/:addonId,/api/widgets/types,/api/widgets/sources) was removed in favor of the service registry. -
Default dashboard widget seeding was removed; a fresh install starts with an empty dashboard. Add widgets from the dashboard's edit dialog after configuring services.
Notes / follow-ups
- Machine-level Jellyfin/Jellyseerr app config still powers the Media/Users/Files
pages. Migrating those onto the service registry is a separate follow-up change
(see
openspec/changes/service-registry/design.md§12.5).