Struct Config 

pub struct Config {

    pub database_path: PathBuf,
    pub full_network: bool,
    pub ephemeral: bool,
    pub ephemeral_ttl: Duration,
    pub relays: Vec<FirehoseSource>,
    pub plc_urls: Vec<Url>,
    pub enable_firehose: bool,
    pub firehose_workers: usize,
    pub cursor_save_interval: Duration,
    pub repo_fetch_timeout: Duration,
    pub backfill_concurrency_limit: usize,
    pub enable_crawler: Option<bool>,
    pub crawler_max_pending_repos: usize,
    pub crawler_resume_pending_repos: usize,
    pub crawler_sources: Vec<CrawlerSource>,
    pub verify_signatures: SignatureVerification,
    pub identity_cache_size: u64,
    pub verify_mst: bool,
    pub rev_clock_skew_secs: i64,
    pub filter_signals: Option<Vec<String>>,
    pub filter_collections: Option<Vec<String>>,
    pub filter_excludes: Option<Vec<String>>,
    pub enable_backlinks: bool,
    pub seed_hosts: Vec<Url>,
    pub trusted_hosts: Vec<String>,
    pub rate_tiers: HashMap<String, RateTier>,
    pub cache_size: u64,
    pub data_compression: Compression,
    pub journal_compression: Compression,
    pub db_worker_threads: usize,
    pub db_max_journaling_size_mb: u64,
    pub db_blocks_memtable_size_mb: u64,
    pub db_repos_memtable_size_mb: u64,
    pub db_events_memtable_size_mb: u64,
    pub db_records_memtable_size_mb: u64,
}

Fields

database_path: PathBuf

path to the database folder. set via HYDRANT_DATABASE_PATH.

full_network: bool

if true, discovers and indexes all repositories in the network. set via HYDRANT_FULL_NETWORK.

ephemeral: bool

if true, no records are stored; events are deleted after ephemeral_ttl. set via HYDRANT_EPHEMERAL.

ephemeral_ttl: Duration

how long events are retained in ephemeral mode before deletion. set via HYDRANT_EPHEMERAL_TTL (humantime duration, e.g. 60min).

relays: Vec<FirehoseSource>

firehose sources for ingestion. set via HYDRANT_RELAY_HOST (single) or HYDRANT_RELAY_HOSTS (comma-separated; takes precedence). prefix a URL with pds:: to mark it as a direct PDS connection.

plc_urls: Vec<Url>

base URL(s) of the PLC directory (comma-separated for multiple). defaults to https://plc.wtf, or https://plc.directory in full-network mode. set via HYDRANT_PLC_URL.

enable_firehose: bool

whether to ingest events from relay firehose subscriptions. set via HYDRANT_ENABLE_FIREHOSE.

firehose_workers: usize

number of concurrent workers processing firehose events. set via HYDRANT_FIREHOSE_WORKERS.

cursor_save_interval: Duration

how often the firehose cursor is persisted to disk. set via HYDRANT_CURSOR_SAVE_INTERVAL (humantime duration, e.g. 3sec).

repo_fetch_timeout: Duration

timeout for fetching a full repository CAR during backfill. set via HYDRANT_REPO_FETCH_TIMEOUT (humantime duration, e.g. 5min).

backfill_concurrency_limit: usize

maximum number of concurrent backfill tasks. set via HYDRANT_BACKFILL_CONCURRENCY_LIMIT.

enable_crawler: Option<bool>

whether to run the network crawler. None defers to the default for the current mode. set via HYDRANT_ENABLE_CRAWLER.

crawler_max_pending_repos: usize

maximum number of repos allowed in the backfill pending queue before the crawler pauses. set via HYDRANT_CRAWLER_MAX_PENDING_REPOS.

crawler_resume_pending_repos: usize

pending queue size at which the crawler resumes after being paused. set via HYDRANT_CRAWLER_RESUME_PENDING_REPOS.

crawler_sources: Vec<CrawlerSource>

crawler sources: each entry pairs a URL with a discovery mode.

set via HYDRANT_CRAWLER_URLS as a comma-separated list of [mode::]url entries, e.g. relay::wss://bsky.network,by_collection::https://lightrail.microcosm.blue. a bare URL without a mode:: prefix uses the default mode (relay for full-network, by_collection otherwise). defaults to the relay hosts with the default mode. set to an empty string to disable crawling entirely.

verify_signatures: SignatureVerification

signature verification level for incoming commits. set via HYDRANT_VERIFY_SIGNATURES (full, backfill-only, or none).

identity_cache_size: u64

number of resolved identities to keep in the in-memory LRU cache. set via HYDRANT_IDENTITY_CACHE_SIZE.

verify_mst: bool

enable MST inversion validation on incoming commits (expensive). set via HYDRANT_VERIFY_MST.

rev_clock_skew_secs: i64

clock drift window for future-rev rejection, in seconds. commits with a rev timestamp more than this many seconds in the future are rejected. set via HYDRANT_REV_CLOCK_SKEW. default: 300 (5 minutes).

filter_signals: Option<Vec<String>>

NSID patterns that trigger auto-discovery in filter mode (e.g. app.bsky.feed.post). set via HYDRANT_FILTER_SIGNALS as a comma-separated list.

filter_collections: Option<Vec<String>>

NSID patterns used to filter which record collections are stored. if None, all collections are stored. set via HYDRANT_FILTER_COLLECTIONS.

filter_excludes: Option<Vec<String>>

DIDs that are always skipped, regardless of mode. set via HYDRANT_FILTER_EXCLUDES as a comma-separated list.

enable_backlinks: bool

enable backlinks indexing (only meaningful in non-ephemeral mode). set via HYDRANT_ENABLE_BACKLINKS=true.

seed_hosts: Vec<Url>

base URL(s) of relay or aggregator services to seed firehose PDS sources from at startup.

hydrant calls com.atproto.sync.listHosts on each URL and adds the returned PDSes as firehose sources (with is_pds = true). account counts from the response are applied to newly-seen hosts to initialise rate-limiting immediately.

set via HYDRANT_SEED_HOSTS as a comma-separated list of base URLs.

trusted_hosts: Vec<String>

list of trusted PDS/relay hosts to pre-assign to the “trusted” rate tier at startup. set via HYDRANT_TRUSTED_HOSTS as a comma-separated list of hostnames. hosts not present in this list use the “default” tier unless assigned via the API.

rate_tiers: HashMap<String, RateTier>

named rate tier definitions for PDS rate limiting.

built-in tiers (“default” and “trusted”) are always present and may be overridden. set via HYDRANT_RATE_TIERS as a comma-separated list of name:base/mul/hourly/daily entries, e.g. trusted:5000/10.0/18000000/432000000,custom:100/1.0/7200000/172800000.

cache_size: u64

db internals, tune only if you know what you’re doing.

size of the fjall block cache in MB. set via HYDRANT_CACHE_SIZE.

data_compression: Compression

db internals, tune only if you know what you’re doing.

compression algorithm for data keyspaces (blocks, records, repos, events). set via HYDRANT_DATA_COMPRESSION (lz4, zstd, or none).

journal_compression: Compression

db internals, tune only if you know what you’re doing.

compression algorithm for the fjall journal. set via HYDRANT_JOURNAL_COMPRESSION (lz4, zstd, or none).

db_worker_threads: usize

db internals, tune only if you know what you’re doing.

number of background threads used by the fjall storage engine. set via HYDRANT_DB_WORKER_THREADS.

db_max_journaling_size_mb: u64

db internals, tune only if you know what you’re doing.

maximum total size of the fjall journal in MB before a flush is forced. set via HYDRANT_DB_MAX_JOURNALING_SIZE_MB.

db_blocks_memtable_size_mb: u64

db internals, tune only if you know what you’re doing.

in-memory write buffer (memtable) size for the blocks keyspace in MB. set via HYDRANT_DB_BLOCKS_MEMTABLE_SIZE_MB.

db_repos_memtable_size_mb: u64

db internals, tune only if you know what you’re doing.

in-memory write buffer (memtable) size for the repos keyspace in MB. set via HYDRANT_DB_REPOS_MEMTABLE_SIZE_MB.

db_events_memtable_size_mb: u64

db internals, tune only if you know what you’re doing.

in-memory write buffer (memtable) size for the events keyspace in MB. set via HYDRANT_DB_EVENTS_MEMTABLE_SIZE_MB.

db_records_memtable_size_mb: u64

db internals, tune only if you know what you’re doing.

in-memory write buffer (memtable) size for the records keyspace in MB. set via HYDRANT_DB_RECORDS_MEMTABLE_SIZE_MB.

Implementations

impl Config

pub fn full_network() -> Self

returns the default config for full network usage.

pub fn from_env() -> Result<Self>

reads and builds the config from environment variables, loading .env first if present.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl Display for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.