Logister Documentation Overview
Documentation

Public setup guides for Logister and its integrations.

This static site is the Cloudflare Pages version of the Logister docs. It carries the setup, operations, and integration guidance that used to live mostly in the GitHub README.

Getting started HTTP API

Overview

Choose the guide that matches your project type.

Logister provides public documentation for Ruby and CFML integrations plus the operations guides needed to self-host the app. Start with the guide that matches how your application sends data today.

Use the product docs as the canonical source of truth. The GitHub README now points here instead of duplicating most setup guidance.
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
Operations guides Teams self-hosting Logister Local development, deployment, ClickHouse, and HTTP reference

Guides

Everything you need to get from zero to a working event feed.

Start here

Set up your first project

Create a project, choose the right integration type, generate an API key, and send your first event.

Read getting started

Operations

Self-host Logister

Use the operations docs for local boot, deployment configuration, ClickHouse, and HTTP payload reference.

Read self-hosting docs

Ruby

Install the gem

Use the Ruby integration guide when your app already runs on Rails or Ruby.

Read Ruby docs

CFML

Send direct payloads

Use the CFML guide for Lucee or Adobe ColdFusion apps that talk to Logister over HTTP.

Read CFML docs

Getting started next

Follow the shortest path to your first event.

  1. Create a project and choose the right integration type.
  2. Generate an API key and store it immediately.
  3. Pick the Ruby or CFML guide based on your application stack.
  4. Use the HTTP API page when you need the exact request shape.
  5. Send one known-good event before broadening instrumentation.

Growing the docs

This is the base for a standalone hosted documentation site.

This static export is designed so the docs can move to Cloudflare Pages cleanly. It keeps the information architecture of the Rails docs while removing the app runtime dependency.

  • Integration guides stay public and easy to share.
  • Operations docs no longer need to live in the README.
  • Future product docs can be added as plain HTML in this directory.