Download
Home Download About Docs

Documentation

Install from a release, run the dashboard, and use the local API on the same machine. Everything below reflects how the published builds are meant to be operated end to end.

Installation

  1. Open the project’s Releases and find the latest version tag.
  2. Download the Windows installer, macOS zip, or Linux AppImage for your system.
  3. Windows: run the installer and follow the steps. Choose an install path you can find again.
  4. macOS: expand the zip and move the application to Applications or another folder you prefer.
  5. Linux: set the execute bit on the AppImage, then run it. Install libfuse if your distro requires it for AppImages.

After you install

Launch the SentraCore dashboard from the shortcut or application menu. The first session may take a moment while components initialize. Keep the machine awake until the status area shows a healthy connection when that appears in your build.

If security software blocks localhost traffic, create an exception for the dashboard and engine executables so they can bind and exchange data on the loopback interface.

System requirements

  • Windows: 64-bit Windows 10 or newer with enough free disk for the install and logs.
  • macOS: A supported macOS release on Apple Silicon or Intel, matching what your CI build targets.
  • Linux: 64-bit glibc-based distribution; FUSE support for AppImage where required.
  • Resources: A few hundred megabytes of disk plus normal RAM for desktop use; heavier workloads on the machine will show up in telemetry naturally.

Dashboard overview

The home experience summarizes stability and stress. Performance views dive into trends over time. Process views highlight what is consuming CPU and memory. Diagnostics and log-oriented screens help when you are tracking down a spike or recurring alert.

Settings let you tune alert thresholds and related options where your build exposes them. Changes may sync to the engine so behavior stays consistent after restarts.

Engine and connectivity

The engine listens on a port described in your configuration. The dashboard connects over HTTP and WebSockets on 127.0.0.1 unless you have changed deployment. If the UI cannot connect, confirm nothing else is blocking the port, that a previous engine instance shut down cleanly, and that you are not mixing stale configuration from an older install path.

API overview

Base URL shape: http://127.0.0.1:<port> where <port> comes from your engine configuration. Typical routes include health checks, aggregated status, preferences, and streams for live data and alerts. Your installed version is the source of truth for the full route list.

Method Path Purpose
GET /api/v1/health Reports whether the engine process is up and responding.
GET /api/v1/status Returns the current system snapshot used by the dashboard.
GET /api/v1/preferences Reads alert and tuning preferences shared with the UI.
PUT /api/v1/preferences Updates preferences so the engine and UI stay aligned.

Troubleshooting

  • Blank or disconnected UI: confirm the engine process is running, then verify port and host in your config file.
  • Repeated prompts: check whether multiple copies of the dashboard or engine were started manually.
  • Downloads fail from this site: open Releases in the browser and download the asset directly.

More detail lives in the repository README and source tree. For issues or questions, use the project’s GitHub home page.