~ knotless Search/
↑↓ move↵ open⇧↵ all results
0
0
40 lines · 1.6 KB Raw History
# Monolith documentation

Monolith is an atproto PDS that keeps its state in write-ahead logs on
local disk, with no database beside it. It speaks the same XRPC, OAuth and
firehose as the reference PDS (`@atproto/pds`), so the Bluesky app, relays
and AppViews talk to it like any other PDS.

## Guides

How to do things with Monolith, one task at a time. You don't need a clone
of the repository to run it, only to contribute.

- [Getting started](guide/getting-started.md): get the image or the
  binary, configure it, run it behind your proxy, make the first account
  and sign in from Bluesky.
- [Calling the server](guide/calling.md): XRPC, the `pds` CLI, the MCP
  endpoint, and connecting an AI app.
- [Deploying](guide/deploying.md): the image, the proxy, the environment,
  blobs in a bucket and backups.
- [Operating](guide/operating.md): the log, health, metrics, traces,
  stopping, upgrades, disk and memory.
- [Comparing with the reference](guide/comparing.md): the harness's runs,
  performance, the benchmark and the compatibility check.
- [Contributing](guide/contributing.md): working from a clone, a server
  to try with `just dev --seed`, the just targets, the gates, nightly, the
  code gates and releases.

## Specification

- [PDS.md](../spec/PDS.md): what the server does, with a page for each
  area linked from it.
- [COMMANDS.md](../spec/COMMANDS.md): every method as an MCP tool and a
  CLI command.

## Reference

- [Compatibility](../compat/README.md): how closely other PDSes behave
  like the reference, and how to add one.
- [Benchmark](../bench/README.md): the server beside other PDSes, how to
  run it and the fairness rules.