Skip to content

Getting Started

alexphillips-dev edited this page Sep 10, 2026 · 1 revision

One GearBeacon installation serves one owner through a desktop or mobile browser. Store checks and external notification delivery continue while the browser is closed, provided the host and GearBeacon process remain running.

Choose how to run it

Installation Requirements Best fit
Windows standalone Windows x64 Desktop use or automatic startup
macOS standalone Intel or Apple Silicon Mac Desktop use or a LaunchDaemon
Linux standalone Linux x64 or ARM64 A systemd server
Docker / NAS Compatible Docker host A persistent container
Source Node.js 22.13 or newer Running or modifying the source checkout

Standalone packages include the Node runtime. Download the package for your platform from Releases, extract the whole archive, and keep its executable, web directory, and manifest together. SHA-256 files, SBOMs, and provenance accompany the release; native packages are currently unsigned and macOS packages are not notarized.

Running the executable directly defaults to local-only access at http://localhost:8787. The native automatic-start installers use authenticated private mode. Compose uses private mode inside the container and publishes only host loopback by default.

Complete first run

  1. Start GearBeacon and open its printed dashboard URL. For a same-computer installation, use http://localhost:8787.
  2. In an authenticated installation, enter the one-time setup token from the process, service log, or container log. Treat the token as private.
  3. Complete the owner setup and choose the regions to monitor: United States (us), Canada (ca), Europe (eu), or United Kingdom (uk).
  4. Choose the access mode and optional notification channels. Test a configured channel before relying on it.
  5. Set backup interval and retention, review the final URL and security state, and complete onboarding.
  6. Restart once if the wizard reports a region, bind-address, or access-mode change. Operational settings apply immediately.

The default poll interval is 60 seconds, with a 30-second minimum. Availability reflects observed catalog data; it is not an inventory reservation or a guarantee of checkout availability.

Add your first watch

Open Browse, choose a product, and select Add to Watchlist or collection. Use Any variant for a product-level watch or select a specific SKU, color, length, or pack size. Choose Watchlist or a collection, then confirm. Open Alert rules on the watch to set a price target or change event choices.

The Watchlist guide explains imports and exact variants. Use Collections for projects with quantities and budgets, and Alerts to decide whether project alerts should suppress individual ones.

Confirm the installation is healthy

Open Settings > Operations. Check that each enabled region has completed a successful check and that there are no unresolved storage, security, or delivery warnings. Run diagnostics, create a backup in Settings > Data, then test the latest primary restore.

Use Security and access before enabling remote access, and Backups and recovery before moving or updating an installation. Browser notifications need browser permission and a running page; configure a server channel for alerts when the browser is closed.

Clone this wiki locally