hydrant hydrant is an AT Protocol indexer built on the fjall database. it's built to be flexible, supporting both full-network indexing and filtered indexing (e.g., by DID), allowing querying with XRPCs (not only com.atproto.*!), providing an ordered event stream, etc. oh and it can also act as a relay!
guide overview guide hydrant
getting started guide building, running, reverse proxying
configuration guide all environment variables
build features guide optional cargo features (relay, backlinks, etc.)
embedding guide running hydrant inside a go (or other non-rust) program
guide 5 pages: overview, getting started, configuration, build features, embedding
concepts overview concepts how the stream works, relay comparison, multi-relay support
vs tap concepts comparison against tap, the go sync utility
relay & seeding concepts multi-relay support, firehose seeding, crawler sources
retention concepts how event and record history ttls behave, and what /stats counts under them
concepts 3 pages: vs tap, relay & seeding, retention how the stream works, relay comparison, multi-relay support
jetstream streams jetstream stream
streams 2 pages: /stream, jetstream
management api overview management api management API reference
filter management api NSID filter configuration
repos management api explicit repository tracking, resyncing, untracking
ingestion management api enable/disable crawler, firehose, backfill at runtime
crawler management api crawler source management
firehose management api firehose source management
pds management api bans and rate-limit tier assignments
database management api compression training, compaction
management api 7 pages: filter, repos, ingestion, crawler, firehose, pds, database hydrant's REST API is split into public endpoints (safe to expose) and management endpoints (keep private). see getting started for guidance on what to expose.
xrpc overview xrpc data access via XRPC
com.atproto.* xrpc standard AT Protocol endpoints
systems.gaze.hydrant.* xrpc hydrant-specific extensions
identity xrpc verified mini-doc identity lookups
repo xrpc at-uri based record lookups
links xrpc backlinks (requires --features backlinks)
xrpc 5 pages: com.atproto.*, systems.gaze.hydrant.*, identity, repo, links hydrant implements the following XRPC endpoints under /xrpc/. only expose /xrpc/* publicly, see getting started for guidance.
db layer internals db layer
record storage internals record storage
internals 2 pages: db layer, record storage