# gitcask

> An open-source (Apache-2.0), stateless git server that keeps every repository as a write-ahead log in S3-compatible object storage. No database and no leader; any instance serves any repository, and cost scales with pushes rather than with the number of repositories.

Each link below is the canonical document, verbatim. `/llms-full.txt` has all of them in one file.
Source repository: https://github.com/burrr-ai/gitcask

## Start

- [README.md](/llms/readme.md): What gitcask is, a five-minute local run, how it works, running it in production
- [GOAL.md](/llms/goal.md): The target, the acceptance table, and what gitcask does not optimise for
- [docs/PRODUCT.md](/llms/product.md): Core versus platform, open source versus cloud, and what is out of scope

## Design

- [AGENTS.md](/llms/architecture.md): Constraints, the WAL, principles and every design decision in force
- [docs/ROUNDTRIPS.md](/llms/roundtrips.md): Round trips as the cost model, with the per-operation budgets
- [docs/CONTRACT.md](/llms/contract.md): The cross-crate contract
- [docs/DIRECTION.md](/llms/direction.md): How this fork differs from walgit, and the operating decisions

## Reference

- [SECURITY.md](/llms/security.md): Vulnerability reporting and the mixed direct and trusted-proxy authentication contract
- [docs/INITIALIZE.md](/llms/initialize.md): Initializing a pristine repository from a pinned tree
- [docs/IMPORT.md](/llms/import.md): Full-history pristine import: pinning, receipts and bounds
- [docs/EVENTS.md](/llms/events.md): WAL-derived ref events and the webhook bridge
- [docs/LFS.md](/llms/lfs.md): LFS objects in the store
- [docs/INTEGRITY.md](/llms/integrity.md): The object-integrity invariant and the fsck audit

## Operate

- [docs/OPERATIONS.md](/llms/operations.md): Metrics, symptom-first diagnosis, capacity, incidents and recovery
- [docs/MIGRATION.md](/llms/migration.md): Migrating repositories from Gitea
- [gitcask.example.toml](/llms/config.md): Every configuration key with its default and a comment

## Optional

- [docs/RELEASING.md](/llms/releasing.md): How releases are prepared and published
- [CONTRIBUTING.md](/llms/contributing.md): Development, tests and DCO requirements