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!
you can see random.wisp.place (standalone binary using http API) or the statusphere example (hydrant-as-library) for examples. for rust docs look at https://hydrant.klbr.net/ for now.
WARNING: the db format is only partially stable. we provide migrations in hydrant itself, so nothing should go wrong! you should still probably keep backups just in case!
what's here#
- vs tap: comparison against tap, the go sync utility
- getting started: building, running, reverse proxying
- configuration: all environment variables
- build features: optional cargo features (
relay,backlinks, etc.) - concepts: how the stream works, relay comparison, multi-relay support
- rest api: management API reference
- xrpc: data access via XRPC
quick start#
cargo build --releaseexport HYDRANT_DATABASE_PATH=./hydrant.db
./target/release/hydrant