This README is the one indexed from the repository at its latest ref, not from the tag for this version.

PlaceOS Pulse

The PlaceOS telemetry client.

Usage

require "placeos-pulse"

# Create a new Pulse client
pulse_client = PlaceOS::Pulse::Client.new

# Registers the instance with the PlaceOS Portal.
# The client periodically reports platform telemetry.
pulse_client.start

Configuration

PLACE_PULSE_SAAS           # Whether the instance is a SaaS instance or not, accepts `1, 0, true, false`
PlACE_PULSE_INSTANCE_EMAIL # Email to register the admin of the instance against
PlACE_PULSE_INSTANCE_ID    # Unique identifier for the instance

Contributors

• Gab Fitzgerald - creator
• Caspian Baska - maintainer
• Cameron Reeves - maintainer