# Ursula

> Open-source Distributed Durable Streams over HTTP, backed by S3.

Customer-facing documentation. Each page is also available as raw markdown at
https://ursula.tonbo.io/docs/<slug>.md (e.g. https://ursula.tonbo.io/docs/quick-start.md). For all docs
concatenated, fetch https://ursula.tonbo.io/llms-full.txt.

## Getting Started

- [Ursula](https://ursula.tonbo.io/docs/introduction.md)
- [Why Ursula](https://ursula.tonbo.io/docs/why-ursula.md)
- [Install](https://ursula.tonbo.io/docs/install.md)
- [Quick Start](https://ursula.tonbo.io/docs/quick-start.md)
- [Clients](https://ursula.tonbo.io/docs/clients.md)

## Deploy

- [Deploy a Cluster](https://ursula.tonbo.io/docs/deploy-cluster.md)
- [Configuration](https://ursula.tonbo.io/docs/configuration.md)
- [Security](https://ursula.tonbo.io/docs/security.md)

## Examples

- [Resumable AI Stream](https://ursula.tonbo.io/docs/examples/resumable-ai-stream.md): Stream LLM tokens through a durable timeline so clients can refresh, reconnect, and resume without losing a token.
- [Chat Room](https://ursula.tonbo.io/docs/examples/chat-room.md): One JSON stream per room: append messages, replay history by record, and tail new messages live.
- [Browser Telemetry](https://ursula.tonbo.io/docs/examples/browser-telemetry.md): Collect replayable browser events with JSON record coordinates and one client event timestamp.

## Concepts

- [Streams](https://ursula.tonbo.io/docs/concepts/streams.md)
- [Buckets](https://ursula.tonbo.io/docs/concepts/buckets.md)
- [Offsets](https://ursula.tonbo.io/docs/concepts/offsets.md)
- [Record Coordinates](https://ursula.tonbo.io/docs/concepts/record-coordinates.md)
- [Read Modes](https://ursula.tonbo.io/docs/concepts/read-modes.md)
- [Exactly-Once Writes](https://ursula.tonbo.io/docs/concepts/exactly-once-writes.md)
- [Conditional Writes](https://ursula.tonbo.io/docs/concepts/conditional-writes.md)
- [Snapshots](https://ursula.tonbo.io/docs/concepts/snapshots.md)
- [Bootstrap](https://ursula.tonbo.io/docs/concepts/bootstrap.md)
- [Durability and Consistency](https://ursula.tonbo.io/docs/concepts/durability-and-consistency.md)
- [Binary SSE](https://ursula.tonbo.io/docs/concepts/binary-sse.md)
- [Length-Prefixed Framing](https://ursula.tonbo.io/docs/concepts/len-prefixed-framing.md)

## API Reference

- [API overview](https://ursula.tonbo.io/docs/api/overview.md)
- [Create bucket](https://ursula.tonbo.io/docs/api/create-bucket.md)
- [Create stream](https://ursula.tonbo.io/docs/api/create-stream.md)
- [Append](https://ursula.tonbo.io/docs/api/append.md)
- [Read stream](https://ursula.tonbo.io/docs/api/read.md)
- [Head stream](https://ursula.tonbo.io/docs/api/head-stream.md)
- [Stream attributes](https://ursula.tonbo.io/docs/api/stream-attrs.md)
- [Publish snapshot](https://ursula.tonbo.io/docs/api/publish-snapshot.md)
- [Read snapshot](https://ursula.tonbo.io/docs/api/read-snapshot.md)
- [Bootstrap](https://ursula.tonbo.io/docs/api/bootstrap.md)
- [Delete stream](https://ursula.tonbo.io/docs/api/delete-stream.md)

## Operate

- [ursulactl](https://ursula.tonbo.io/docs/cli.md)
- [Operations](https://ursula.tonbo.io/docs/operations.md)
- [Observability](https://ursula.tonbo.io/docs/observability.md)
- [Troubleshooting](https://ursula.tonbo.io/docs/troubleshooting.md)

## Architecture

- [Overview](https://ursula.tonbo.io/docs/architecture/overview.md)

## Comparisons

- [Comparisons](https://ursula.tonbo.io/docs/competitive-comparison.md)

## Protocol Specification

- [Durable Streams Protocol](https://ursula.tonbo.io/docs/specs/durable-stream.md)
- [Durable Streams Extensions](https://ursula.tonbo.io/docs/specs/extensions.md)