Installation

# Add this to your shard.yml
dependencies:
  placeos-pulse:
    github: placeos/pulse
    version: ~> 1.0.4

Then run:

shards install

shard.yml

Crystal
>= 1.1.1
License
MIT
Authors
Caspian Baska, Cameron Reeves, Gab Fitzgerald

Dependencies

Runtime Dependencies

Development Dependencies

  • ameba*github: crystal-ameba/amebadev
  • faker*github: askn/fakerdev
  • webmock*github: manastech/webmock.cr, branch: masterdev

README

PlaceOS Pulse

CI

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