v0.1.0

Install OxiPulse

A single command installs the agent, injects your auth token, and registers it as a system service. Up and running in under 60 seconds.

Quick install

Run the install script

The script detects your architecture, downloads the correct binary from GitHub Releases, and sets up a systemd service.

Terminal

curl -fsSL https://install.oxipulse.dev | sudo bash

Enter your auth token when prompted

Get your token from the OxiPulse dashboard. You can also pass it via environment variable to skip the prompt.

Token setup

Enter your OxiPulse token: op_live_xxxxxxxxxxxx

Your token authenticates the agent against the OTLP ingestor. Keep it secret — treat it like a password. Rotate it from the dashboard if compromised.

The agent starts automatically as a systemd service

Verify

# Check the service status
systemctl status oxipulse

# Verify it's sending data
journalctl -u oxipulse -f

Expected output

● oxipulse.service - OxiPulse Telemetry Agent
     Loaded: loaded (/etc/systemd/system/oxipulse.service; enabled)
     Active: active (running) since Mon 2025-01-01 12:00:00 UTC
   Main PID: 1234 (oxipulse)

Jan 01 12:00:01 myserver oxipulse[1234]: INFO oxipulse: agent started, sending metrics every 10s

Managing the service

The agent runs in the background with automatic restart on failure.

systemd

# Start
systemctl start oxipulse

# Stop
systemctl stop oxipulse

# Restart
systemctl restart oxipulse

# Enable on boot (already done by installer)
systemctl enable oxipulse

# Live logs
journalctl -u oxipulse -f

Configuration

OxiPulse reads configuration from environment variables or a config file. Environment variables always take priority.

Variable	Default	Description
OXIPULSE_TOKEN	—	Auth token (required)
OXIPULSE_ENDPOINT	https://ingest.oxipulse.dev	OTLP gRPC endpoint
OXIPULSE_INTERVAL_SECS	10	Metrics collection interval
OXIPULSE_LOG_LEVEL	info	Log verbosity (trace, debug, info, warn, error)
OXIPULSE_BUFFER_PATH	/var/lib/oxipulse/buffer	Offline buffer location

config.toml (optional)

# /etc/oxipulse/config.toml (Linux)
token          = "op_live_xxxxxxxxxxxx"
endpoint       = "https://ingest.oxipulse.dev"
interval_secs  = 10
log_level      = "info"

Never commit config.toml to version control. It contains your auth token. The file is excluded by the default .gitignore.

Supported platforms

OS	Architecture	Status	Binary
Linux	x86_64 (amd64)	Stable	oxipulse-linux-x86_64
Linux	ARM64 (aarch64)	Stable	oxipulse-linux-arm64
Windows	x86_64	Stable	oxipulse-windows-x86_64.exe
Windows	ARM64	Beta	oxipulse-windows-arm64.exe
macOS	x86_64	Coming soon	—
macOS	ARM64 (Apple Silicon)	Coming soon	—

Uninstall

bash

systemctl stop oxipulse && systemctl disable oxipulse
rm -f /usr/local/bin/oxipulse
rm -f /etc/systemd/system/oxipulse.service
rm -rf /etc/oxipulse /var/lib/oxipulse
systemctl daemon-reload

Next steps

Read the docs

Learn about metrics, offline buffer, and auto-update.

Configuration reference

Full list of environment variables and config file options.

Contributing

Open an issue or submit a PR on GitHub.

Changelog

See what changed in each release.