Skip to main content

Redis

These parameters define the Redis configuration.

services.CoAuthoring.redis.host​

Type: string Default: "127.0.0.1"

Defines the Redis server host (host name or IP address).

services.CoAuthoring.redis.iooptions​

Type: object

Defines the parameters (username, password, modules etc.) that can be passed directly to the ioredis RedisOptions library.

services.CoAuthoring.redis.iooptions.lazyConnect​

Type: boolean Default: true

Defines if the connection to the server will be delayed until the first command is sent or redis.connect() is called explicitly.

services.CoAuthoring.redis.iooptionsClusterNodes​

Type: array of strings Default: []

Defines a list of nodes of the cluster you want to connect to that can be passed directly to the ioredis cluster library to connect to the redis cluster. This setting has the priority over the iooptions parameter for connecting to the single redis.

services.CoAuthoring.redis.iooptionsClusterOptions​

Type: object

Defines the parameters (clusterRetryStrategy, dnsLookup, scaleReads etc.) that can be passed directly to the ioredis cluster library to connect to the redis cluster. This setting has the priority over the iooptions parameter for connecting to the single redis.

services.CoAuthoring.redis.iooptionsClusterOptions.lazyConnect​

Type: boolean Default: true

Defines if the connection to the server will be delayed until the first command is sent or redis.connect() is called explicitly.

services.CoAuthoring.redis.name​

Type: string Default: "redis"

Defines the database name, "redis" or "ioredis".

services.CoAuthoring.redis.options​

Type: object

Defines the parameters (username, password, modules etc.) that can be passed directly to the node-redis createClient library.

services.CoAuthoring.redis.optionsCluster​

Type: object

Defines the parameters (rootNodes, defaults, modules etc.) that can be passed directly to the node-redis clustering library to connect to the redis cluster. This setting has the priority over the options parameter for connecting to the single redis.

services.CoAuthoring.redis.port​

Type: integer Default: 6379

Defines the Redis server port.

services.CoAuthoring.redis.prefix​

Type: string Default: "ds:"

Defines the name prefix for all the used structures in Redis.

Example​

{
  "services": {
    "CoAuthoring": {
      "redis": {
        "name": "redis",
        "prefix": "ds:",
        "host": "127.0.0.1",
        "port": 6379,
        "options": {},
        "optionsCluster": {},
        "iooptions": {
          "lazyConnect": true
        },
        "iooptionsClusterNodes": [],
        "iooptionsClusterOptions": {
          "lazyConnect": true
        }
      }
    }
  }
}