-
Notifications
You must be signed in to change notification settings - Fork 0
Bridge Overview
The bridge is an optional companion server that makes your Gubbins data available to other tools — a voice assistant, Home Assistant, an AI assistant, your calendar, a dashboard. The Gubbins app itself never runs a server; the bridge is a separate thing you choose to run.
ℹ️ Note The bridge is a more technical, enthusiast-oriented feature. If you just want to use Gubbins, you can skip this whole section — nothing here is required. Full technical detail lives in the bridge's own
READMEin the Gubbins repository.
Pointed at a copy of your data (a sync snapshot or the SQLite file), the bridge can expose:
- A read-only query API — search and read your items over HTTP.
- A calendar feed (iCal) of due-backs, bookings, maintenance and warranties.
- Change events — webhooks and a live event stream.
- MQTT publishing + Home Assistant discovery.
- An MCP server so an AI assistant can answer "where are my…".
The bridge is built to be cautious:
-
Loopback by default — it listens only on your own machine (
127.0.0.1) unless you deliberately expose it. - Token-protected — requests need a secret token you set.
- Read-only by default — it can't change your data unless you explicitly turn writes on.
- Everything network-facing is opt-in — each feature (events, MQTT, discovery) is off until you enable it, and every choice is logged at startup.
⚠️ Heads-up The bridge reads a copy of your data and can serve it over the network if you configure it to. Treat its token like a password, keep the default loopback bind unless you know you need a LAN, and never commit the token anywhere. See Privacy & security.
- Running the bridge — starting it up.
- Home Assistant integration — the flagship use.
- AI assistant query (MCP) and Webhooks, MQTT & iCal — the other surfaces.
Gubbins · a local-first, offline inventory app · Report an issue
Getting started
Inventory
- Items
- Tracking modes
- Locations & stock
- Location photos & regions
- Batches & lots
- Variants & SKUs
- Kits & bundles
- Tags, attachments & related
- Custom fields & capabilities
- Low stock & gauges
- Counting by weight
- Container weights
- Bulk edit & clone
- Inventory views
Asset lifecycle
- Warranty & depreciation
- Current value & revaluation
- Maintenance & servicing
- Test & calibration records
- Condition grading
- Cycle counts & audit day
- Insurance & estate schedule
People, loans & bookings
Users & access
Search
- Search overview
- Visual query builder
- Text query syntax
- Natural-language search
- Saved searches & favourites
Scanning & labels
Purchasing & projects
- Projects & BOM
- Budgets
- Purchase orders
- Reorder & shopping list
- Wishlist
- Supplier parts & price history
- Suppliers
Reports & insights
- Reports overview
- Valuation & spend
- ABC, turnover & aging
- Sales & margin
- Data hygiene
- Parts catalogue
Sales & disposals
Alerts, activity & agenda
Companion extension
Data, sync & resilience
- How your data is stored
- Cloud sync
- Backup & restore
- Export & import
- Migrating from another tool
- Storage triage
- Danger zone: erasing data
Bridge & Home Assistant
- Bridge overview
- Running the bridge
- Bridge API tokens
- Home Assistant
- AI assistant query (MCP)
- Webhooks
- Webhooks, MQTT & iCal
Settings & customisation
- Appearance & theming
- Branding
- Dashboard & widgets
- Modular UI
- Language & region
- Notifications
- Kiosk & tablet mode
Reference