homelab-inventory

KO | EN

gitlite — search

#bash #nextjs #developer-tools #pdf #shell #markdown #python #automation #ai #ai-agents

homelab-inventory

(★ 9)

Self-hosted visual inventory and cabling workbench for homelab hardware.

File Explorer

ZIP Download

- pre-push
- - bug_report.yml
  - config.yml
  - feature_request.yml
- - ci.yml
  - codeql-scheduled.yml
  - docker-security-monitor.yml
- dependabot.yml
- pull_request_template.md
- agent-artifact.Dockerfile
- wasm-artifact.Dockerfile
- - catalog-protocol-0.1.0-publication.md
  - catalog-protocol-0.1.1-publication.md
  - lab-gd-installation-account-unlink-v1.md
  - lab-gd-private-service-implementation.md
- application-live-events.md
- DATA.md
- DEVELOPMENT.md
- DOCKER.md
- MIGRATIONS.md
- RELEASES.md
- sharing-rollout.md
- sharing.md
- SQLITE_MIGRATION.md
- - LICENSE
  - package.json
  - README.md
  - tsconfig.json
- - LICENSE
  - package.json
  - README.md
  - tsconfig.json
- - LICENSE
  - package.json
  - README.md
  - tsconfig.json
- - LICENSE
  - package.json
  - README.md
  - tsconfig.json
- favicon.svg
- icons.svg
- Cargo.lock
- Cargo.toml
- - contract.bun_spec.mjs
  - contract.mjs
  - deployment-triggers.bun_spec.mjs
  - integration.bun_spec.mjs
  - phase-cache.bun_spec.mjs
  - phase-cache.mjs
  - receipt.bun_spec.mjs
  - receipt.mjs
  - run.bun_spec.mjs
  - run.mjs
  - test-supervisor.bun_spec.mjs
  - test-supervisor.mjs
  - test-worker-budget.bun_spec.mjs
  - test-worker-budget.ts
  - verify-receipt.mjs
  - workflow-parity.bun_spec.mjs
- - go-toolchain-policy.bun_spec.mjs
  - go-toolchain-policy.mjs
  - smoke-runtime.bun_spec.mjs
  - smoke-runtime.mjs
  - trivy.bun_spec.mjs
  - trivy.mjs
- - cleanup.bun_spec.mjs
  - cleanup.mjs
  - cli.bun_spec.mjs
  - cli.mjs
  - config.mjs
  - docker-hub.bun_spec.mjs
  - docker-hub.mjs
  - local-registry.mjs
  - oci-runtime-identity.bun_spec.mjs
  - oci-runtime-identity.mjs
  - oci.bun_spec.mjs
  - oci.mjs
  - process.mjs
  - publish.bun_spec.mjs
  - publish.mjs
  - remote-snapshot.mjs
  - sanitize.bun_spec.mjs
  - sanitize.mjs
  - snapshot.bun_spec.mjs
  - snapshot.mjs
  - staging.bun_spec.mjs
  - staging.mjs
  - state.bun_spec.mjs
  - state.mjs
  - timing.bun_spec.mjs
  - timing.mjs
  - tools.bun_spec.mjs
  - tools.mjs
  - validate-image.bun_spec.mjs
  - validate-image.mjs
- - agent-store.bun_spec.mjs
  - agent-store.mjs
  - artifacts.bun_spec.mjs
  - fingerprint.mjs
  - prepare.mjs
  - store.mjs
- - publication-preflight.mjs
  - verify-contract-readiness.mjs
  - verify-contract-readiness.test.mjs
- benchmark-catalog-startup.mjs
- benchmark-engine.mjs
- benchmark-sqlite-persistence.bun_spec.mjs
- benchmark-sqlite-persistence.mjs
- build-wasm.mjs
- build-wasm.test.mjs
- check-agent-release-pin.mjs
- check-container-security.mjs
- check-database-migrations.bun_spec.mjs
- check-database-migrations.mjs
- check-frontend-bundle.bun_spec.mjs
- check-frontend-bundle.mjs
- check-release-notes.mjs
- check-release-notes.test.mjs
- check-share-packages.mjs
- check-share-packages.test.mjs
- dev-wasm.mjs
- dev-wasm.test.mjs
- historical-release-map.mjs
- historical-release-map.test.mjs
- install-git-hooks.mjs
- local-release.mjs
- migrate-category-array-inventory.mjs
- migrate-persisted-numeric-ids.mjs
- prepare-agent-release.mjs
- prepare-historical-runtime.mjs
- prepare-historical-runtime.test.mjs
- release-plan.mjs
- release-plan.test.mjs
- synchronize-business-data.sh
- synchronize-business-data.test.mjs
- verify-published-image.mjs
- verify-published-image.test.mjs
- verify-sqlite-runtime.bun_spec.mjs
- verify-sqlite-runtime.mjs
- verify-wasm-runtime.mjs
- verify-wasm-runtime.test.mjs
- - command-platform.mjs
  - command-platform.test.mjs
  - contract-service.mjs
  - contract-service.test.mjs
  - hardware-suggestions.mjs
  - hardware-suggestions.test.mjs
  - jep106-manufacturers.mjs
  - jep106-manufacturers.test.mjs
  - lifecycle-scheduler.mjs
  - lifecycle-scheduler.test.mjs
  - protocol-v1.mjs
  - protocol-v1.test.mjs
  - release-service.mjs
  - release-service.test.mjs
  - signature-auth.mjs
  - signature-auth.test.mjs
  - status-model.mjs
  - status-model.test.mjs
  - status-projection.mjs
  - storage-interpretation.mjs
  - storage-interpretation.test.mjs
  - storage-manufacturers.mjs
  - storage-mounts.mjs
  - storage-mounts.test.mjs
  - telemetry-envelope.mjs
  - telemetry-envelope.test.mjs
  - v1-routes.mjs
  - v1-routes.test.mjs
- - access-routes.mjs
  - access-routes.test.mjs
  - access-service.mjs
  - access-service.test.mjs
  - api-permissions.mjs
  - api-permissions.test.mjs
  - auth-service.mjs
  - auth-service.test.mjs
  - authorization-model.mjs
  - authorization-service.bun_spec.mjs
  - authorization-service.mjs
  - authorization-service.test.mjs
  - common-passwords.mjs
  - config.mjs
  - config.test.mjs
  - csv-parser-security.bun_spec.mjs
  - engine-permissions.mjs
  - engine-permissions.test.mjs
  - invitation-service.mjs
  - invitation-service.test.mjs
  - middleware.mjs
  - middleware.test.mjs
  - model.mjs
  - model.test.mjs
  - oidc-service.mjs
  - oidc-service.test.mjs
  - passwords.bun_spec.mjs
  - passwords.mjs
  - passwords.test.mjs
  - permission-catalog.mjs
  - permission-catalog.test.mjs
  - reset-owner-cli.mjs
  - routes.mjs
  - session-service.mjs
  - session-service.test.mjs
  - tokens.mjs
- - archive-envelope.mjs
  - archive-envelope.test.mjs
  - archive-security.mjs
  - archive-security.test.mjs
  - backup-model.mjs
  - backup-model.test.mjs
  - backup-scheduler.mjs
  - backup-scheduler.test.mjs
  - backup-sections.mjs
  - backup-sections.test.mjs
  - backup-service.mjs
  - backup-service.test.mjs
  - restore-journal.mjs
  - restore-journal.test.mjs
  - restore-preflight.mjs
  - restore-preflight.test.mjs
  - sharing-identity-restore.bun_spec.ts
  - sqlite-backup.bun_spec.ts
  - sqlite-restore-staging.ts
  - sqlite-section-exporter.ts
- - audit-service.bun_spec.ts
  - audit-service.mjs
  - routes.mjs
  - routes.test.mjs
- - agent-auth.mjs
  - catalog-update-lifecycle.test.mjs
  - inventory-capabilities.mjs
  - inventory-commands.test.mjs
  - inventory-input.mjs
  - inventory-lifecycle.mjs
  - inventory-lifecycle.test.mjs
  - legacy-network-normalization.ts
  - migrate-schema-10.mjs
  - migrate-schema-10.test.mjs
  - migrate-schema-11.d.mts
  - migrate-schema-11.mjs
  - migrate-schema-11.test.mjs
  - migrate-schema-12.d.mts
  - migrate-schema-12.mjs
  - migrate-schema-12.test.mjs
  - migrate-schema-13.mjs
  - migrate-schema-13.test.mjs
  - migrate-schema-14.d.mts
  - migrate-schema-14.mjs
  - migrate-schema-15.mjs
  - migrate-schema-15.test.mjs
  - migrate-schema-16.mjs
  - migrate-schema-16.test.mjs
  - migrate-schema-17.mjs
  - migrate-schema-17.test.mjs
  - migrate-schema-18.mjs
  - migrate-schema-18.test.mjs
  - migrate-schema-19.mjs
  - migrate-schema-19.test.mjs
  - migrate-schema-20.mjs
  - migrate-schema-20.test.mjs
  - migrate-schema-21.mjs
  - migrate-schema-21.test.mjs
  - migrate-schema-22.mjs
  - migrate-schema-22.test.mjs
  - migrate-schema-23.mjs
  - migrate-schema-23.test.mjs
  - migrate-schema-24.mjs
  - migrate-schema-24.test.mjs
  - migrate-schema-25.mjs
  - migrate-schema-25.test.mjs
  - migrate-schema-26.mjs
  - migrate-schema-26.test.mjs
  - migrate-schema-27.mjs
  - migrate-schema-27.test.mjs
  - migrate-schema-28.mjs
  - migrate-schema-28.test.mjs
  - migrate-schema-29.mjs
  - migrate-schema-29.test.mjs
  - nas-power-configuration.mjs
  - nas-power-configuration.test.mjs
  - relational-ids.mjs
  - store.d.mts
  - store.mjs
  - store.test.mjs
  - validation.d.mts
  - validation.mjs
  - validation.test.mjs
- - sanitizer.mjs
  - session-manager.mjs
  - session-manager.test.mjs
  - sqlite-session-manager.bun_spec.ts
- - command-service.mjs
  - command-service.test.mjs
  - runtime.mjs
  - runtime.test.mjs
  - snapshot.mjs
  - snapshot.test.mjs
  - sse-hub.mjs
  - sse-hub.test.mjs
- - contract.bun_spec.mjs
  - contract.mjs
  - filter-service.bun_spec.mjs
  - filter-service.mjs
  - repository.bun_spec.mjs
  - repository.mjs
  - routes.mjs
  - routes.test.mjs
- - agent-payloads.mjs
  - agent-payloads.test.mjs
  - event-bus.mjs
  - event-bus.test.mjs
  - inventory-metadata-payloads.mjs
  - inventory-metadata-payloads.test.mjs
  - routes.mjs
  - routes.test.mjs
  - sse-hub.mjs
  - sse-hub.test.mjs
  - topics.mjs
  - topics.test.mjs
- - delivery-coordinator.mjs
  - delivery-coordinator.test.mjs
  - evaluator.mjs
  - evaluator.test.mjs
  - incident-manager.mjs
  - incident-manager.test.mjs
  - model.mjs
  - model.test.mjs
  - policy-resolver.mjs
  - policy-resolver.test.mjs
  - retention.mjs
  - retention.test.mjs
  - routes.mjs
  - routes.test.mjs
  - runtime.mjs
  - secret-vault.mjs
  - secret-vault.test.mjs
  - sqlite-persistence.ts
  - store.mjs
  - store.test.mjs
- - example-workspace.d.mts
  - example-workspace.mjs
  - lifecycle.d.mts
  - lifecycle.mjs
  - model.d.mts
  - model.mjs
- - mutation-effects.bun_spec.ts
  - mutation-effects.ts
  - runtime.bun_spec.ts
  - runtime.ts
  - sqlite-store.bun_spec.ts
  - sqlite-store.ts
  - store-contract.bun_spec.ts
  - store-contract.ts
- - catalog-availability.bun_spec.mjs
  - catalog-availability.mjs
  - catalog-generation-receipt.bun_spec.mjs
  - catalog-generation-receipt.mjs
  - catalog-index-contract.mjs
  - catalog-index.bun_spec.mjs
  - catalog-index.mjs
  - catalog-refresh-coordinator.mjs
  - catalog-refresh-coordinator.test.mjs
  - catalog-runtime-projection.bun_spec.mjs
  - catalog-runtime-projection.mjs
  - catalog-runtime.bun_spec.mjs
  - catalog-runtime.mjs
  - catalog-runtime.test.mjs
  - catalog-status-service.mjs
  - catalog-status-service.test.mjs
  - catalog-update-coordinator.mjs
  - catalog-update-coordinator.test.mjs
  - catalog-update-policy.mjs
  - catalog-update-policy.test.mjs
  - catalog-update-projection.mjs
  - catalog-update-projection.test.mjs
  - catalog-update-resolution.mjs
  - catalog-update-resolution.test.mjs
  - catalog-update-semantics.mjs
  - catalog-update-semantics.test.mjs
  - catalog-update-startup.mjs
  - catalog-update-startup.test.mjs
  - contribution-delivery.mjs
  - contribution-delivery.test.mjs
  - contribution-service.mjs
  - contribution-service.test.mjs
  - installation-identity.mjs
  - installation-identity.test.mjs
  - installation-instance.mjs
  - local-catalog-mapping.mjs
  - local-catalog-mapping.test.mjs
  - model.mjs
  - model.test.mjs
  - oem-canonical-update-safety.bun_spec.mjs
  - oem-variant-matcher.mjs
  - oem-variant-matcher.test.mjs
  - response-json.mjs
  - response-json.test.mjs
  - snapshot-service.bun_spec.mjs
  - snapshot-service.mjs
  - trusted-keys.mjs
  - trusted-keys.test.mjs
  - update-service.mjs
  - update-service.test.mjs
  - wlan-resource-migration.mjs
- - inventory.json
  - meta.json
  - project.json
- - account-unlink-service.mjs
  - account-unlink-service.test.mjs
  - capabilities.mjs
  - capabilities.test.mjs
  - enrollment-coordinator.mjs
  - enrollment-coordinator.test.mjs
  - fake-labgd-contract.test.mjs
  - installation-auth.mjs
  - installation-auth.test.mjs
  - installation-event-coordinator.mjs
  - installation-event-coordinator.test.mjs
  - installation-identity.mjs
  - installation-identity.test.mjs
  - installation-instance.mjs
  - labgd-client.mjs
  - labgd-client.test.mjs
  - privacy-policy.mjs
  - public-id-service.mjs
  - publication-coordinator.mjs
  - publication-coordinator.test.mjs
  - publication-retry-policy.mjs
  - publication-retry-policy.test.mjs
  - publication-service.mjs
  - publication-service.test.mjs
  - remote-capabilities.mjs
  - remote-capabilities.test.mjs
  - routes.mjs
  - routes.test.mjs
  - share-projector.mjs
  - share-projector.test.mjs
  - source-provider.mjs
  - test-network-guard.d.mts
  - test-network-guard.mjs
  - test-network-guard.test.mjs
- - startup-profiler.bun_spec.mjs
  - startup-profiler.mjs
- - attention-projector.bun_spec.ts
  - attention-projector.mjs
  - memory-pressure.bun_spec.ts
  - memory-pressure.mjs
  - read-service.bun_spec.ts
  - read-service.mjs
  - routes.mjs
  - routes.test.mjs
  - saved-view-service.bun_spec.ts
  - saved-view-service.mjs
- - backup-service.bun_spec.mjs
  - backup.mjs
  - compact-migration.bun_spec.mjs
  - database.bun_spec.mjs
  - database.mjs
  - entity-keys.bun_spec.mjs
  - entity-keys.mjs
  - repository.bun_spec.mjs
  - repository.mjs
  - retention.bun_spec.mjs
  - retention.mjs
  - schema-v3.bun_spec.mjs
  - schema.mjs
- agent-release-pin.json
- agent-routes.mjs
- agent-routes.test.mjs
- api-error-handler.mjs
- api-error-handler.test.mjs
- app-health.mjs
- app-health.test.mjs
- backup-routes.mjs
- bootstrap-routes.mjs
- bootstrap-routes.test.mjs
- engine-routes.mjs
- engine-routes.test.mjs
- external-access-policy.mjs
- external-access-policy.test.mjs
- http-delivery.mjs
- http-delivery.test.mjs
- index.mjs
- inventory-routes.mjs
- inventory-routes.test.mjs
- onboarding-routes.mjs
- project-routes.mjs
- project-routes.test.mjs
- rate-limit.mjs
- rate-limit.test.mjs
- registry-routes.mjs
- registry-routes.test.mjs
- release-notes-api.test.mjs
- request-security.mjs
- request-security.test.mjs
- routing-cache-model.mjs
- routing-cache-routes.mjs
- routing-cache-routes.test.mjs
- runtime-config.mjs
- runtime-config.test.mjs
- server-lifecycle.mjs
- server-lifecycle.test.mjs
- staging-policy.mjs
- staging-policy.test.mjs
- store-request-error.mjs
- store-request-error.test.mjs
- update-checker.mjs
- update-checker.test.mjs
- update-routes.mjs
- update-routes.test.mjs
- update-scheduler.mjs
- update-scheduler.test.mjs
- workspace-routes.mjs
- workspace-routes.test.mjs
- - contract.mjs
- - cpu-generation-aliases.d.mts
  - cpu-generation-aliases.mjs
  - index.d.mts
  - index.mjs
- - protocol.d.mts
  - protocol.mjs
  - routing-cache-contract.d.mts
  - routing-cache-contract.mjs
  - wasm-runtime.d.mts
  - wasm-runtime.mjs
- network-adapter-ports.ts
- power-ports.d.mts
- power-ports.mjs
- - app-dialogs.tsx
  - app-inventory-panels.test.tsx
  - app-inventory-panels.tsx
  - app-shell.test.tsx
  - app-shell.tsx
  - app-status-screens.tsx
  - app-workspace-surface.test.tsx
  - app-workspace-surface.tsx
  - app.tsx
  - canvas-runtime-view-state.ts
  - canvas-surface-layer.tsx
  - canvas-surface-pool.test.tsx
  - canvas-surface-pool.tsx
  - create-inventory-panel-props.ts
  - create-lifecycle-dialog-props.ts
  - create-onboarding-dialog-props.ts
  - create-release-dialog-props.ts
  - create-settings-dialog-props.ts
  - create-workspace-surface-props.ts
  - inventory-drag-preview.tsx
  - port-connection-preview-overlay.tsx
  - project-drop-helpers.ts
  - project-history-snapshot.test.ts
  - project-history-snapshot.ts
  - use-app-navigation-actions.ts
  - use-canvas-engine-reactivation.ts
  - use-canvas-equipment-lifecycle.ts
  - use-canvas-maintenance-controller.ts
  - use-canvas-selection-controller.ts
  - use-canvas-workspace-actions.ts
  - use-connection-controller.ts
  - use-demo-session-lifecycle.ts
  - use-inventory-lifecycle.ts
  - use-inventory-panel-resize.ts
  - use-onboarding-controller.ts
  - use-project-commands.ts
  - use-project-geometry-sync.test.tsx
  - use-project-geometry-sync.ts
  - use-project-history.test.tsx
  - use-project-history.ts
  - use-project-hydration.test.tsx
  - use-project-hydration.ts
  - use-project-save-queue.ts
  - use-registry-settings-actions.ts
  - use-release-update-controller.ts
  - use-selected-topology.ts
  - use-workbook-controller.ts
  - use-workspace-drag.ts
  - use-workspace-preferences.ts
  - workspace-project-loading.test.ts
  - workspace-project-loading.ts
- - hero.png
  - react.svg
  - vite.svg
- - auth-context.ts
- - application-root.tsx
  - assigned-component-removal-dialog.tsx
  - assigned-expansion-heading-model.ts
  - assigned-expansion-heading.tsx
  - assigned-item-corner-actions.tsx
  - assigned-power-adapter-row.tsx
  - audit-drawer.tsx
  - cable-edge.tsx
  - canvas-activity-indicator.tsx
  - canvas-command-bar.tsx
  - compatibility-drop-announcement.tsx
  - compatibility-status-model.ts
  - compatibility-status.tsx
  - component-compatibility-tab.tsx
  - component-inspector-tabs.tsx
  - compute-host-icon.tsx
  - cpu-slot-grid.tsx
  - cpu-slot-model.ts
  - demo-session-dialog.tsx
  - desktop-inventory-shell.tsx
  - dnd-workspace.tsx
  - domain-engine-gate.tsx
  - domain-engine-provider.tsx
  - equipment-card.tsx
  - fixed-component-card.tsx
  - global-item-search.tsx
  - host-compatibility-tab.tsx
  - inspector-panel.tsx
  - inventory-actions-menu.tsx
  - inventory-item-dialog.tsx
  - inventory-lifecycle-dialog.tsx
  - inventory-scope-dialog.tsx
  - inventory-sidebar.tsx
  - lazy-app-surfaces.ts
  - lazy-dnd-workspace.ts
  - lazy-inventory-sidebar.tsx
  - lazy-mobile-inventory-sheet.tsx
  - lazy-surface-contract.ts
  - lazy-surface-view.tsx
  - lazy-surface.ts
  - lazy-workbench-canvas.ts
  - lazy-workspace-app.tsx
  - memory-slot-grid.tsx
  - memory-slot-model.ts
  - mobile-inventory-sheet.tsx
  - monitor-card.tsx
  - nas-card.tsx
  - nas-power-configuration-dialog.tsx
  - pc-build-card.tsx
  - power-strip-card-model.ts
  - power-strip-card.tsx
  - registry-link-indicator.tsx
  - return-to-inventory-dialog.tsx
  - right-drawer-layout.ts
  - server-card.tsx
  - settings-dialog.tsx
  - share-viewer-package-parity.test.tsx
  - smart-power-strip-disable-dialog.tsx
  - standalone-canvas-equipment-card.tsx
  - standalone-canvas-equipment-model.ts
  - update-dialog.tsx
  - ups-card-model.ts
  - ups-card.tsx
  - whats-new-dialog.tsx
  - workbench-canvas-contract.ts
  - workbench-canvas.tsx
- - api.ts
  - assignments.ts
  - canvas-routing-runtime.ts
  - canvas-runtime-manager.ts
  - client.ts
  - geometry.ts
  - placements.ts
  - project-patches.ts
  - react-context.ts
  - routing.ts
  - runtime-scope.ts
  - topology.ts
  - types.ts
- - use-agent-hardware-suggestions.ts
  - use-agent-status.test.tsx
  - use-agent-status.ts
  - use-auth.ts
  - use-backups.ts
  - use-compatibility-audit.test.tsx
  - use-compatibility-audit.ts
  - use-desktop-breakpoint.ts
  - use-domain-engine.ts
  - use-inventory-item-editor.ts
  - use-notifications.ts
  - use-permission.test.ts
  - use-permission.ts
  - use-registry.ts
  - use-sharing.ts
  - use-systems.test.tsx
  - use-systems.ts
  - use-topology-query.ts
- - access-api.ts
  - agent-api.ts
  - agent-status-live.test.ts
  - agent-status-live.ts
  - audit.ts
  - auth-api.ts
  - auth-status-api.ts
  - backup-api.ts
  - bootstrap-api.ts
  - bootstrap-contract.ts
  - browser-preference-scope.test.ts
  - browser-preference-scope.ts
  - cable-focus.ts
  - cable-geometry.ts
  - cable-render-stability.ts
  - cable-routing-coordinator.ts
  - cable-routing.ts
  - cable-visibility.ts
  - cables.ts
  - canvas-configuration.ts
  - canvas-handle-geometry.ts
  - canvas-handle-index.ts
  - canvas-node-dependencies.ts
  - canvas-project-index.ts
  - canvas-quality.ts
  - compatibility-audit-api.ts
  - compatibility-policy.ts
  - compatibility.ts
  - compute-host-presentation.test.ts
  - compute-host-presentation.ts
  - connection-endpoints.ts
  - connection-route-preferences.ts
  - constraints.ts
  - created-connection-selection.ts
  - db.ts
  - demo-api.ts
  - equipment-classification.ts
  - fetch-with-timeout.ts
  - format.ts
  - history.ts
  - ids.ts
  - inventory-capabilities.ts
  - inventory-drag-preview.ts
  - inventory-lifecycle.ts
  - inventory-metadata-api.ts
  - inventory-metadata-keys.ts
  - inventory-metadata-live.test.ts
  - inventory-metadata-live.ts
  - inventory-metadata-query.test.ts
  - inventory-metadata-query.ts
  - inventory-sidebar-preferences.ts
  - inventory-virtual-rows.ts
  - inventory.ts
  - item-keys.ts
  - network-adapter-ports.ts
  - network-port-speeds.ts
  - notification-api.ts
  - onboarding-api.ts
  - orthogonal-cable.ts
  - patch-panel.ts
  - pc-build-resources.ts
  - pc-build.ts
  - port-interactions.ts
  - power-endpoints.ts
  - power-equipment-layout.ts
  - project-persistence-coordinator.ts
  - project-query-key.test.ts
  - project-query-key.ts
  - project.ts
  - query-client.ts
  - registry-api.ts
  - registry-links.ts
  - release-notes-api.ts
  - routing-cache-api.ts
  - sharing-api.ts
  - sort.ts
  - switch-ports.ts
  - systems-api.ts
  - systems-preferences.test.ts
  - systems-preferences.ts
  - tap-selection.ts
  - ui-preferences.ts
  - update-api.ts
  - utils.ts
  - workbook-api.test.ts
  - workbook-api.ts
  - workspace-preference.test.ts
  - workspace-preference.ts
  - workspace-route.test.ts
  - workspace-route.ts
  - workspace-runtime-cache.ts
- - application-live-events-context.ts
  - application-live-events-provider.test.tsx
  - application-live-events-provider.tsx
  - model.ts
  - no-browser-polling.test.ts
  - use-live-event-topic.ts
- - account-unlink-dialog.test.tsx
  - agent-telemetry-presentation.test.tsx
  - app-assigned-drop.test.ts
  - app-navigation-actions.test.tsx
  - app-persistence.test.tsx
  - app-return-to-inventory.test.tsx
  - assigned-component-removal-dialog.test.tsx
  - assigned-expansion-heading.test.ts
  - audit-drawer.test.tsx
  - audit.test.ts
  - auth-gate.test.tsx
  - authentication-settings.test.tsx
  - bootstrap-api.test.ts
  - cable-edge.test.tsx
  - cable-focus.test.ts
  - cable-render-stability.test.ts
  - cable-routing-coordinator.test.ts
  - cable-routing.test.ts
  - cable-visibility.test.ts
  - cables.test.ts
  - canvas-activity-indicator.test.tsx
  - canvas-command-bar.test.tsx
  - canvas-configuration.test.ts
  - canvas-engine-reactivation.test.tsx
  - canvas-handle-geometry.test.ts
  - canvas-handle-index.test.ts
  - canvas-node-dependencies.test.ts
  - canvas-project-index.test.ts
  - canvas-quality.test.ts
  - canvas-runtime-manager.test.ts
  - canvas-viewport-surface.test.tsx
  - catalog-browser-model.test.ts
  - catalog-browser.test.tsx
  - catalog-facet-prefetch.test.ts
  - compatibility-allocation.test.ts
  - compatibility-drop-state.test.tsx
  - compatibility-evaluator-invariants.test.ts
  - compatibility-normalization.test.ts
  - compatibility-policy.test.ts
  - compatibility-rules.test.ts
  - compatibility-workflows.test.ts
  - component-inspector-tabs.test.tsx
  - connection-endpoints.test.ts
  - connection-route-preferences.test.ts
  - constraints.test.ts
  - copy-host-configuration-dialog.test.tsx
  - cpu-generation-aliases.test.ts
  - cpu-slot-grid.test.tsx
  - created-connection-selection.test.ts
  - demo-api.test.ts
  - demo-session-dialog.test.tsx
  - desktop-inventory-shell.test.tsx
  - domain-engine-client.test.ts
  - domain-engine-gate.test.tsx
  - domain-engine-worker.test.ts
  - engine-assignments.test.ts
  - engine-placements.test.ts
  - engine-protocol.test.ts
  - engine-topology.test.ts
  - engine-wasm-integration.test.ts
  - fetch-with-timeout.test.ts
  - flow-reconciliation.test.ts
  - format.test.ts
  - global-inventory-panel.test.tsx
  - global-item-search.test.tsx
  - history.test.ts
  - inspector-metadata-tab.test.tsx
  - inspector-panel.test.tsx
  - inventory-actions-menu.test.tsx
  - inventory-capabilities.test.ts
  - inventory-drag-preview.test.ts
  - inventory-form-model.test.ts
  - inventory-form-placeholders.test.ts
  - inventory-item-dialog-metadata.test.tsx
  - inventory-item-dialog.test.tsx
  - inventory-lifecycle-dialog.test.tsx
  - inventory-metadata-draft.test.ts
  - inventory-metadata-settings.test.tsx
  - inventory-scope-dialog.test.tsx
  - inventory-sidebar-preferences.test.ts
  - inventory-sidebar.test.tsx
  - inventory-specs-tab-content.test.tsx
  - inventory-virtual-rows.test.ts
  - inventory.test.ts
  - lazy-app-surfaces.test.tsx
  - lazy-surface.test.tsx
  - memory-slot-grid.test.tsx
  - nas-power-configuration-dialog.test.tsx
  - negotiated-speed.test.ts
  - network-adapter-ports.test.ts
  - notifications-ui.test.tsx
  - onboarding-api.test.ts
  - onboarding-components.test.tsx
  - onboarding-lifecycle.test.ts
  - onboarding-model.test.ts
  - onboarding-store.test.ts
  - open-auth-test-render.ts
  - orthogonal-cable.test.ts
  - patch-panel.test.ts
  - pc-build-card.test.tsx
  - pc-build-compatibility.test.ts
  - pc-build-constraints.test.ts
  - pc-build-resources.test.ts
  - pc-build.test.ts
  - power-cable-integration.test.ts
  - power-equipment-layout.test.ts
  - project-patches.test.ts
  - project-persistence-coordinator.test.ts
  - project.test.ts
  - public-component-facades.test.ts
  - registry-api.test.ts
  - registry-links.test.tsx
  - registry-updates-dialog.test.tsx
  - release-notes.test.ts
  - return-to-inventory-dialog.test.tsx
  - routing-cache-api.test.ts
  - settings-dialog.test.tsx
  - settings-primitives.test.tsx
  - setup.ts
  - share-dialog.test.tsx
  - sharing-settings.test.tsx
  - sort.test.ts
  - standalone-canvas-cards.test.tsx
  - switch-ports.test.ts
  - synchronize-business-data.test.ts
  - systems-utilization-bar.test.tsx
  - topology-query-fixture.ts
  - topology-query.test.tsx
  - ui-preferences.test.ts
  - update-api.test.ts
  - update-dialog.test.tsx
  - use-cable-routing-controller.test.tsx
  - use-canvas-route-requests.test.ts
  - use-desktop-breakpoint.test.tsx
  - use-inventory-item-editor.test.tsx
  - wasm-runtime.test.ts
  - whats-new-dialog.test.tsx
  - workspace-runtime-cache.test.ts
- - access.ts
  - agent.ts
  - auth.ts
  - canvas.ts
  - compatibility-audit.ts
  - compatibility.ts
  - domain-mutation.ts
  - inventory-metadata.ts
  - inventory.ts
  - notifications.ts
  - pc-build.ts
  - registry.ts
  - settings-navigation.ts
  - systems.ts
- - domain-engine.worker.ts
- App.css
- App.tsx
- index.css
- main.tsx
- release-notes.ts
- - fake-labgd.mjs
- sharing-e2e.test.mjs
- sync-sharing-identity.test.mjs
- homelab-inventory-agent
.dockerignore
.editorconfig
.env.example
.gitattributes
.gitignore
.gitmodules
.oxlintrc.json
bun.lock
CHANGELOG.md
CODE_OF_CONDUCT.md
components.json
CONTRIBUTING.md
docker-compose.example.yml
Dockerfile
DOCKERHUB.md
drizzle.config.ts
index.html
LICENSE
package.json
PRODUCT.md
README.md
rust-toolchain.toml
SECURITY.md
tsconfig.app.json
tsconfig.json
tsconfig.node.json
vite.config.ts

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

# Project Badges

Docker Pulls Visit
Docker Image Version Visit
License: MIT Visit

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Homelab Inventory is a self-hosted visual workbench for documenting, assembling, validating, and monitoring homelab hardware.

It gives you one practical view of what you own, what is installed in each machine, how network, display, and power paths are connected, and whether monitored hosts are healthy.

## Project Links

- Official website: [homelabinventory.com](https://homelabinventory.com/)
- Live demo: [demo.homelabinventory.com](https://demo.homelabinventory.com/)
- Source code: [GitHub](https://github.com/mriverodorta/homelab-inventory)
- Container image: [Docker Hub](https://hub.docker.com/r/mriverodorta/homelab-inventory)

> [!WARNING]
> Do not expose Homelab Inventory directly to the public internet without HTTPS and access controls. Built-in multi-user authentication is available but optional on upgraded installations, and it does not provide TLS. Use a trusted LAN, VPN, or TLS reverse proxy.

## What You Can Do

### Document the physical lab

- Organize one installation into multiple projects, each with a fixed Systems view and one or more reorderable, named, color-coded Canvas workspaces.
- Place servers, NAS devices, custom PC builds, monitors, switches, patch panels, UPS systems, and power strips on an infinite canvas.
- Assemble hosts from reusable CPUs, motherboards, cooling, RAM, storage, GPUs, wired or radio Network Adapters, sound cards, cases, power supplies, and OEM power adapters.
- Connect individual network, display, and power endpoints with color-coded, orthogonally routed cables and inspect each connection from either endpoint.
- Use the searchable desktop or mobile inventory drawer to create, duplicate, archive, restore, and safely remove equipment.
- Keep equipment project-bound, expose selected records through the global inventory library, or create a clean independent copy in another project.

### Validate hardware before changing it

- Check CPU socket, generation, and power limits; memory generation, capacity, speed, ECC, physical DIMM or SO-DIMM fit, electrical module type, and slot allocation; storage bays and interfaces; and expansion-slot fit across PCIe, M.2, Mini PCIe, USB, OCP, mezzanine, onboard, and proprietary Network Adapter interfaces.
- See deterministic resource allocations, known incompatibilities, and incomplete-data warnings before an assignment changes project data.
- Review or ignore individual audit findings, or disable compatibility checks for a specific host when documenting an intentional exception.
- Import complete OEM systems and retail motherboards with their physical topology preserved instead of flattening them into generic machines.
- Define private typed custom fields and reusable colored tags for inventory, then search, filter, and build saved Systems views from that metadata without contributing it to the public Registry.

### Reuse trusted hardware definitions

- Search the optional signed hardware catalog locally by category and hardware-specific filters, then import independent inventory records linked to a verified template revision, including exact physical RAM sticks identified by manufacturer part number.
- Review catalog updates before applying them while preserving local names, assignments, canvas positions, cables, and instance-only fields.
- Keep an installation fully offline with a signed catalog snapshot, or use reusable private templates with checksummed JSON import and export.
- Optionally contribute sanitized, deduplicated hardware definitions without sending serials, addresses, labels, assignments, topology, or agent evidence.

### Monitor compute hosts

- Use the dense Systems workspace to compare host type, identity, assigned CPU, memory, primary storage, Registry linkage, Agent status, and attention findings without opening every machine.
- Build account-synchronized saved views from dynamic host, Agent, Registry, tag, and custom-field filters, with useful local defaults when authentication is disabled.
- Enroll an outbound-only Agent on systemd Linux, Alpine/OpenRC, FreeBSD, or OPNsense hosts and view one-minute health, heartbeat history, CPU, memory, uptime, and operating-system details.
- Receive live Systems utilization and Inspector telemetry through one authenticated server-sent event stream after the initial compact snapshot, without recurring browser polling.
- Inspect local storage usage by physical device and mount point, including partition tables and LVM or RAID topology, without mixing in remote shares or container mounts.
- Discover locally installed services and opt into bounded Docker or Podman container telemetry through a loopback proxy or reviewed direct socket access.
- Run a separate reviewed hardware scan and apply detected motherboard, CPU, DIMM, storage, PCI, network, GPU, or power values one field at a time with normal Undo support.
- Update agents manually through verified commands, unlink an agent without losing history, or explicitly remove only that host's retained telemetry.
- Receive opt-in Ntfy or generic webhook alerts for host outages and selected service, container, or physical-storage changes, with quiet hours, reminders, retries, and persisted incident history.

### Operate and share it safely

- Enable local-password, OpenID Connect, or hybrid authentication with invitations, sessions, built-in roles, and custom permission groups.
- Publish explicitly selected Systems and Canvas views to lab.gd through a local privacy preview, with public or unlisted access, immutable or replaceable revisions, manual or debounced synchronization, expiration, embeds, and opt-in metadata.
- Create complete or section-based portable backups, restore selected sections with dependency checks and rollback, and schedule encrypted backups with configurable retention.
- Keep all application state outside the image in a persistent `/data` volume with ordered migrations and verified pre-migration backups.
- Follow `stable`, test `latest`, or pin an immutable version tag; in-app update checks remain optional and anonymous.

## AI Development Notice

This project is being actively built with AI-assisted development. It is usable, but should be treated as an evolving homelab tool rather than a finished enterprise CMDB. Keep your `/data` directory backed up, review release notes before major upgrades, and report issues when behavior does not match your environment.

## Quick Start With Docker

### Normal Production

Create a Compose file:

```yaml
services:
  homelab-inventory:
    image: mriverodorta/homelab-inventory:stable
    container_name: homelab-inventory
    restart: unless-stopped
    ports:
      - "8798:8798"
    volumes:
      - ./data:/data
```

Start it:

```bash
docker compose up -d
```

Open:

```txt
http://<server-ip>:8798
```

The image defaults to:

```txt
NODE_ENV=production
PORT=8798
DATA_DIR=/data
SAVE_DEBOUNCE_MS=500
APP_MODE=production
UPDATE_CHANNEL=stable
UPDATE_CHECK_ENABLED=true
REGISTRY_REFRESH_INTERVAL_MS=21600000
LABGD_ENABLED=true
LABGD_ORIGIN=https://lab.gd
TZ=UTC
BACKUP_ENCRYPTION_PASSPHRASE=
AUTH_BOOTSTRAP_CODE=
AUTH_BOOTSTRAP_CODE_FILE=
AUTH_EXTERNAL_URL=
OIDC_CLIENT_SECRET=
OIDC_CLIENT_SECRET_FILE=
RATE_LIMIT_WINDOW_MS=60000
RATE_LIMIT_MAX=600
TRUST_PROXY=false
AGENT_TELEMETRY_RETENTION_DAYS=7
```

Connected registry mode refreshes the verified official catalog at startup and approximately every six hours. Set `REGISTRY_REFRESH_INTERVAL_MS=0` to disable automatic catalog refreshes while retaining the manual Refresh action.

When running behind a reverse proxy, set `TRUST_PROXY` to the exact proxy hop count or trusted proxy range so rate limits use the correct client address. Do not set it to `true`.

Production starts empty. Create inventory items from the web interface, or copy an existing `/data` directory into the mounted volume.

On a fresh production data directory, the first page opens owner setup. Supply `AUTH_BOOTSTRAP_CODE` or `AUTH_BOOTSTRAP_CODE_FILE`, or read the generated one-time code from `docker compose logs homelab-inventory`. Existing installations upgraded from an earlier release remain open until authentication is enabled in **Settings > Authentication**.

More deployment details: [docs/DOCKER.md](docs/DOCKER.md)

## Local Development

This project uses Bun.

```bash
bun install
bun run dev
```

Open `http://127.0.0.1:5173`.

Useful commands:

```bash
bun run lint
bun run test
bun run build
```

More development details: [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)

## Data Storage

The app keeps user data out of the application image. Runtime data lives in `/data` for Docker and `./data` for local development.

```txt
/data
  databases/
    homelab-inventory.sqlite
    telemetry.sqlite
    catalog.sqlite
    persistence-engine.json
  backups/
  auth/
  registry/
    installation-instance.json
    installation-ed25519.pem
    installation-credentials.json
  sharing/
    installation-instance.json
    installation-ed25519.pem
    installation-credentials.json
    public-id-key.json
  stores/                       # retained legacy migration sources
```

Only one app container should write to a mounted data directory.

Existing JSON installations migrate automatically on first startup after a verified complete backup. The original JSON files remain unchanged but stop being active stores after SQLite activation. See [docs/SQLITE_MIGRATION.md](docs/SQLITE_MIGRATION.md) for verification, backup compatibility, and rollback instructions.

`agents.json` may contain private hardware evidence from a user-confirmed one-time agent scan, including raw serials used for local matching. It is excluded from demo data, treated as sensitive in portable backups, and never enters public registry contributions.

More data details: [docs/DATA.md](docs/DATA.md)

Upgrade and rollback guidance: [docs/MIGRATIONS.md](docs/MIGRATIONS.md)

## Authentication

Homelab Inventory supports multiple accounts with three optional authentication modes:

- **Local** uses a username and an Argon2id password of at least 12 characters.
- **OIDC** uses Authorization Code flow with PKCE and binds the exact issuer and subject returned by the provider.
- **Hybrid** allows an account to link both methods after explicitly confirming the second identity.

Fresh production installations require one-time local owner setup. Existing upgraded installations default to **Disabled** so an image update cannot lock out an established deployment. Enable or change methods in **Settings > Authentication**. The protected original owner can then invite local or OIDC users from **Settings > Access**, assign built-in roles, or compose custom global roles from the static permission catalog. Public demo sessions always bypass authentication and omit Access administration.

Invitations choose one initial login method. Matching email addresses are not merged automatically; an authenticated account must explicitly link the second local or OIDC identity. The original owner and Owner role cannot be reassigned or removed. API permissions are enforced on the server with default-deny routing, independently of which controls are visible in the browser.

OIDC requires a public HTTPS application URL. Configure the provider callback as:

```txt
https://inventory.example.com/api/auth/oidc/callback
```

The client secret can be entered in Settings and stored as a mode-`0600` backend file, or supplied through `OIDC_CLIENT_SECRET` / `OIDC_CLIENT_SECRET_FILE`. File values take precedence and environment-managed secrets are read-only in the UI. Set `AUTH_EXTERNAL_URL` when the externally visible URL cannot be inferred from the deployment.

If the original owner is locked out, stop the application before creating a recovery grant so only one process writes the SQLite databases:

```bash
docker compose stop homelab-inventory
docker compose run --rm homelab-inventory bun run auth:reset-owner
docker compose start homelab-inventory
```

The command prints a recovery URL valid for 15 minutes. Authentication data is excluded from custom backups by default and can be exported only in an encrypted archive. Complete backups include it. Once authentication data exists, scheduled backups require `BACKUP_ENCRYPTION_PASSPHRASE`.

## lab.gd Sharing

Production installations create a separate random sharing identity and enroll with [lab.gd](https://lab.gd) automatically after the local app is ready. Enrollment sends no inventory or project content and never publishes a share. Every share must be configured, rendered locally, reviewed through its exact privacy summary, and approved before publication.

Sharing is available in **Settings > Sharing**. Choose specific Systems or Canvas views, public or unlisted visibility, immutable or replaceable publication, manual or one-minute debounced synchronization, expiration, and exact HTTPS embed origins. Tags, custom fields, and a one-time Systems resource snapshot remain excluded unless selected explicitly. Serials, network identifiers, credentials, Agent identity, telemetry history, audit history, Registry enrollment, and private application identity never enter the share payload.

Set `LABGD_ENABLED=false` before first startup to prevent sharing identity creation, enrollment, and all lab.gd traffic. Turning the Settings connection off later retains the stable local identity so reconnecting does not create another installation. Demo and staging modes always disable enrollment and publication regardless of persisted settings. See [docs/sharing.md](docs/sharing.md) for identity, backup, permission, retry, and synchronization details.

## Backup And Restore

Open **Settings > Backup & Restore** to create a complete portable backup or choose individual sections such as inventory, project topology, registry state, sharing configuration and identity, agents, telemetry, catalog data, and the disposable cable-routing cache. A complete archive can later be restored in full or used to replace only selected sections.

Restore is replacement-only. Before changing live data, the app validates archive paths, sizes, checksums, schema compatibility, and section dependencies; creates a complete pre-restore recovery backup; enters maintenance mode; and records a durable restore journal. A failed or interrupted restore rolls back automatically. Connected browsers reload after a successful restore.

Portable archives use the `.hlibackup` format. Registry-enrollment backups include the stable installation UUID, signing key, and credentials as one validated set. Backups containing registry enrollment or agent credentials require a passphrase before download. Stored copies may also be encrypted with scrypt and AES-256-GCM. Keep that passphrase outside the app because it cannot be recovered.

SQLite deployments export format 2 logical archives with separate core, telemetry, and catalog schema versions, while supported format 1 archives remain importable. Restore stages selected logical sections in an isolated database and never replaces the active database with an untrusted uploaded SQLite file.

Daily or weekly complete backups can run at a configurable time with a configurable retention count. Set `TZ` in Docker Compose to make the deployment timezone authoritative, or choose an IANA timezone in Settings. Set `BACKUP_ENCRYPTION_PASSPHRASE` to at least 12 characters to encrypt scheduled stored backups. It is mandatory for scheduled backups once owner-authentication material exists.

User-managed backups live under `/data/backups/user` with private directory and file permissions. Backup history is never included recursively. Migration and pre-restore recovery backups remain separate from ordinary portable backups. Public demo sessions can download only their disposable inventory and project data and cannot schedule, upload, restore, or export credentials.

## Hardware Compatibility

Compatibility rules help prevent known-invalid assignments while keeping partially documented hardware usable:

- **Compatible** means the known component requirements fit the host and any required resource was allocated deterministically.
- **Incompatible** means a verified rule conflicts, such as a CPU socket mismatch, unsupported RAM generation, unavailable storage bay, or unsuitable expansion slot. New or changed assignments are blocked.
- **Unknown** means one or more required fields are not documented. The assignment remains available with an amber warning so incomplete inventory does not stop normal work.

Servers and NAS devices expose compatibility details in their inspectors. Component inspectors show requirements and the current host allocation, while Audit identifies assigned hardware that is incompatible or needs more data.

Compatibility fields are entered when an inventory item is created or edited. Private templates can reuse local definitions, while verified official definitions can be imported from a signed offline snapshot or synchronized in Connected mode. Ordered migrations preserve existing assignments and report legacy combinations that would be blocked if newly created or changed.

## Registry And Private Templates

Add Hardware supports three sources:

- **Catalog** searches a verified official snapshot through a disposable local SQLite index. Search terms never leave the installation.
- **Manual** keeps the complete local type-specific editor and remains available in every mode.
- **Private templates** store sanitized reusable hardware definitions in `/data` and support checksummed JSON import/export.

Registry mode defaults to **Disabled**, which makes no catalog requests. Private templates never include device properties, IP or MAC addresses, notes, assignments, connections, canvas positions, agent data, or smart-device instance configuration.

**Offline file** mode imports the same signed immutable snapshot used by connected installations without making outbound requests. **Connected** mode checks only the fixed official registry endpoint and atomically retains the previous catalog if a checksum, signature, schema, expiry, or size check fails. Catalog imports create independent local inventory records linked by numeric IDs to the verified template revision; newer definitions are reviewed before application, and local-only properties remain unchanged.

Linked-catalog updates are classified by their final non-destructive merge. Installations can keep manual review, automatically accept safe enrichments, or trust compatible Registry updates while retaining local names, private metadata, assignments, numeric resource identities, canvas placements, cables, and route cache. The review center lazy-loads field-level changes and keeps applied, declined, review-required, and blocked decisions visible.

Automatic catalog contributions are a separate explicit opt-in available only in Connected mode. The Bun backend allowlists reusable hardware fields, removes instance-owned data, checks the signed published/pending/suppressed digest index locally, and delivers bounded signed batches asynchronously. Inventory saves never wait for registry delivery. The settings view shows queued, retrying, delivered, accepted, rejected, and suppressed totals and provides pause, enrollment revocation, and installation-key rotation controls.

Before delivery, eligible inventory is projected by hardware category and grouped by normalized product identity. Case, whitespace, manufacturer aliases, and private display names do not create duplicate candidates. Identical physical copies remain separate inventory records but produce one contribution candidate, while different board variants and RAM speeds remain distinct. Unidentified generic storage and ambiguous records are withheld locally. Exact matches to a published catalog definition link every matching local copy without asking the user to merge physical inventory.

Each deployment keeps a random stable UUID in `/data/registry/installation-instance.json` beside its Ed25519 private key and short-lived contribution credentials. All three files are backend-only mode-`0600` enrollment state. The UUID is not derived from the host or inventory, key rotation preserves the same logical installation, and lost keys require registry-owner approval before contributions resume. Private keys and tokens are never stored in `registry.json`, returned to the browser, or included in catalog searches. The registry intake quarantines submissions behind deterministic validation and rate limits; intake does not invoke an AI model synchronously and no contribution is published without the registry moderation workflow.

An enrolled Connected installation also reports catalog adoption at startup, after catalog activation, and every six hours. This signed operational check-in contains only the application version, active catalog revision, and request timestamp. It never includes inventory, topology, labels, addresses, hardware identifiers, Agent data, or host identity, and a failed check-in does not block the application.

## Projects And Workspaces

The project switcher in the header selects the active project. Every project starts with a fixed **Systems** workspace and a **Canvas** workspace. Systems remains first and provides a structured compute-host view; Canvas workspaces retain the visual equipment, assignment, and cabling workbench. Additional Canvas workspaces can be renamed, assigned a curated icon and color, and reordered from the bottom workbook bar.

Systems uses a dense, resizable table with sortable columns, compact Agent and Registry state, animated CPU, segmented memory, and storage utilization, and a shared compatibility-attention count. Optional tag and typed custom-field columns can be shown per saved view. Metadata edits autosave, participate in application-wide Undo and Redo, and use an independent persistence revision so they do not rebuild the workspace engine or reroute unchanged cables.

Each project can choose its default workspace. An optional browser preference instead reopens the last workspace used in that project. Navigation uses project/workspace URLs, so refresh and browser history preserve the selected workbook context.

New projects include global inventory by default, but global records appear only after an explicit project membership is added. Project-bound records remain owned by one project. Promoting a record makes it reusable; duplicating it to another project creates a clean independent item and intentionally omits serials, Registry links, Agent identity, telemetry, assignments, Canvas placement, and cables.

## Docker Tags And Release Channels

- `mriverodorta/homelab-inventory:stable` is promoted from the `stable` branch after local production-shaped staging. Use this for regular homelab deployments and Watchtower.
- `mriverodorta/homelab-inventory:latest` is promoted from the `main` branch after local staging. It is the newest development image and can be unstable.
- `mriverodorta/homelab-inventory:<X.Y.Z>` is an immutable stable release image for pinned deployments.
- `mriverodorta/homelab-inventory:<X.Y>` follows the newest stable patch in that minor series.

Recommended Compose image:

```yaml
image: mriverodorta/homelab-inventory:stable
```

GitHub is the source of truth for source history and pull-request review; deployment validation and release construction are local and exact-artifact based:

- Pull requests validate lint, tests, and production build.
- Approved releases from `main` move the `latest` Docker image after ARM64 staging and two-platform vulnerability verification.
- Approved promotions from `stable` publish `stable`, immutable `X.Y.Z`, and the moving `X.Y` series alias.
- Docker Hub receives the exact ARM64 and AMD64 OCI manifests that passed local smoke and zero-vulnerability checks; publication does not rebuild them.
- Local smoke and scanner runs load those archives through a verified config-and-rootfs projection, so runtime testing does not require a temporary Registry or a second image build.
- Unchanged Rust/WASM and Agent inputs reuse checksum-verified receipts and portable artifacts instead of recompiling Rust or Go inside each architecture image, while generated compiler and Docker caches are still removed after release.
- Independent JavaScript test families run concurrently, and the empty BuildKit runtime may remain between ARM64 approval and AMD64 construction only after every build record has been pruned.
- GitHub retains pull-request CI plus scheduled CodeQL and published-image monitoring; pushes made by the guarded deployment pipeline do not start duplicate hosted verification.
- Stable promotion creates the matching `vX.Y.Z` Git tag and GitHub Release only after both Docker architectures are verified.
- Existing numbered Docker images are never overwritten; historical restoration must use the same guarded local pipeline.

Release process details: [docs/RELEASES.md](docs/RELEASES.md)

Before upgrading a Docker deployment across schema versions, back up the complete mounted `/data` directory. Schema migrations create an internal backup before changing data, but that does not replace an external copy or filesystem snapshot.

The migration guide documents compatibility normalization, physical RAM records, registry identity, Agent relationships, and current motherboard-topology migrations. See [docs/MIGRATIONS.md](docs/MIGRATIONS.md) before upgrading across multiple schema versions.

## Update Notifications

Homelab Inventory checks Docker Hub at startup and every six hours for a newer image on `UPDATE_CHANNEL`. The default is `stable`; use `latest` only when you intentionally follow the fast-moving main channel.

The backend makes an anonymous, read-only request for `mriverodorta/homelab-inventory` metadata. It does not send inventory data, IP addresses, credentials, or an installation identifier. Set `UPDATE_CHECK_ENABLED=false` for an offline installation.

When an update is available, the canvas toolbar shows an update notice with release highlights, a manual **Check now** action, copyable `docker compose pull` / `docker compose up -d` commands, and **Skip this version**. Skipping suppresses only that exact version; a later version is shown automatically. Watchtower users can continue using their existing automatic-update workflow.

## Agent

The optional Homelab Inventory Agent uses outbound-only HTTPS and scopes one Ed25519 device identity to one server, NAS device, or custom PC build. Signed protocol-v1 heartbeats are stored independently in `/data/databases/telemetry.sqlite`; they do not create workspace history or advance the project revision. CPU and memory retain exactly 30 one-minute slots. Services, containers, filesystems, GPUs, sensors, system facts, load, uptime, and storage health are kept as current state, while meaningful lifecycle and health transitions remain available to notifications. Network and disk-I/O history are not retained.

Open a compute host's **Agent** tab to create a one-time enrollment and copy the generated Linux or FreeBSD/OPNsense installation command. The Linux installer detects systemd or OpenRC and supports Alpine Linux 3.22 without installing packages. Each application image embeds a pinned, reproducibly built release for Linux AMD64, Linux ARM64, and FreeBSD AMD64. The server verifies every embedded artifact before startup and serves immutable versioned downloads from your own installation.

An enrolled host can expose these capability-driven views:

- **Agent**: health state, 30-minute heartbeat history, operating-system version, host uptime, CPU and memory history, aggregate local-storage usage, enrollment details, and available updates.
- **Services**: locally installed or system services with independent scope and runtime-state filters.
- **Containers**: opt-in Docker or Podman state, health, uptime, Compose service, CPU, memory, published ports, and network metadata.
- **Storage usage**: physical-device and mount-level capacity, partition tables, filesystems, and LVM or RAID topology for confidently mapped inventory drives.

Container telemetry is disabled by default. Setup can use a credential-free Docker-compatible proxy bound to loopback or, after a clear warning, direct access to an allowlisted local runtime socket. The protocol excludes arbitrary labels, environment variables, commands, arguments, mounts, secrets, addresses, and raw inspect responses.

Updated agents hash capabilities, send only changed state between six-hour reconciliations, and receive acknowledgements only in responses to their own outbound requests. Existing full-heartbeat agents remain compatible and are compacted at the application boundary. Upgrading an existing installation automatically replaces legacy telemetry history with the bounded schema after integrity verification; no operator migration is required.

The normal Linux or FreeBSD service is unprivileged. Complete hardware discovery is a separate, explicit `sudo homelab-inventory-agent inventory` command that previews a component summary and asks before sending. The application keeps the latest evidence private, shows the complete JSON for troubleshooting, and offers individual field suggestions with replacement confirmation and Undo. Raw serials and hardware fingerprints never enter registry contributions.

Agent upgrades are always explicit. Older installations receive a one-time verified installer upgrade command; current releases use `sudo homelab-inventory-agent update`. Unlinking stops delivery and retains telemetry by default, with a separate unchecked option to delete only that host's history.

The independently maintained source is public at [mriverodorta/homelab-inventory-agent](https://github.com/mriverodorta/homelab-inventory-agent). The application pins an exact source revision, while normal users install the verified binary served by their own Homelab Inventory instance. Inventory, canvas layout, compatibility, and cabling continue to work without an Agent.

## Notifications

Notifications are an explicit opt-in workspace feature built on Agent telemetry. Configure reusable **Ntfy** or generic **Webhook** contact points under **Settings > Notifications**, then assign them to rules for host outages and selected service, container, or physical-storage health changes.

The server persists normalized states, debounce transitions, incidents, acknowledgements, per-resource cooldowns, reminders, delivery jobs, and redacted attempts. A host outage inhibits child-resource alerts, recovery is delivered only to destinations that received the opening alert, and failed HTTP delivery uses bounded backoff before appearing for manual retry in the toolbar **Notification Center**. Quiet hours and temporary host mutes suppress delivery without discarding incident history. Persisted sequence cursors reject replayed and stale buffered samples across restarts while accounting for stable agent clock offset.

Per-host controls live in the compute host's **Agent** tab. A host can inherit workspace rules, select specific reported resources with custom overrides, or disable notifications. Selected services ask the agent for one-minute service collection; hosts without selected services retain the normal ten-minute service cadence. The app shows the desired policy revision as pending until a later outbound agent heartbeat acknowledges that it was applied.

Contact credentials and generic webhook destination URLs are encrypted at rest under `/data/notifications` with a local key restricted to mode `0600`. Public APIs and logs redact these values, complete/custom backups enforce the key and encrypted store dependency, and demo sessions cannot create credentials or deliver notifications. Keep HTTPS and the normal trusted-network deployment boundary in place because webhook delivery leaves the application server.

## Security

Built-in multi-user authentication can protect the UI and browser API, but it is optional on upgraded installations and does not terminate TLS. Keep the app behind a trusted network boundary, VPN, or HTTPS reverse proxy. Machine agent registration and heartbeat endpoints retain their separate scoped-token authentication.

Read [SECURITY.md](SECURITY.md) before deploying outside localhost.

## Contributing

Issues and pull requests are welcome. Start with [CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT. See [LICENSE](LICENSE).

homelab-inventory

Owner Repos

File Explorer

# Use via CDN

# Project Badges

Was this content helpful?

Recent Feedback

homelab-inventory

Owner Repos

File Explorer

# Use via CDN

# Project Badges

Was this content helpful?

Recent Feedback

Download README