github.com/PlaceOS/pulse

Heartbeat manager

0 stars

0 dependents

License: MIT

Nothing has been indexed for 0.13.2 yet. The tag is recorded, its shard.yml has not been read, so the manifest and dependency list below are empty because they are unknown rather than because they are absent.

Installation

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

Then run:

shards install

shard.yml

No shard.yml has been indexed for 0.13.2. You can read it on the repository.

Dependencies

Unknown: the shard.yml for this version has not been read yet.

README

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

placeos-pulse

Installation

shard.yml

Dependencies

README

PlaceOS Pulse

Usage

Configuration

Contributors

Documentation

Links

This release

Dependents

Repository

Metadata