Documentation

Overview

Documentation

Public setup guides for Logister and its integrations.

This is the public documentation section for Logister. It now carries the setup, operations, and integration guidance that used to live mostly in the GitHub README, so users can find the full product docs in one place.

Getting started HTTP API

Overview

Choose the guide that matches your project type.

Logister currently has public documentation for Ruby and CFML integrations. Each project in the app can be tagged with an integration type so the in-app setup guidance matches the public docs here.

Start with the guide that matches how your app sends data today. You can always revisit the project integration type later if you are migrating from one ingestion style to another.
Guide Best for Main setup path
Ruby integration Rails and Ruby apps logister-ruby gem
CFML integration Lucee and Adobe ColdFusion sites cfhttp plus structured event payloads

Start here

Set up your first project

Use the getting started guide to create a project, generate an API key, and pick the right integration path.

Read getting started

Operations

Self-host Logister

Best for teams running the Logister app themselves with local setup, environment config, and production rollout notes.

Read self-hosting docs

Development

Run the app locally

Best for local boot, Docker-backed infra, seed data, and realistic development verification.

Read local development docs

Deployment

Configure production deploys

Best for environment variables, provider files, email, Turnstile, analytics, and production rollout checks.

Read deployment docs

Analytics

Add ClickHouse

Best for optional high-scale event analytics, schema setup, and health verification.

Read ClickHouse docs

Ruby

Install the `logister-ruby` gem

Best for Rails apps that want native error, metric, log, and check-in capture.

Read Ruby docs

CFML

Send events from Lucee or ColdFusion

Best for CFML sites using `cfhttp`, `Application.cfc.onError()`, and structured exception payloads.

Read CFML docs

Getting started next

Follow the shortest path to your first event.

  1. Read the getting started guide and create a project.
  2. Generate an API key and store it immediately.
  3. Choose the Ruby or CFML guide based on your app stack.
  4. Use the HTTP API reference when you need exact payload details.
  5. Send one test event before adding broader instrumentation.

Growing the section

This is the foundation for broader Logister docs.

New product documentation should be added under this public docs section going forward so setup, feature usage, and integration guidance all live in one consistent place.

  • Integration guides
  • Public setup instructions linked from project settings
  • Future feature docs for the Logister app itself