|
1 | 1 | --- |
2 | 2 | icon: arrow-progress |
3 | | -description: The Conserver — a Redis-backed conversation processing engine that ingests vCons, runs them through configurable chains of links, and writes the results to any of fourteen storage backends. |
| 3 | +description: Start here to learn what the conserver does, get one running, configure it, and find the reference page for each part. |
4 | 4 | --- |
5 | 5 |
|
6 | 6 | # Conserver |
7 | 7 |
|
8 | | -The Conserver is the runtime that turns vCons into something useful. It pulls vCons off Redis ingress queues, runs them through a configurable pipeline of **links** (transcribe → analyze → tag → notify → record audit trail → …), and writes the finished result to one or more **storages** (Postgres, S3, MongoDB, Elasticsearch, Milvus, SCITT transparency services, the vCon MCP server, and more). |
| 8 | +The conserver is an open source server that takes in vCons, runs each one through a configured chain of processing steps, and writes the result to the storage systems you choose. Steps are called links: transcribe, summarize, tag, route, redact, notify, register on a SCITT ledger. The current build ships 23 links and 15 storage modules. Source: [vcon-dev/vcon-server](https://github.com/vcon-dev/vcon-server) (MIT, Python 3.12, FastAPI, Redis, Docker Compose). |
9 | 9 |
|
10 | | -It's an [open-source project](https://github.com/vcon-dev/vcon-server) — Python 3.12, FastAPI for the API tier, Redis for queuing, Docker Compose for deployment. The current build ships **22 standard links** and **14 storage backends**, plus tracers that emit a verifiable audit trail of every chain execution. |
| 10 | +Use a conserver when vCons arrive from adapters (phone systems, SIPREC, chat, AI agent sessions) and something has to happen to every one of them, the same way, with failures captured in dead letter queues. |
11 | 11 |
|
12 | | -## When to use the Conserver |
| 12 | +## Path through this section |
13 | 13 |
|
14 | | -- You have vCons arriving from one or more adapters (phone systems, SIPREC, email, chat, LLM exports) and need to do something with them at scale. |
15 | | -- You need a transcribe → analyze → store pipeline that runs reliably, scales horizontally, and handles failures via dead-letter queues. |
16 | | -- You want a single integration point for downstream systems (CRM, data warehouse, MCP server, blockchain audit log) so adapter teams don't each build their own. |
17 | | -- You need to track lifecycle events — creation, enhancement, deletion, consent revocation — on a [SCITT transparency ledger](../extensions/lifecycle.md). |
| 14 | +**1. Understand it** |
18 | 15 |
|
19 | | -## Documentation layout |
| 16 | +- [Conserver Introduction](conserver-introduction.md): what a conserver is for, with public sources |
| 17 | +- [Concepts](concepts.md): vCon, link, chain, ingress and egress lists, storage, dead letter queues, tracer, follower. The rules for how a chain runs live here. |
| 18 | +- [Day in the Life of a vCon](day-in-the-life-of-a-vcon.md): one phone call followed from adapter to AI assistant |
| 19 | +- [The Journey of a vCon](vcon-conveyor-infographic.md): the same trip as an interactive picture |
20 | 20 |
|
21 | | -**Get started:** |
| 21 | +**2. Run it** |
22 | 22 |
|
23 | | -- [Conserver Introduction](conserver-introduction.md) — overview and design rationale |
24 | | -- [Quick Start](conserver-quick-start.md) — Docker Compose in fifteen minutes |
25 | | -- [Concepts](concepts.md) — Link, Chain, Storage, Tracer |
| 23 | +- [Quick Start](conserver-quick-start.md): a working conserver on Docker Compose |
26 | 24 |
|
27 | | -**Configure:** |
| 25 | +**3. Configure it** |
28 | 26 |
|
29 | | -- [Configuring the Conserver](configuring-the-conserver.md) — every env var and every YAML section |
30 | | -- [Standard Links](standard-links.md) — reference for all 22 shipped links |
31 | | -- [Storage](storage.md) — reference for all 14 storage backends |
32 | | -- [Conserver Tracers](conserver-tracers.md) — audit and compliance trail |
| 27 | +- [Configuring the Conserver](configuring-the-conserver.md): environment variables and every `config.yml` section |
| 28 | +- [Standard Links](standard-links.md): all 23 links and their options |
| 29 | +- [Storage](storage.md): all 15 storage modules |
| 30 | +- [Conserver Tracers](conserver-tracers.md): the JLINC audit tracer |
33 | 31 |
|
34 | | -**Build:** |
| 32 | +**4. Build on it** |
35 | 33 |
|
36 | | -- [Creating Custom Links](creating-custom-links.md) — write your own processing step |
37 | | -- [API](api.md) — REST endpoints for vCon CRUD, ingress / egress, configuration, DLQ |
38 | | -- [Integrating Your App](integrating-your-app.md) — calling the API from your code |
| 34 | +- [Integrating Your App](integrating-your-app.md): sending vCons in and reading results out |
| 35 | +- [API](api.md): every REST endpoint |
| 36 | +- [Creating Custom Links](creating-custom-links.md): writing your own processing step |
39 | 37 |
|
40 | | -**Operate:** |
| 38 | +**5. Operate it** |
41 | 39 |
|
42 | | -- [Production Deployment](production-deployment.md) — Docker Compose, scaling, secrets, observability |
43 | | -- [Inside the Conserver](inside-the-conserver.md) — architecture and request flow |
44 | | -- [Day in the Life of a vCon](day-in-the-life-of-a-vcon.md) — narrative walkthrough |
45 | | -- [Troubleshooting](troubleshooting.md) — common issues and their fixes |
46 | | -- [Operational Benefits](operational-benefits-of-conservers.md) — federation, multi-tenancy, governance |
47 | | - |
48 | | -**Source and support:** |
49 | | - |
50 | | -- [GitHub: vcon-dev/vcon-server](https://github.com/vcon-dev/vcon-server) — the canonical repository |
| 40 | +- [Production Deployment](production-deployment.md): scaling, secrets, observability |
| 41 | +- [Inside the Conserver](inside-the-conserver.md): workers, Redis keys and the processing loop |
| 42 | +- [Troubleshooting](troubleshooting.md): common failures and fixes |
| 43 | +- [Operational Benefits](operational-benefits-of-conservers.md): what running one buys you, with public sources |
0 commit comments