Documentation
Everything you need to deploy Sierpe and query your contracts’ history. The source of truth for the API surface is the OpenAPI spec in the repository.
Installation
Deploy the container on Railway, Docker Compose, or any platform that runs OCI images.
Where it runs
Every deployment target we evaluated — what works, what needs one setting, what fails and why — plus the constraints that let you judge a platform we did not list.
Quickstart
Register a contract and query its complete history in five minutes.
The embedded UI
A management interface baked into the binary — status, contracts, and a data explorer, with no build system and no external assets.
API reference
The v1 REST surface — contracts, events, state, and the honesty contract every response follows.
The archive leg
How Sierpe reaches history no RPC serves anymore — and why it verifies itself before writing a single healed ledger.
Observability
Prometheus metrics, the Grafana dashboard, and the alerts that matter.
AI assistants & agents
Machine-readable docs at /llms.txt, how to point an agent at the API, and why the honesty contract is what makes agent answers trustworthy.
Architecture
The pipeline, the data model, and the design decisions behind the appliance.