Configure

Default Config

There is a default configuration included in the install package and Docker image.

Default settings:

• Listen on 127.0.0.1:1987
• Assigned to core 0
• Sessions disabled
• Persistance disabled

default.jsonc

{
  "version":6,
  "core":0,
  "ip":"127.0.0.1",
  "port":1987,
  "maxPayload":8192,
  "persist":
  {
    "enabled":false,
    "path":"./data"
  },
  "arrays":
  {
    "maxCapacity":10000,
    "maxResponseSize":10000
  },
  "lists":
  {
    "maxResponseSize":10000
  }
}

---

Param	Type	Description	Required
version	unsigned int	Must be 5	Y
core	unsigned int	The core to assign this instance. If not present or above maximum available, defaults to 0	N
maxPayload	unsigned int	The max size, in bytes, of the WebSocket payload	Y
persist	object	Settings for saving/loading keys	Y
arrays	object	Settings for arrays	Y
lists	object	Settings for lists	Y

core

This is the logical core, which may differ from physical cores when hyperthreading is present.

note

• When running multiple instances, remember to change the port
• If running in a Docker container, the core(s) available depends on those available for the container.

persist

Param	Type	Description
enabled	bool	true: - KV_SAVE available - path must exist false: -KV_SAVE not available - path is not checked
path	string	Path to the directory where data is stored. Must be a directory. If enabled is true, this path must exist.

See KV_SAVE for more.

arrays

Param	Type	Description
maxCapacity	unsigned int	Arrays are fixed size so this is the max number of elements in the array, not max number of bytes.
maxResponseSize	unsigned int	Maximum number of items permitted in a response that returns multiple items, such as get_range(). If this is less than maxCapacity it is possible that not all items will be returned

lists

Param	Type	Description
maxResponseSize	unsigned int	Maximum number of items permitted in a response that returns multiple items