# Chronicle

> Documentation for Chronicle, version 1.x.
> Every entry links to the page's markdown source.

Repository: https://github.com/xraph/chronicle
Site: https://www.xraph.com/docs/chronicle

## Pages

- [Go Packages](https://www.xraph.com/docs/chronicle/api-reference/go-packages.md): Quick reference for all Chronicle Go packages and their public APIs.
- [HTTP Admin API](https://www.xraph.com/docs/chronicle/api-reference/http-api.md): Complete reference for the Chronicle admin API — 21 endpoints.
- [Architecture](https://www.xraph.com/docs/chronicle/architecture.md): How Chronicle's packages fit together.
- [Configuration](https://www.xraph.com/docs/chronicle/concepts/configuration.md): Options and defaults for chronicle.New and the Forge extension.
- [Entities](https://www.xraph.com/docs/chronicle/concepts/entities.md): The core data types in Chronicle — events, streams, erasures, policies, archives, and reports.
- [Error Handling](https://www.xraph.com/docs/chronicle/concepts/errors.md): Sentinel errors returned by Chronicle operations.
- [Identity (TypeID)](https://www.xraph.com/docs/chronicle/concepts/identity.md): How Chronicle uses prefix-qualified, globally unique identifiers for every entity.
- [Multi-Tenancy](https://www.xraph.com/docs/chronicle/concepts/multi-tenancy.md): How Chronicle scopes audit events and queries to app and tenant contexts.
- [Getting Started](https://www.xraph.com/docs/chronicle/getting-started.md): Install Chronicle and record your first audit event in under five minutes.
- [Custom Store](https://www.xraph.com/docs/chronicle/guides/custom-store.md): Implement your own Chronicle store backend.
- [Forge Extension](https://www.xraph.com/docs/chronicle/guides/forge-extension.md): Mount Chronicle into a Forge application as a first-class extension.
- [Full Example](https://www.xraph.com/docs/chronicle/guides/full-example.md): Complete audit server with PostgreSQL, events, verification, compliance reports, and the admin API.
- [GDPR Erasure](https://www.xraph.com/docs/chronicle/guides/gdpr-erasure.md): End-to-end walkthrough of crypto-erasure for GDPR Article 17 compliance.
- [Introduction](https://www.xraph.com/docs/chronicle.md): Composable immutable audit trail for Go.
- [Memory Store](https://www.xraph.com/docs/chronicle/stores/memory.md): In-memory store for development, testing, and prototyping.
- [MongoDB Store](https://www.xraph.com/docs/chronicle/stores/mongo.md): MongoDB store for document-oriented Chronicle deployments.
- [PostgreSQL Store](https://www.xraph.com/docs/chronicle/stores/postgres.md): Production-ready PostgreSQL store using grove ORM with pgdriver.
- [Redis Store](https://www.xraph.com/docs/chronicle/stores/redis.md): High-throughput Redis store for latency-sensitive Chronicle workloads.
- [SQLite Store](https://www.xraph.com/docs/chronicle/stores/sqlite.md): Lightweight SQLite store for development, testing, and single-node deployments.
- [Admin API](https://www.xraph.com/docs/chronicle/subsystems/admin-api.md): HTTP admin API — 21 endpoints for events, verification, erasure, retention, reports, and stats.
- [Compliance Reports](https://www.xraph.com/docs/chronicle/subsystems/compliance.md): Generating SOC2, HIPAA, EU AI Act, and custom compliance reports from audit data.
- [GDPR Erasure](https://www.xraph.com/docs/chronicle/subsystems/erasure.md): Crypto-erasure — destroying per-subject encryption keys to make data irrecoverable.
- [Observability](https://www.xraph.com/docs/chronicle/subsystems/observability.md): Logging, AfterRecord plugins for metrics and tracing, and AlertHandler for real-time alerting.
- [Plugins](https://www.xraph.com/docs/chronicle/subsystems/plugins.md): The Chronicle plugin system — hook interfaces, the registry, and ErrSkipEvent.
- [Recording Events](https://www.xraph.com/docs/chronicle/subsystems/recording.md): The EventBuilder API and how Chronicle persists events to the hash chain.
- [Retention](https://www.xraph.com/docs/chronicle/subsystems/retention.md): Policy-based event archival and purge.
- [Sinks](https://www.xraph.com/docs/chronicle/subsystems/sinks.md): Fire-and-forget event output targets — stdout, file, S3, and custom.
- [Verification](https://www.xraph.com/docs/chronicle/subsystems/verification.md): Hash chain integrity verification — detecting tampered or deleted events.