Quick Start

This guide gets OxiPulse installed and sending metrics in under 5 minutes. You'll need a server running Linux (x86_64 or ARM64) or Windows, and an OTLP-compatible endpoint to receive metrics.

Step 1 — Get your token

Log in to the OxiPulse dashboard and generate an agent token from the Settings → Tokens page. It will look like op_live_xxxxxxxxxxxx.

If you're self-hosting your own OTLP collector, you can skip the token step and set OXIPULSE_ENDPOINT directly to your collector's gRPC address.

Step 2 — Install the agent

Linux / macOS

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

Windows (PowerShell — run as Administrator)

PowerShell
irm https://install.oxipulse.dev/windows | iex

The installer will prompt for your token, detect your architecture, download the correct binary, and register the agent as a system service with automatic restart.

Step 3 — Verify the agent is running

Linux

bash
systemctl status oxipulse
Expected output
● oxipulse.service - OxiPulse Telemetry Agent
     Active: active (running)

Windows

powershell
Get-Service -Name OxiPulse

Step 4 — Check data is flowing

Within 10–20 seconds of starting the agent, metrics should appear in your dashboard or OTLP backend. You can also tail the logs to confirm:

Logs
# Linux
journalctl -u oxipulse -f

# Windows
Get-EventLog -LogName Application -Source OxiPulse -Newest 10
Expected log output
INFO oxipulse: agent started, sending metrics every 10s
INFO oxipulse: metrics sent successfully (cpu=12.4%, ram=3.1GB/8GB)
That's it. OxiPulse is now running and streaming your server's vital signs. The agent will also check for updates daily and self-update automatically.

Next steps