Repository navigation
Home
GearBeacon is a private, single-owner UniFi Store inventory monitor. It checks stock on your server, organizes watches and purchase plans, and sends alerts through the channels you choose. No GearBeacon or Ubiquiti cloud login is required.
This wiki covers GearBeacon 1.2.0, including the current repository layout. Start with the installation guide for your platform, then use the task guides as needed. Downloaded release archives keep the layout they shipped with; source-launcher differences are explained in Source installation.
Current dev additions are labeled in their guides: saved views, compact Watchlist, budget-aware collection alerts, alert explanations, stable Activity pages, background refresh improvements, and verified updates. They are not part of the published v1.2.0 downloads. Dev now uses schema v12/export format v8; review recovery compatibility before upgrading.
For optional purchasing on current dev, use Auto-buy: address setup and verification. It explains the Home nickname, both terminal confirmation steps, and the Profiles and Verify commands. Auto-buy was added after the v1.3.0 stable release and requires current dev source; it is not included in those stable downloads.
- Choose an installation and finish first run.
- Find products and build your Watchlist.
- Set up alerts and test delivery.
- Create a backup and test recovery.
| Guide | What it covers |
|---|---|
| Windows | Portable executable, automatic startup, task management, logs |
| macOS | Intel/Apple Silicon packages, LaunchDaemon, permissions |
| Linux | x64/ARM64 packages, systemd, secondary-storage access |
| Docker and NAS | Compose, persistent volumes, image pinning, private access |
| Source installation | Node requirements, launchers, environment files, offline demo |
| Configuration reference | Environment defaults, saved-setting precedence, ranges |
| Security and access | Access modes, owner login, password recovery, privacy |
| Reverse proxy | Same-host HTTPS, Caddy/Nginx examples, container limitations |
| Guide | What it covers |
|---|---|
| Watchlist and Browse | Filters, exact variants, imports, overview counts, purchases |
| Collections and purchase planning | Grouping, quantities, actual spending, budgets, archive/undo |
| Auto-buy (dev) | Companion setup, address nicknames, saved-profile checks, browser verification, recovery |
| Alerts and notifications | Item conditions, collection overrides, scheduling, retries |
| Email and webhooks | SMTP/TLS, email previews, ntfy/Discord/Gotify, signed webhooks |
| Stock insights and monitoring | Confirmation rules, timelines, price windows, coverage gaps |
| Activity and Operations | Pagination, evidence, health, delivery failures, diagnostics |
| Guide | What it covers |
|---|---|
| Backups and recovery | Data paths, encryption, secondary copies, restore procedures |
| Updates and rollback | Backup preparation, platform helpers, version compatibility |
| Troubleshooting | Startup, access, alerts, collections, storage, useful evidence |
| API reference | Authentication, regional identities, route map, request examples |
| Development and releases | Architecture, test commands, CI, packaging, release policy |
For version history, read the release notes, changelog, and published releases. Report vulnerabilities through the private security process.
GearBeacon is independent and is not affiliated with or endorsed by Ubiquiti Inc. Ubiquiti and UniFi are trademarks of their respective owner. GearBeacon uses the Apache License 2.0; see NOTICE.
Wiki home · Troubleshooting · Source repository · Releases · Report a security issue privately
Documentation covers GearBeacon 1.2.0 and the current source layout. GearBeacon is independent and is not affiliated with or endorsed by Ubiquiti Inc.
Start and install
Use GearBeacon
- Watchlist and Browse
- Collections and purchases
- Auto-buy setup and verification (dev)
- Alerts and notifications
- Email and webhooks
- Stock insights
- Activity and Operations
Configure and maintain
- Configuration reference
- Security and access
- Reverse proxy
- Backups and recovery
- Updates and rollback
- Troubleshooting
Develop