Overview

Core documentation

Install Eventum, understand the pipeline model, configure generators, and master the CLI. Follow in order or jump to what you need.

Introduction

Install Eventum, learn what it does, and run your first generator from zero to output in under five minutes.

Features

What Eventum can do — pipeline model, plugin types, live and sample modes, scaling.

Installation

pip, Docker, or from source — pick your setup.

First run

Create a generator and see events flowing in under 5 minutes.

Concepts

How Eventum works under the hood — the generator pipeline, plugin system, scheduling strategies, event production, and output delivery.

Generator

The central abstraction — input → event → output pipeline, modes, and lifecycle.

Plugins

Three plugin types, how they connect, and how configuration flows through.

Scheduling

When events fire — cron, timer, time-patterns, live vs sample mode.

Producing events

Picking modes, Jinja2 templates, state management, samples.

Output

Fan-out delivery, formatters, async lifecycle, batching, error handling.

Configuration

YAML config files, project layout, and runtime variables — everything that controls how generators behave.

Project structure

How files relate, path resolution, single-generator vs application mode.

generator.yml

The generator pipeline config — input, event, and output plugins.

startup.yml

Generator list and per-generator parameter overrides.

eventum.yml

Server, logging, paths, and default generation parameters.

Parameters

Passing runtime values into generator configs.

Secrets

Encrypted credentials via the keyring.

CLI

Four commands that cover every runtime scenario — single-generator runs, full application mode, systemd service management, and secret management.

$ eventum generate

Run a single generator from the command line — all options, verbosity, and piping.

$ eventum run

Start the full application with server, API, and Studio UI.

$ eventum service

Install, uninstall, and manage Eventum as a systemd service.

$ eventum-keyring

Set, get, and remove encrypted secrets in the keyring.