Quickstart

FrogDB is wire-compatible with RESP2 and RESP3, so you can use your standard Redis client.

Start the Server

Binary

# Start with defaults (port 6379, persistence enabled)
frogdb-server

# Or with a config file
frogdb-server --config frogdb.toml

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

Docker

docker run -d --name frogdb \
  -p 6379:6379 \
  -v frogdb-data:/data \
  frogdb/frogdb:latest

Docker Compose

services:
  frogdb:
    image: frogdb/frogdb:latest
    ports:
      - "6379:6379"
    volumes:
      - frogdb-data:/data
    environment:
      FROGDB_SERVER__BIND: "0.0.0.0"
      FROGDB_PERSISTENCE__DATA_DIR: /data
    healthcheck:
      test: ["CMD", "redis-cli", "-p", "6379", "PING"]
      interval: 5s
      retries: 10

volumes:
  frogdb-data:

docker compose up -d

Connect

redis-cli -p 6379

127.0.0.1:6379> SET greeting "Hello from FrogDB!"
OK
127.0.0.1:6379> GET greeting
"Hello from FrogDB!"
127.0.0.1:6379> INFO server
# Server info including version

Client Libraries

Any Redis client works with FrogDB. Here are the official clients for popular languages:

redis-cli Redis command-line interface

redis-py Python client

ioredis Node.js client

redis-rs Rust client

go-redis Go client

Jedis Java client

Configuration

Generate a default config file:

frogdb-server --generate-config > frogdb.toml

Common options:

[server]
bind = "0.0.0.0"        # Listen on all interfaces
port = 6379
num-shards = 0           # 0 = auto-detect CPU cores

[persistence]
enabled = true
data-dir = "/var/lib/frogdb"
durability-mode = "periodic"  # async, periodic, sync
sync-interval-ms = 1000

[memory]
maxmemory = 4294967296   # 4 GB
maxmemory-policy = "allkeys-lru"

See Configuration Reference for all options, or the Reference Config File for a complete example with defaults.

Next Steps

Redis Differences What's different from Redis

Event Sourcing FrogDB-specific event sourcing commands

Deployment Production deployment guide

Commands Reference All supported commands