Skip to content

frogdb-server

The main FrogDB server process.

Terminal window
frogdb-server [OPTIONS]
OptionShortTypeDefaultDescription
--config <FILE>-cpathPath to TOML configuration file
--bind <ADDR>-bstring127.0.0.1Bind address
--port <PORT>-pinteger6379Listen port
--shards <N>-sstring1Number of shards. auto = number of CPU cores
--log-level <LEVEL>-lenuminfoLog level: trace, debug, info, warn, error
--log-format <FORMAT>enumprettyLog format: pretty, json
--admin-bind <ADDR>stringAdmin bind address (overrides config)
--admin-port <PORT>integerAdmin port (implies admin.enabled = true)
--http-bind <ADDR>stringHTTP server bind address (overrides config)
--http-port <PORT>integerHTTP server port (overrides config)
--http-token <TOKEN>stringBearer token for protected HTTP endpoints (/admin/*, /debug/*)
--tls-enabledflagfalseEnable TLS
--tls-cert-file <FILE>pathTLS certificate file (PEM)
--tls-key-file <FILE>pathTLS private key file (PEM)
--tls-ca-file <FILE>pathTLS CA certificate file (PEM) for client verification
--tls-port <PORT>integerTLS listen port
--tls-require-client-cert <MODE>enumClient certificate mode: none, optional, required
--tls-replicationflagfalseEncrypt replication connections with TLS
--tls-clusterflagfalseEncrypt cluster bus connections with TLS
--generate-configflagPrint default configuration to stdout and exit
--intrinsic-latency <SECS>integerRun latency test for N seconds and exit
--startup-latency-checkflagfalseRun latency check before accepting connections
Terminal window
# Start with defaults
frogdb-server
# Start with config file
frogdb-server --config /etc/frogdb/frogdb.toml
# Auto-detect shards, bind to all interfaces
frogdb-server -b 0.0.0.0 -s auto
# Generate default config
frogdb-server --generate-config > frogdb.toml
# Enable TLS
frogdb-server --tls-enabled --tls-cert-file server.crt --tls-key-file server.key
# Enable debug UI with auth token
frogdb-server --http-port 9090 --http-token my-secret-token
# Run intrinsic latency test
frogdb-server --intrinsic-latency 10

All configuration fields can be overridden via environment variables with the FROGDB_ prefix. Use double underscores (__) to separate nested keys:

Terminal window
FROGDB_SERVER__BIND=0.0.0.0
FROGDB_SERVER__PORT=6380
FROGDB_PERSISTENCE__DURABILITY_MODE=sync
FROGDB_MEMORY__MAXMEMORY=4294967296