frogdb-server

The main FrogDB server process.

frogdb-server [OPTIONS]

Options

Generated from the Cli struct in frogdb-server/crates/server/src/cli.rs. A flag given on the command line overrides the same setting in the config file; see Configuration Reference for the config-file equivalent of each override.

Option	Short	Type	Default	Description
--config	-c	<FILE>	—	Path to configuration file
--bind	-b	<ADDR>	—	Bind address
--port	-p	<PORT>	—	Listen port
--shards	-s	<N>	—	Number of shards (default: 1, "auto" = num_cpus)
--log-level	-l	<LEVEL>	—	Log level (trace, debug, info, warn, error)
--log-format		<FORMAT>	—	Log format (pretty, json)
--admin-bind		<ADDR>	—	Admin bind address (overrides config)
--admin-port		<PORT>	—	Admin port (overrides config, implies admin.enabled=true)
--http-bind		<ADDR>	—	HTTP server bind address (overrides config)
--http-port		<PORT>	—	HTTP server port (overrides config)
--http-token		<TOKEN>	—	Bearer token for protected HTTP endpoints (/admin/*, /debug/*)
--tls-enabled		flag	false	Enable TLS
--tls-cert-file		<FILE>	—	Path to TLS certificate file (PEM)
--tls-key-file		<FILE>	—	Path to TLS private key file (PEM)
--tls-ca-file		<FILE>	—	Path to TLS CA certificate file (PEM) for client verification
--tls-port		<PORT>	—	TLS listen port
--tls-require-client-cert		<MODE>	—	Client certificate mode: none, optional, required
--tls-replication		flag	false	Encrypt replication connections with TLS
--tls-cluster		flag	false	Encrypt cluster bus connections with TLS
--generate-config		flag	false	Generate default configuration file
--intrinsic-latency		<SECONDS>	—	Run intrinsic latency test for N seconds and exit (standalone mode)
--startup-latency-check		flag	false	Run latency check at startup before accepting connections
--help	-h	flag	—	Print help
--version	-V	flag	—	Print version

Examples

# Start with defaults
frogdb-server

# Start with a config file
frogdb-server --config /etc/frogdb/frogdb.toml

# Auto-detect shard count, bind to all interfaces
frogdb-server -b 0.0.0.0 -s auto

# Generate the default configuration
frogdb-server --generate-config > frogdb.toml

# Enable TLS
frogdb-server --tls-enabled --tls-cert-file server.crt --tls-key-file server.key

# Serve the HTTP metrics/admin endpoint with a bearer token
frogdb-server --http-port 9090 --http-token my-secret-token

# Run the intrinsic latency test for 10 seconds and exit
frogdb-server --intrinsic-latency 10

Environment variables

All configuration fields accept a FROGDB_-prefixed environment variable, with __ separating nested keys (e.g. FROGDB_SERVER__PORT). See Operations → Configuration for the full mapping and precedence rules.

See also

Configuration Reference All configuration options

Example config file A complete, generated config file

frogctl Operational CLI tool