Open book

Documentation

This page is honest about what exists: a getting-started path through the dashboard, a full API reference, and the source for everything else.

Getting Started

1

Create an account

Register a dashboard account (self-hosted Ory Kratos) and sign in.

2

Create a flock

A flock groups pigeons under one owner — think of it as a project or a fleet.

3

Create a pigeon

Creating a pigeon mints its Ed25519 keypair and returns a one-time device token — this is the only time the token is ever shown. Copy it before dismissing the dialog.

4

Provision the device

Bake the pigeon's endpoint and token into your device build (see the pigeon library below), or use the CoAP-over-TLS PSK fields if your device speaks CoAP instead of HTTPS.

5

Connect and confirm

Once the device reports in, its shadow, telemetry, and logs (if wired up) start showing on the pigeon's detail page in the dashboard — and any alerts you define start evaluating against it.