Registry Stack documentation
Registry Stack is a set of services for institutions that hold authoritative records, or need to. Each product does one job, runs on its own, and is optional. Pick the one that matches what you need today; how the products fit together describes the model they all share.
Pick a product
Section titled “Pick a product”| You need | Product | Start here |
|---|---|---|
| A signed answer to one question about a record, without handing over the record | Registry Evidence | Overview, then your first assertion |
| A registry you do not have yet: records, an API, permissions, and history, on PostgreSQL | Base Registry Engine (BReg) | Overview, then your first registry; later, deploy it and query it from an application |
| Authorized people to review a request before its sender continues | Registry Casework | Overview, then decide your first ReviewRequest |
| Bookable appointments over capacity you anchor, with short holds | Registry Scheduling | Overview, then prove your first booking policy |
| A PDF from registry data that renders to the same bytes every time | Registry Render | Overview, then render your first document |
| A curated index of providers that relying applications can search | Registry Discovery | Overview, then publish and consume an index |
| Portable, standards-shaped metadata about what a registry exposes | Registry Manifest | Overview, then the manifest data model |
Registry Messaging sends one reviewed email or SMS through a provider you connect. Start with the Registry Messaging overview.
Registry Coordinator runs a reviewed flow of calls to the other products’ APIs and keeps its place across waits and outages. Start with the Registry Coordinator overview. Coordinator is optional; direct BReg and Casework composition does not require it.
The Registry Document Store holds document bytes in custody for the system that owns them and releases one verified version to each recipient a document grant names. Start with the Registry Document Store overview.
Registry Relay was retired in Registry Stack 0.39.0. Its retirement decision names where the last release and its documentation remain and what replaces it.
Choose and combine four adoption paths: configure a starter, add a small extension, build an application, or run a module beside selected products.
Who does what
Section titled “Who does what”Every tutorial names the role it is written for. One institution often holds several.
- The assertion provider is the institution that answers questions about its records with signed facts through Registry Evidence.
- The data publisher is the institution that maintains records through BReg or publishes metadata through Manifest.
- The consumer or verifier is the service that calls a product API and verifies what it receives.
- The operator is whoever installs, configures, and runs a deployment.