GitHub
Getting startedInstall, connect and make your first request.ConfigurationServer, memory, persistence and environment settings.Clients & SDKsConnect with Go, Node.js, Python or the Redis CLI.Data structuresStrings, hashes, lists, sets, streams and more.Architecture256 shards, RESP networking and the storage engine.PersistenceSnapshots, append-only files and recovery.Security & ACLAuthentication, TLS and scoped command access.Clustering & replicationGossip, hash slots, replicas and Sentinel.MonitoringPrometheus, slow logs and health checks.HTTP APIIntegrate using JSON over HTTP.Command referenceSearch command syntax across the upstream modules.BenchmarksStorage and TCP results, hardware and methodology.FeaturesEverything inside the CacheStorm binary.ChangelogReleases and development changes.Brand assetsDownload the CacheStorm SVG logo and mark.
↑ ↓ to navigate · Enter to openCacheStorm docs
DocumentationStart building

Configuration

Server, memory, persistence and environment settings.

Source snapshot: baf028b·View upstream source ↗

A readable configuration

Pass a YAML configuration file when starting the server:

bash
cachestorm --config cachestorm.yaml

The example below follows the upstream config/cachestorm.example.yaml field names. Some older website examples use different names; use the source configuration as the reference for your installed version.

yaml
server:
  bind: "127.0.0.1"
  port: 6380
  max_connections: 10000
  tcp_keepalive: 300
  read_buffer_size: 4096
  write_buffer_size: 4096
  read_timeout: "5m"
  write_timeout: "5m"
  requirepass: ""

http:
  enabled: true
  port: 8080
  password: ""

memory:
  max_memory: "512mb"
  eviction_policy: "allkeys-lru"
  pressure_warning: 70
  pressure_critical: 85
  eviction_sample_size: 5

persistence:
  enabled: false
  aof: true
  aof_sync: "everysec"
  data_dir: "./data"
  snapshot_interval: "5m"

logging:
  level: "info"
  format: "json"
  output: "stdout"

Server connections

SettingPurpose
server.bindAddress the RESP server listens on
server.portRESP listener port; the example uses 6380
server.max_connectionsMaximum simultaneous connections
server.requirepassPassword required before executing protected commands
server.read_timeoutConnection read timeout, expressed as a duration
server.write_timeoutConnection write timeout

Bound memory use

Set memory.max_memory to a size such as 512mb or 1gb. A value of 0 means unlimited in the example configuration.

Choose an eviction policy for your data lifecycle:

  • noeviction: reject writes when memory cannot be allocated within the limit.
  • allkeys-lru: evict least recently used keys.
  • allkeys-lfu: evict least frequently used keys.
  • volatile-lru: evict least recently used keys that have an expiry.
  • allkeys-random: choose keys at random.

Leave headroom for process overhead, client buffers and persistence work. Measure the actual memory profile of your workload.

Organize with namespaces

yaml
namespaces:
  default:
    default_ttl: "0"
  cache:
    default_ttl: "1h"
  sessions:
    default_ttl: "30m"

Namespaces group data and can define default expiry behavior. See namespace commands in the command reference.

Plugins and metrics

yaml
plugins:
  stats:
    enabled: true
  metrics:
    enabled: true
    port: 9090
    path: "/metrics"
  slowlog:
    enabled: true
    threshold: "10ms"
    max_entries: 128

Use monitoring to check the endpoints enabled in your own configuration. The metrics plugin and the HTTP API have separate listeners.

Complete upstream examples