Skip to content

Install (macOS)

HeliosLogs ships as a single self-contained binary for macOS (the web UI is embedded — nothing else to install). Two ways to get it:

For containers see the Quickstart; for Linux servers see Install (Linux).

Homebrew

Install from the HeliosLogs tap:

bash
brew install helioslogs/tap/helioslogs

That's it — Homebrew picks the right build for your Mac (Apple Silicon or Intel). Then run it.

To upgrade later:

bash
brew upgrade helioslogs

Installer package (.pkg)

Download the latest .pkg from the GitHub Releases page (helioslogs-<version>-macos-arm64.pkg), or grab a specific version directly:

bash
curl -fLO https://github.com/helioslogs/helioslogs/releases/download/v0.2.2/helioslogs-0.2.2-macos-arm64.pkg

Double-click it (or sudo installer -pkg helioslogs-0.2.2-macos-arm64.pkg -target /). It installs the binary to /usr/local/bin/helioslogs. The package is signed with a Developer ID and notarized by Apple, so Gatekeeper lets it through with no warnings. Then run it.

Apple Silicon only

The .pkg is built for Apple Silicon (arm64). On an Intel Mac, use Homebrew instead — it has an Intel build.

Run it

There's no background service on macOS — you run HeliosLogs in the foreground (or daemonize it yourself with launchd/nohup):

bash
helioslogs serve --port 7300 --data-dir ~/.helioslogs/data
# listening on http://127.0.0.1:7300

Open http://localhost:7300 and complete the one-time setup wizard to create your admin account.

See First steps for what to do next.

Binding the host

serve binds to loopback (127.0.0.1) by default — reachable only from your Mac. To accept connections from elsewhere add --host 0.0.0.0, and read Security hardening first.

Where things live

PathContents
helioslogs binaryHomebrew: $(brew --prefix)/bin/helioslogs (/opt/homebrew/bin on Apple Silicon, /usr/local/bin on Intel). .pkg: /usr/local/bin/helioslogs.
--data-dir (e.g. ~/.helioslogs/data)Log partitions and (single-node) control plane.
./secret-control.json, ./secret-jwt.jsonEncryption + JWT keys, written to the working directory by default.

Keep the two secret files outside --data-dir and back them up — override their locations with HELIOS_CONTROL_KEY_PATH / HELIOS_JWT_SECRET_PATH. See Secrets & encryption.

Uninstall

bash
# Homebrew
brew uninstall helioslogs

# .pkg
sudo rm /usr/local/bin/helioslogs
sudo pkgutil --forget com.appbird.helioslogs

Your data and secret files are left in place — delete them manually for a clean slate.