@jambonz/speech-utils 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2054 @@
1
+ # Redis configuration file example.
2
+ #
3
+ # Note that in order to read the configuration file, Redis must be
4
+ # started with the file path as first argument:
5
+ #
6
+ # ./redis-server /path/to/redis.conf
7
+
8
+ # Note on units: when memory size is needed, it is possible to specify
9
+ # it in the usual form of 1k 5GB 4M and so forth:
10
+ #
11
+ # 1k => 1000 bytes
12
+ # 1kb => 1024 bytes
13
+ # 1m => 1000000 bytes
14
+ # 1mb => 1024*1024 bytes
15
+ # 1g => 1000000000 bytes
16
+ # 1gb => 1024*1024*1024 bytes
17
+ #
18
+ # units are case insensitive so 1GB 1Gb 1gB are all the same.
19
+
20
+ ################################## INCLUDES ###################################
21
+
22
+ # Include one or more other config files here. This is useful if you
23
+ # have a standard template that goes to all Redis servers but also need
24
+ # to customize a few per-server settings. Include files can include
25
+ # other files, so use this wisely.
26
+ #
27
+ # Note that option "include" won't be rewritten by command "CONFIG REWRITE"
28
+ # from admin or Redis Sentinel. Since Redis always uses the last processed
29
+ # line as value of a configuration directive, you'd better put includes
30
+ # at the beginning of this file to avoid overwriting config change at runtime.
31
+ #
32
+ # If instead you are interested in using includes to override configuration
33
+ # options, it is better to use include as the last line.
34
+ #
35
+ # include /path/to/local.conf
36
+ # include /path/to/other.conf
37
+
38
+ ################################## MODULES #####################################
39
+
40
+ # Load modules at startup. If the server is not able to load modules
41
+ # it will abort. It is possible to use multiple loadmodule directives.
42
+ #
43
+ # loadmodule /path/to/my_module.so
44
+ # loadmodule /path/to/other_module.so
45
+
46
+ ################################## NETWORK #####################################
47
+
48
+ # By default, if no "bind" configuration directive is specified, Redis listens
49
+ # for connections from all available network interfaces on the host machine.
50
+ # It is possible to listen to just one or multiple selected interfaces using
51
+ # the "bind" configuration directive, followed by one or more IP addresses.
52
+ # Each address can be prefixed by "-", which means that redis will not fail to
53
+ # start if the address is not available. Being not available only refers to
54
+ # addresses that does not correspond to any network interfece. Addresses that
55
+ # are already in use will always fail, and unsupported protocols will always BE
56
+ # silently skipped.
57
+ #
58
+ # Examples:
59
+ #
60
+ # bind 192.168.1.100 10.0.0.1 # listens on two specific IPv4 addresses
61
+ # bind 127.0.0.1 ::1 # listens on loopback IPv4 and IPv6
62
+ # bind * -::* # like the default, all available interfaces
63
+ #
64
+ # ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the
65
+ # internet, binding to all the interfaces is dangerous and will expose the
66
+ # instance to everybody on the internet. So by default we uncomment the
67
+ # following bind directive, that will force Redis to listen only on the
68
+ # IPv4 and IPv6 (if available) loopback interface addresses (this means Redis
69
+ # will only be able to accept client connections from the same host that it is
70
+ # running on).
71
+ #
72
+ # IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES
73
+ # JUST COMMENT OUT THE FOLLOWING LINE.
74
+ # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75
+ bind * -::*
76
+
77
+ # Protected mode is a layer of security protection, in order to avoid that
78
+ # Redis instances left open on the internet are accessed and exploited.
79
+ #
80
+ # When protected mode is on and if:
81
+ #
82
+ # 1) The server is not binding explicitly to a set of addresses using the
83
+ # "bind" directive.
84
+ # 2) No password is configured.
85
+ #
86
+ # The server only accepts connections from clients connecting from the
87
+ # IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain
88
+ # sockets.
89
+ #
90
+ # By default protected mode is enabled. You should disable it only if
91
+ # you are sure you want clients from other hosts to connect to Redis
92
+ # even if no authentication is configured, nor a specific set of interfaces
93
+ # are explicitly listed using the "bind" directive.
94
+ protected-mode yes
95
+
96
+ # Accept connections on the specified port, default is 6379 (IANA #815344).
97
+ # If port 0 is specified Redis will not listen on a TCP socket.
98
+ port 6379
99
+
100
+ # TCP listen() backlog.
101
+ #
102
+ # In high requests-per-second environments you need a high backlog in order
103
+ # to avoid slow clients connection issues. Note that the Linux kernel
104
+ # will silently truncate it to the value of /proc/sys/net/core/somaxconn so
105
+ # make sure to raise both the value of somaxconn and tcp_max_syn_backlog
106
+ # in order to get the desired effect.
107
+ tcp-backlog 511
108
+
109
+ # Unix socket.
110
+ #
111
+ # Specify the path for the Unix socket that will be used to listen for
112
+ # incoming connections. There is no default, so Redis will not listen
113
+ # on a unix socket when not specified.
114
+ #
115
+ # unixsocket /run/redis.sock
116
+ # unixsocketperm 700
117
+
118
+ # Close the connection after a client is idle for N seconds (0 to disable)
119
+ timeout 0
120
+
121
+ # TCP keepalive.
122
+ #
123
+ # If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
124
+ # of communication. This is useful for two reasons:
125
+ #
126
+ # 1) Detect dead peers.
127
+ # 2) Force network equipment in the middle to consider the connection to be
128
+ # alive.
129
+ #
130
+ # On Linux, the specified value (in seconds) is the period used to send ACKs.
131
+ # Note that to close the connection the double of the time is needed.
132
+ # On other kernels the period depends on the kernel configuration.
133
+ #
134
+ # A reasonable value for this option is 300 seconds, which is the new
135
+ # Redis default starting with Redis 3.2.1.
136
+ tcp-keepalive 300
137
+
138
+ ################################# TLS/SSL #####################################
139
+
140
+ # By default, TLS/SSL is disabled. To enable it, the "tls-port" configuration
141
+ # directive can be used to define TLS-listening ports. To enable TLS on the
142
+ # default port, use:
143
+ #
144
+ # port 0
145
+ # tls-port 6379
146
+
147
+ # Configure a X.509 certificate and private key to use for authenticating the
148
+ # server to connected clients, masters or cluster peers. These files should be
149
+ # PEM formatted.
150
+ #
151
+ # tls-cert-file redis.crt
152
+ # tls-key-file redis.key
153
+ #
154
+ # If the key file is encrypted using a passphrase, it can be included here
155
+ # as well.
156
+ #
157
+ # tls-key-file-pass secret
158
+
159
+ # Normally Redis uses the same certificate for both server functions (accepting
160
+ # connections) and client functions (replicating from a master, establishing
161
+ # cluster bus connections, etc.).
162
+ #
163
+ # Sometimes certificates are issued with attributes that designate them as
164
+ # client-only or server-only certificates. In that case it may be desired to use
165
+ # different certificates for incoming (server) and outgoing (client)
166
+ # connections. To do that, use the following directives:
167
+ #
168
+ # tls-client-cert-file client.crt
169
+ # tls-client-key-file client.key
170
+ #
171
+ # If the key file is encrypted using a passphrase, it can be included here
172
+ # as well.
173
+ #
174
+ # tls-client-key-file-pass secret
175
+
176
+ # Configure a DH parameters file to enable Diffie-Hellman (DH) key exchange:
177
+ #
178
+ # tls-dh-params-file redis.dh
179
+
180
+ # Configure a CA certificate(s) bundle or directory to authenticate TLS/SSL
181
+ # clients and peers. Redis requires an explicit configuration of at least one
182
+ # of these, and will not implicitly use the system wide configuration.
183
+ #
184
+ # tls-ca-cert-file ca.crt
185
+ # tls-ca-cert-dir /etc/ssl/certs
186
+
187
+ # By default, clients (including replica servers) on a TLS port are required
188
+ # to authenticate using valid client side certificates.
189
+ #
190
+ # If "no" is specified, client certificates are not required and not accepted.
191
+ # If "optional" is specified, client certificates are accepted and must be
192
+ # valid if provided, but are not required.
193
+ #
194
+ # tls-auth-clients no
195
+ # tls-auth-clients optional
196
+
197
+ # By default, a Redis replica does not attempt to establish a TLS connection
198
+ # with its master.
199
+ #
200
+ # Use the following directive to enable TLS on replication links.
201
+ #
202
+ # tls-replication yes
203
+
204
+ # By default, the Redis Cluster bus uses a plain TCP connection. To enable
205
+ # TLS for the bus protocol, use the following directive:
206
+ #
207
+ # tls-cluster yes
208
+
209
+ # By default, only TLSv1.2 and TLSv1.3 are enabled and it is highly recommended
210
+ # that older formally deprecated versions are kept disabled to reduce the attack surface.
211
+ # You can explicitly specify TLS versions to support.
212
+ # Allowed values are case insensitive and include "TLSv1", "TLSv1.1", "TLSv1.2",
213
+ # "TLSv1.3" (OpenSSL >= 1.1.1) or any combination.
214
+ # To enable only TLSv1.2 and TLSv1.3, use:
215
+ #
216
+ # tls-protocols "TLSv1.2 TLSv1.3"
217
+
218
+ # Configure allowed ciphers. See the ciphers(1ssl) manpage for more information
219
+ # about the syntax of this string.
220
+ #
221
+ # Note: this configuration applies only to <= TLSv1.2.
222
+ #
223
+ # tls-ciphers DEFAULT:!MEDIUM
224
+
225
+ # Configure allowed TLSv1.3 ciphersuites. See the ciphers(1ssl) manpage for more
226
+ # information about the syntax of this string, and specifically for TLSv1.3
227
+ # ciphersuites.
228
+ #
229
+ # tls-ciphersuites TLS_CHACHA20_POLY1305_SHA256
230
+
231
+ # When choosing a cipher, use the server's preference instead of the client
232
+ # preference. By default, the server follows the client's preference.
233
+ #
234
+ # tls-prefer-server-ciphers yes
235
+
236
+ # By default, TLS session caching is enabled to allow faster and less expensive
237
+ # reconnections by clients that support it. Use the following directive to disable
238
+ # caching.
239
+ #
240
+ # tls-session-caching no
241
+
242
+ # Change the default number of TLS sessions cached. A zero value sets the cache
243
+ # to unlimited size. The default size is 20480.
244
+ #
245
+ # tls-session-cache-size 5000
246
+
247
+ # Change the default timeout of cached TLS sessions. The default timeout is 300
248
+ # seconds.
249
+ #
250
+ # tls-session-cache-timeout 60
251
+
252
+ ################################# GENERAL #####################################
253
+
254
+ # By default Redis does not run as a daemon. Use 'yes' if you need it.
255
+ # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
256
+ # When Redis is supervised by upstart or systemd, this parameter has no impact.
257
+ daemonize no
258
+
259
+ # If you run Redis from upstart or systemd, Redis can interact with your
260
+ # supervision tree. Options:
261
+ # supervised no - no supervision interaction
262
+ # supervised upstart - signal upstart by putting Redis into SIGSTOP mode
263
+ # requires "expect stop" in your upstart job config
264
+ # supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET
265
+ # on startup, and updating Redis status on a regular
266
+ # basis.
267
+ # supervised auto - detect upstart or systemd method based on
268
+ # UPSTART_JOB or NOTIFY_SOCKET environment variables
269
+ # Note: these supervision methods only signal "process is ready."
270
+ # They do not enable continuous pings back to your supervisor.
271
+ #
272
+ # The default is "no". To run under upstart/systemd, you can simply uncomment
273
+ # the line below:
274
+ #
275
+ # supervised auto
276
+
277
+ # If a pid file is specified, Redis writes it where specified at startup
278
+ # and removes it at exit.
279
+ #
280
+ # When the server runs non daemonized, no pid file is created if none is
281
+ # specified in the configuration. When the server is daemonized, the pid file
282
+ # is used even if not specified, defaulting to "/var/run/redis.pid".
283
+ #
284
+ # Creating a pid file is best effort: if Redis is not able to create it
285
+ # nothing bad happens, the server will start and run normally.
286
+ #
287
+ # Note that on modern Linux systems "/run/redis.pid" is more conforming
288
+ # and should be used instead.
289
+ pidfile /var/run/redis_6379.pid
290
+
291
+ # Specify the server verbosity level.
292
+ # This can be one of:
293
+ # debug (a lot of information, useful for development/testing)
294
+ # verbose (many rarely useful info, but not a mess like the debug level)
295
+ # notice (moderately verbose, what you want in production probably)
296
+ # warning (only very important / critical messages are logged)
297
+ loglevel debug
298
+
299
+ # Specify the log file name. Also the empty string can be used to force
300
+ # Redis to log on the standard output. Note that if you use standard
301
+ # output for logging but daemonize, logs will be sent to /dev/null
302
+ logfile ""
303
+
304
+ # To enable logging to the system logger, just set 'syslog-enabled' to yes,
305
+ # and optionally update the other syslog parameters to suit your needs.
306
+ # syslog-enabled no
307
+
308
+ # Specify the syslog identity.
309
+ # syslog-ident redis
310
+
311
+ # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
312
+ # syslog-facility local0
313
+
314
+ # To disable the built in crash log, which will possibly produce cleaner core
315
+ # dumps when they are needed, uncomment the following:
316
+ #
317
+ # crash-log-enabled no
318
+
319
+ # To disable the fast memory check that's run as part of the crash log, which
320
+ # will possibly let redis terminate sooner, uncomment the following:
321
+ #
322
+ # crash-memcheck-enabled no
323
+
324
+ # Set the number of databases. The default database is DB 0, you can select
325
+ # a different one on a per-connection basis using SELECT <dbid> where
326
+ # dbid is a number between 0 and 'databases'-1
327
+ databases 16
328
+
329
+ # By default Redis shows an ASCII art logo only when started to log to the
330
+ # standard output and if the standard output is a TTY and syslog logging is
331
+ # disabled. Basically this means that normally a logo is displayed only in
332
+ # interactive sessions.
333
+ #
334
+ # However it is possible to force the pre-4.0 behavior and always show a
335
+ # ASCII art logo in startup logs by setting the following option to yes.
336
+ always-show-logo no
337
+
338
+ # By default, Redis modifies the process title (as seen in 'top' and 'ps') to
339
+ # provide some runtime information. It is possible to disable this and leave
340
+ # the process name as executed by setting the following to no.
341
+ set-proc-title yes
342
+
343
+ # When changing the process title, Redis uses the following template to construct
344
+ # the modified title.
345
+ #
346
+ # Template variables are specified in curly brackets. The following variables are
347
+ # supported:
348
+ #
349
+ # {title} Name of process as executed if parent, or type of child process.
350
+ # {listen-addr} Bind address or '*' followed by TCP or TLS port listening on, or
351
+ # Unix socket if only that's available.
352
+ # {server-mode} Special mode, i.e. "[sentinel]" or "[cluster]".
353
+ # {port} TCP port listening on, or 0.
354
+ # {tls-port} TLS port listening on, or 0.
355
+ # {unixsocket} Unix domain socket listening on, or "".
356
+ # {config-file} Name of configuration file used.
357
+ #
358
+ proc-title-template "{title} {listen-addr} {server-mode}"
359
+
360
+ ################################ SNAPSHOTTING ################################
361
+
362
+ # Save the DB to disk.
363
+ #
364
+ # save <seconds> <changes>
365
+ #
366
+ # Redis will save the DB if both the given number of seconds and the given
367
+ # number of write operations against the DB occurred.
368
+ #
369
+ # Snapshotting can be completely disabled with a single empty string argument
370
+ # as in following example:
371
+ #
372
+ # save ""
373
+ #
374
+ # Unless specified otherwise, by default Redis will save the DB:
375
+ # * After 3600 seconds (an hour) if at least 1 key changed
376
+ # * After 300 seconds (5 minutes) if at least 100 keys changed
377
+ # * After 60 seconds if at least 10000 keys changed
378
+ #
379
+ # You can set these explicitly by uncommenting the three following lines.
380
+ #
381
+ # save 3600 1
382
+ # save 300 100
383
+ # save 60 10000
384
+
385
+ # By default Redis will stop accepting writes if RDB snapshots are enabled
386
+ # (at least one save point) and the latest background save failed.
387
+ # This will make the user aware (in a hard way) that data is not persisting
388
+ # on disk properly, otherwise chances are that no one will notice and some
389
+ # disaster will happen.
390
+ #
391
+ # If the background saving process will start working again Redis will
392
+ # automatically allow writes again.
393
+ #
394
+ # However if you have setup your proper monitoring of the Redis server
395
+ # and persistence, you may want to disable this feature so that Redis will
396
+ # continue to work as usual even if there are problems with disk,
397
+ # permissions, and so forth.
398
+ stop-writes-on-bgsave-error yes
399
+
400
+ # Compress string objects using LZF when dump .rdb databases?
401
+ # By default compression is enabled as it's almost always a win.
402
+ # If you want to save some CPU in the saving child set it to 'no' but
403
+ # the dataset will likely be bigger if you have compressible values or keys.
404
+ rdbcompression yes
405
+
406
+ # Since version 5 of RDB a CRC64 checksum is placed at the end of the file.
407
+ # This makes the format more resistant to corruption but there is a performance
408
+ # hit to pay (around 10%) when saving and loading RDB files, so you can disable it
409
+ # for maximum performances.
410
+ #
411
+ # RDB files created with checksum disabled have a checksum of zero that will
412
+ # tell the loading code to skip the check.
413
+ rdbchecksum yes
414
+
415
+ # Enables or disables full sanitation checks for ziplist and listpack etc when
416
+ # loading an RDB or RESTORE payload. This reduces the chances of a assertion or
417
+ # crash later on while processing commands.
418
+ # Options:
419
+ # no - Never perform full sanitation
420
+ # yes - Always perform full sanitation
421
+ # clients - Perform full sanitation only for user connections.
422
+ # Excludes: RDB files, RESTORE commands received from the master
423
+ # connection, and client connections which have the
424
+ # skip-sanitize-payload ACL flag.
425
+ # The default should be 'clients' but since it currently affects cluster
426
+ # resharding via MIGRATE, it is temporarily set to 'no' by default.
427
+ #
428
+ # sanitize-dump-payload no
429
+
430
+ # The filename where to dump the DB
431
+ dbfilename dump.rdb
432
+
433
+ # Remove RDB files used by replication in instances without persistence
434
+ # enabled. By default this option is disabled, however there are environments
435
+ # where for regulations or other security concerns, RDB files persisted on
436
+ # disk by masters in order to feed replicas, or stored on disk by replicas
437
+ # in order to load them for the initial synchronization, should be deleted
438
+ # ASAP. Note that this option ONLY WORKS in instances that have both AOF
439
+ # and RDB persistence disabled, otherwise is completely ignored.
440
+ #
441
+ # An alternative (and sometimes better) way to obtain the same effect is
442
+ # to use diskless replication on both master and replicas instances. However
443
+ # in the case of replicas, diskless is not always an option.
444
+ rdb-del-sync-files no
445
+
446
+ # The working directory.
447
+ #
448
+ # The DB will be written inside this directory, with the filename specified
449
+ # above using the 'dbfilename' configuration directive.
450
+ #
451
+ # The Append Only File will also be created inside this directory.
452
+ #
453
+ # Note that you must specify a directory here, not a file name.
454
+ dir ./
455
+
456
+ ################################# REPLICATION #################################
457
+
458
+ # Master-Replica replication. Use replicaof to make a Redis instance a copy of
459
+ # another Redis server. A few things to understand ASAP about Redis replication.
460
+ #
461
+ # +------------------+ +---------------+
462
+ # | Master | ---> | Replica |
463
+ # | (receive writes) | | (exact copy) |
464
+ # +------------------+ +---------------+
465
+ #
466
+ # 1) Redis replication is asynchronous, but you can configure a master to
467
+ # stop accepting writes if it appears to be not connected with at least
468
+ # a given number of replicas.
469
+ # 2) Redis replicas are able to perform a partial resynchronization with the
470
+ # master if the replication link is lost for a relatively small amount of
471
+ # time. You may want to configure the replication backlog size (see the next
472
+ # sections of this file) with a sensible value depending on your needs.
473
+ # 3) Replication is automatic and does not need user intervention. After a
474
+ # network partition replicas automatically try to reconnect to masters
475
+ # and resynchronize with them.
476
+ #
477
+ # replicaof <masterip> <masterport>
478
+
479
+ # If the master is password protected (using the "requirepass" configuration
480
+ # directive below) it is possible to tell the replica to authenticate before
481
+ # starting the replication synchronization process, otherwise the master will
482
+ # refuse the replica request.
483
+ #
484
+ # masterauth <master-password>
485
+ #
486
+ # However this is not enough if you are using Redis ACLs (for Redis version
487
+ # 6 or greater), and the default user is not capable of running the PSYNC
488
+ # command and/or other commands needed for replication. In this case it's
489
+ # better to configure a special user to use with replication, and specify the
490
+ # masteruser configuration as such:
491
+ #
492
+ # masteruser <username>
493
+ #
494
+ # When masteruser is specified, the replica will authenticate against its
495
+ # master using the new AUTH form: AUTH <username> <password>.
496
+
497
+ # When a replica loses its connection with the master, or when the replication
498
+ # is still in progress, the replica can act in two different ways:
499
+ #
500
+ # 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will
501
+ # still reply to client requests, possibly with out of date data, or the
502
+ # data set may just be empty if this is the first synchronization.
503
+ #
504
+ # 2) If replica-serve-stale-data is set to 'no' the replica will reply with
505
+ # an error "SYNC with master in progress" to all commands except:
506
+ # INFO, REPLICAOF, AUTH, PING, SHUTDOWN, REPLCONF, ROLE, CONFIG, SUBSCRIBE,
507
+ # UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB, COMMAND, POST,
508
+ # HOST and LATENCY.
509
+ #
510
+ replica-serve-stale-data yes
511
+
512
+ # You can configure a replica instance to accept writes or not. Writing against
513
+ # a replica instance may be useful to store some ephemeral data (because data
514
+ # written on a replica will be easily deleted after resync with the master) but
515
+ # may also cause problems if clients are writing to it because of a
516
+ # misconfiguration.
517
+ #
518
+ # Since Redis 2.6 by default replicas are read-only.
519
+ #
520
+ # Note: read only replicas are not designed to be exposed to untrusted clients
521
+ # on the internet. It's just a protection layer against misuse of the instance.
522
+ # Still a read only replica exports by default all the administrative commands
523
+ # such as CONFIG, DEBUG, and so forth. To a limited extent you can improve
524
+ # security of read only replicas using 'rename-command' to shadow all the
525
+ # administrative / dangerous commands.
526
+ replica-read-only yes
527
+
528
+ # Replication SYNC strategy: disk or socket.
529
+ #
530
+ # New replicas and reconnecting replicas that are not able to continue the
531
+ # replication process just receiving differences, need to do what is called a
532
+ # "full synchronization". An RDB file is transmitted from the master to the
533
+ # replicas.
534
+ #
535
+ # The transmission can happen in two different ways:
536
+ #
537
+ # 1) Disk-backed: The Redis master creates a new process that writes the RDB
538
+ # file on disk. Later the file is transferred by the parent
539
+ # process to the replicas incrementally.
540
+ # 2) Diskless: The Redis master creates a new process that directly writes the
541
+ # RDB file to replica sockets, without touching the disk at all.
542
+ #
543
+ # With disk-backed replication, while the RDB file is generated, more replicas
544
+ # can be queued and served with the RDB file as soon as the current child
545
+ # producing the RDB file finishes its work. With diskless replication instead
546
+ # once the transfer starts, new replicas arriving will be queued and a new
547
+ # transfer will start when the current one terminates.
548
+ #
549
+ # When diskless replication is used, the master waits a configurable amount of
550
+ # time (in seconds) before starting the transfer in the hope that multiple
551
+ # replicas will arrive and the transfer can be parallelized.
552
+ #
553
+ # With slow disks and fast (large bandwidth) networks, diskless replication
554
+ # works better.
555
+ repl-diskless-sync no
556
+
557
+ # When diskless replication is enabled, it is possible to configure the delay
558
+ # the server waits in order to spawn the child that transfers the RDB via socket
559
+ # to the replicas.
560
+ #
561
+ # This is important since once the transfer starts, it is not possible to serve
562
+ # new replicas arriving, that will be queued for the next RDB transfer, so the
563
+ # server waits a delay in order to let more replicas arrive.
564
+ #
565
+ # The delay is specified in seconds, and by default is 5 seconds. To disable
566
+ # it entirely just set it to 0 seconds and the transfer will start ASAP.
567
+ repl-diskless-sync-delay 5
568
+
569
+ # -----------------------------------------------------------------------------
570
+ # WARNING: RDB diskless load is experimental. Since in this setup the replica
571
+ # does not immediately store an RDB on disk, it may cause data loss during
572
+ # failovers. RDB diskless load + Redis modules not handling I/O reads may also
573
+ # cause Redis to abort in case of I/O errors during the initial synchronization
574
+ # stage with the master. Use only if you know what you are doing.
575
+ # -----------------------------------------------------------------------------
576
+ #
577
+ # Replica can load the RDB it reads from the replication link directly from the
578
+ # socket, or store the RDB to a file and read that file after it was completely
579
+ # received from the master.
580
+ #
581
+ # In many cases the disk is slower than the network, and storing and loading
582
+ # the RDB file may increase replication time (and even increase the master's
583
+ # Copy on Write memory and salve buffers).
584
+ # However, parsing the RDB file directly from the socket may mean that we have
585
+ # to flush the contents of the current database before the full rdb was
586
+ # received. For this reason we have the following options:
587
+ #
588
+ # "disabled" - Don't use diskless load (store the rdb file to the disk first)
589
+ # "on-empty-db" - Use diskless load only when it is completely safe.
590
+ # "swapdb" - Keep a copy of the current db contents in RAM while parsing
591
+ # the data directly from the socket. note that this requires
592
+ # sufficient memory, if you don't have it, you risk an OOM kill.
593
+ repl-diskless-load disabled
594
+
595
+ # Replicas send PINGs to server in a predefined interval. It's possible to
596
+ # change this interval with the repl_ping_replica_period option. The default
597
+ # value is 10 seconds.
598
+ #
599
+ # repl-ping-replica-period 10
600
+
601
+ # The following option sets the replication timeout for:
602
+ #
603
+ # 1) Bulk transfer I/O during SYNC, from the point of view of replica.
604
+ # 2) Master timeout from the point of view of replicas (data, pings).
605
+ # 3) Replica timeout from the point of view of masters (REPLCONF ACK pings).
606
+ #
607
+ # It is important to make sure that this value is greater than the value
608
+ # specified for repl-ping-replica-period otherwise a timeout will be detected
609
+ # every time there is low traffic between the master and the replica. The default
610
+ # value is 60 seconds.
611
+ #
612
+ # repl-timeout 60
613
+
614
+ # Disable TCP_NODELAY on the replica socket after SYNC?
615
+ #
616
+ # If you select "yes" Redis will use a smaller number of TCP packets and
617
+ # less bandwidth to send data to replicas. But this can add a delay for
618
+ # the data to appear on the replica side, up to 40 milliseconds with
619
+ # Linux kernels using a default configuration.
620
+ #
621
+ # If you select "no" the delay for data to appear on the replica side will
622
+ # be reduced but more bandwidth will be used for replication.
623
+ #
624
+ # By default we optimize for low latency, but in very high traffic conditions
625
+ # or when the master and replicas are many hops away, turning this to "yes" may
626
+ # be a good idea.
627
+ repl-disable-tcp-nodelay no
628
+
629
+ # Set the replication backlog size. The backlog is a buffer that accumulates
630
+ # replica data when replicas are disconnected for some time, so that when a
631
+ # replica wants to reconnect again, often a full resync is not needed, but a
632
+ # partial resync is enough, just passing the portion of data the replica
633
+ # missed while disconnected.
634
+ #
635
+ # The bigger the replication backlog, the longer the replica can endure the
636
+ # disconnect and later be able to perform a partial resynchronization.
637
+ #
638
+ # The backlog is only allocated if there is at least one replica connected.
639
+ #
640
+ # repl-backlog-size 1mb
641
+
642
+ # After a master has no connected replicas for some time, the backlog will be
643
+ # freed. The following option configures the amount of seconds that need to
644
+ # elapse, starting from the time the last replica disconnected, for the backlog
645
+ # buffer to be freed.
646
+ #
647
+ # Note that replicas never free the backlog for timeout, since they may be
648
+ # promoted to masters later, and should be able to correctly "partially
649
+ # resynchronize" with other replicas: hence they should always accumulate backlog.
650
+ #
651
+ # A value of 0 means to never release the backlog.
652
+ #
653
+ # repl-backlog-ttl 3600
654
+
655
+ # The replica priority is an integer number published by Redis in the INFO
656
+ # output. It is used by Redis Sentinel in order to select a replica to promote
657
+ # into a master if the master is no longer working correctly.
658
+ #
659
+ # A replica with a low priority number is considered better for promotion, so
660
+ # for instance if there are three replicas with priority 10, 100, 25 Sentinel
661
+ # will pick the one with priority 10, that is the lowest.
662
+ #
663
+ # However a special priority of 0 marks the replica as not able to perform the
664
+ # role of master, so a replica with priority of 0 will never be selected by
665
+ # Redis Sentinel for promotion.
666
+ #
667
+ # By default the priority is 100.
668
+ replica-priority 100
669
+
670
+ # -----------------------------------------------------------------------------
671
+ # By default, Redis Sentinel includes all replicas in its reports. A replica
672
+ # can be excluded from Redis Sentinel's announcements. An unannounced replica
673
+ # will be ignored by the 'sentinel replicas <master>' command and won't be
674
+ # exposed to Redis Sentinel's clients.
675
+ #
676
+ # This option does not change the behavior of replica-priority. Even with
677
+ # replica-announced set to 'no', the replica can be promoted to master. To
678
+ # prevent this behavior, set replica-priority to 0.
679
+ #
680
+ # replica-announced yes
681
+
682
+ # It is possible for a master to stop accepting writes if there are less than
683
+ # N replicas connected, having a lag less or equal than M seconds.
684
+ #
685
+ # The N replicas need to be in "online" state.
686
+ #
687
+ # The lag in seconds, that must be <= the specified value, is calculated from
688
+ # the last ping received from the replica, that is usually sent every second.
689
+ #
690
+ # This option does not GUARANTEE that N replicas will accept the write, but
691
+ # will limit the window of exposure for lost writes in case not enough replicas
692
+ # are available, to the specified number of seconds.
693
+ #
694
+ # For example to require at least 3 replicas with a lag <= 10 seconds use:
695
+ #
696
+ # min-replicas-to-write 3
697
+ # min-replicas-max-lag 10
698
+ #
699
+ # Setting one or the other to 0 disables the feature.
700
+ #
701
+ # By default min-replicas-to-write is set to 0 (feature disabled) and
702
+ # min-replicas-max-lag is set to 10.
703
+
704
+ # A Redis master is able to list the address and port of the attached
705
+ # replicas in different ways. For example the "INFO replication" section
706
+ # offers this information, which is used, among other tools, by
707
+ # Redis Sentinel in order to discover replica instances.
708
+ # Another place where this info is available is in the output of the
709
+ # "ROLE" command of a master.
710
+ #
711
+ # The listed IP address and port normally reported by a replica is
712
+ # obtained in the following way:
713
+ #
714
+ # IP: The address is auto detected by checking the peer address
715
+ # of the socket used by the replica to connect with the master.
716
+ #
717
+ # Port: The port is communicated by the replica during the replication
718
+ # handshake, and is normally the port that the replica is using to
719
+ # listen for connections.
720
+ #
721
+ # However when port forwarding or Network Address Translation (NAT) is
722
+ # used, the replica may actually be reachable via different IP and port
723
+ # pairs. The following two options can be used by a replica in order to
724
+ # report to its master a specific set of IP and port, so that both INFO
725
+ # and ROLE will report those values.
726
+ #
727
+ # There is no need to use both the options if you need to override just
728
+ # the port or the IP address.
729
+ #
730
+ # replica-announce-ip 5.5.5.5
731
+ # replica-announce-port 1234
732
+
733
+ ############################### KEYS TRACKING #################################
734
+
735
+ # Redis implements server assisted support for client side caching of values.
736
+ # This is implemented using an invalidation table that remembers, using
737
+ # a radix key indexed by key name, what clients have which keys. In turn
738
+ # this is used in order to send invalidation messages to clients. Please
739
+ # check this page to understand more about the feature:
740
+ #
741
+ # https://redis.io/topics/client-side-caching
742
+ #
743
+ # When tracking is enabled for a client, all the read only queries are assumed
744
+ # to be cached: this will force Redis to store information in the invalidation
745
+ # table. When keys are modified, such information is flushed away, and
746
+ # invalidation messages are sent to the clients. However if the workload is
747
+ # heavily dominated by reads, Redis could use more and more memory in order
748
+ # to track the keys fetched by many clients.
749
+ #
750
+ # For this reason it is possible to configure a maximum fill value for the
751
+ # invalidation table. By default it is set to 1M of keys, and once this limit
752
+ # is reached, Redis will start to evict keys in the invalidation table
753
+ # even if they were not modified, just to reclaim memory: this will in turn
754
+ # force the clients to invalidate the cached values. Basically the table
755
+ # maximum size is a trade off between the memory you want to spend server
756
+ # side to track information about who cached what, and the ability of clients
757
+ # to retain cached objects in memory.
758
+ #
759
+ # If you set the value to 0, it means there are no limits, and Redis will
760
+ # retain as many keys as needed in the invalidation table.
761
+ # In the "stats" INFO section, you can find information about the number of
762
+ # keys in the invalidation table at every given moment.
763
+ #
764
+ # Note: when key tracking is used in broadcasting mode, no memory is used
765
+ # in the server side so this setting is useless.
766
+ #
767
+ # tracking-table-max-keys 1000000
768
+
769
+ ################################## SECURITY ###################################
770
+
771
+ # Warning: since Redis is pretty fast, an outside user can try up to
772
+ # 1 million passwords per second against a modern box. This means that you
773
+ # should use very strong passwords, otherwise they will be very easy to break.
774
+ # Note that because the password is really a shared secret between the client
775
+ # and the server, and should not be memorized by any human, the password
776
+ # can be easily a long string from /dev/urandom or whatever, so by using a
777
+ # long and unguessable password no brute force attack will be possible.
778
+
779
+ # Redis ACL users are defined in the following format:
780
+ #
781
+ # user <username> ... acl rules ...
782
+ #
783
+ # For example:
784
+ #
785
+ # user worker +@list +@connection ~jobs:* on >ffa9203c493aa99
786
+ #
787
+ # The special username "default" is used for new connections. If this user
788
+ # has the "nopass" rule, then new connections will be immediately authenticated
789
+ # as the "default" user without the need of any password provided via the
790
+ # AUTH command. Otherwise if the "default" user is not flagged with "nopass"
791
+ # the connections will start in not authenticated state, and will require
792
+ # AUTH (or the HELLO command AUTH option) in order to be authenticated and
793
+ # start to work.
794
+ #
795
+ # The ACL rules that describe what a user can do are the following:
796
+ #
797
+ # on Enable the user: it is possible to authenticate as this user.
798
+ # off Disable the user: it's no longer possible to authenticate
799
+ # with this user, however the already authenticated connections
800
+ # will still work.
801
+ # skip-sanitize-payload RESTORE dump-payload sanitation is skipped.
802
+ # sanitize-payload RESTORE dump-payload is sanitized (default).
803
+ # +<command> Allow the execution of that command
804
+ # -<command> Disallow the execution of that command
805
+ # +@<category> Allow the execution of all the commands in such category
806
+ # with valid categories are like @admin, @set, @sortedset, ...
807
+ # and so forth, see the full list in the server.c file where
808
+ # the Redis command table is described and defined.
809
+ # The special category @all means all the commands, but currently
810
+ # present in the server, and that will be loaded in the future
811
+ # via modules.
812
+ # +<command>|subcommand Allow a specific subcommand of an otherwise
813
+ # disabled command. Note that this form is not
814
+ # allowed as negative like -DEBUG|SEGFAULT, but
815
+ # only additive starting with "+".
816
+ # allcommands Alias for +@all. Note that it implies the ability to execute
817
+ # all the future commands loaded via the modules system.
818
+ # nocommands Alias for -@all.
819
+ # ~<pattern> Add a pattern of keys that can be mentioned as part of
820
+ # commands. For instance ~* allows all the keys. The pattern
821
+ # is a glob-style pattern like the one of KEYS.
822
+ # It is possible to specify multiple patterns.
823
+ # allkeys Alias for ~*
824
+ # resetkeys Flush the list of allowed keys patterns.
825
+ # &<pattern> Add a glob-style pattern of Pub/Sub channels that can be
826
+ # accessed by the user. It is possible to specify multiple channel
827
+ # patterns.
828
+ # allchannels Alias for &*
829
+ # resetchannels Flush the list of allowed channel patterns.
830
+ # ><password> Add this password to the list of valid password for the user.
831
+ # For example >mypass will add "mypass" to the list.
832
+ # This directive clears the "nopass" flag (see later).
833
+ # <<password> Remove this password from the list of valid passwords.
834
+ # nopass All the set passwords of the user are removed, and the user
835
+ # is flagged as requiring no password: it means that every
836
+ # password will work against this user. If this directive is
837
+ # used for the default user, every new connection will be
838
+ # immediately authenticated with the default user without
839
+ # any explicit AUTH command required. Note that the "resetpass"
840
+ # directive will clear this condition.
841
+ # resetpass Flush the list of allowed passwords. Moreover removes the
842
+ # "nopass" status. After "resetpass" the user has no associated
843
+ # passwords and there is no way to authenticate without adding
844
+ # some password (or setting it as "nopass" later).
845
+ # reset Performs the following actions: resetpass, resetkeys, off,
846
+ # -@all. The user returns to the same state it has immediately
847
+ # after its creation.
848
+ #
849
+ # ACL rules can be specified in any order: for instance you can start with
850
+ # passwords, then flags, or key patterns. However note that the additive
851
+ # and subtractive rules will CHANGE MEANING depending on the ordering.
852
+ # For instance see the following example:
853
+ #
854
+ user daveh on on +@all ~* >foobarbazzle
855
+ user default off
856
+
857
+ # user alice on +@all -DEBUG ~* >somepassword
858
+ #
859
+ # This will allow "alice" to use all the commands with the exception of the
860
+ # DEBUG command, since +@all added all the commands to the set of the commands
861
+ # alice can use, and later DEBUG was removed. However if we invert the order
862
+ # of two ACL rules the result will be different:
863
+ #
864
+ # user alice on -DEBUG +@all ~* >somepassword
865
+ #
866
+ # Now DEBUG was removed when alice had yet no commands in the set of allowed
867
+ # commands, later all the commands are added, so the user will be able to
868
+ # execute everything.
869
+ #
870
+ # Basically ACL rules are processed left-to-right.
871
+ #
872
+ # For more information about ACL configuration please refer to
873
+ # the Redis web site at https://redis.io/topics/acl
874
+
875
+ # ACL LOG
876
+ #
877
+ # The ACL Log tracks failed commands and authentication events associated
878
+ # with ACLs. The ACL Log is useful to troubleshoot failed commands blocked
879
+ # by ACLs. The ACL Log is stored in memory. You can reclaim memory with
880
+ # ACL LOG RESET. Define the maximum entry length of the ACL Log below.
881
+ acllog-max-len 128
882
+
883
+ # Using an external ACL file
884
+ #
885
+ # Instead of configuring users here in this file, it is possible to use
886
+ # a stand-alone file just listing users. The two methods cannot be mixed:
887
+ # if you configure users here and at the same time you activate the external
888
+ # ACL file, the server will refuse to start.
889
+ #
890
+ # The format of the external ACL user file is exactly the same as the
891
+ # format that is used inside redis.conf to describe users.
892
+ #
893
+ # aclfile /etc/redis/users.acl
894
+
895
+ # IMPORTANT NOTE: starting with Redis 6 "requirepass" is just a compatibility
896
+ # layer on top of the new ACL system. The option effect will be just setting
897
+ # the password for the default user. Clients will still authenticate using
898
+ # AUTH <password> as usually, or more explicitly with AUTH default <password>
899
+ # if they follow the new protocol: both will work.
900
+ #
901
+ # The requirepass is not compatable with aclfile option and the ACL LOAD
902
+ # command, these will cause requirepass to be ignored.
903
+ #
904
+ # requirepass foobared
905
+
906
+ # New users are initialized with restrictive permissions by default, via the
907
+ # equivalent of this ACL rule 'off resetkeys -@all'. Starting with Redis 6.2, it
908
+ # is possible to manage access to Pub/Sub channels with ACL rules as well. The
909
+ # default Pub/Sub channels permission if new users is controlled by the
910
+ # acl-pubsub-default configuration directive, which accepts one of these values:
911
+ #
912
+ # allchannels: grants access to all Pub/Sub channels
913
+ # resetchannels: revokes access to all Pub/Sub channels
914
+ #
915
+ # To ensure backward compatibility while upgrading Redis 6.0, acl-pubsub-default
916
+ # defaults to the 'allchannels' permission.
917
+ #
918
+ # Future compatibility note: it is very likely that in a future version of Redis
919
+ # the directive's default of 'allchannels' will be changed to 'resetchannels' in
920
+ # order to provide better out-of-the-box Pub/Sub security. Therefore, it is
921
+ # recommended that you explicitly define Pub/Sub permissions for all users
922
+ # rather then rely on implicit default values. Once you've set explicit
923
+ # Pub/Sub for all existing users, you should uncomment the following line.
924
+ #
925
+ # acl-pubsub-default resetchannels
926
+
927
+ # Command renaming (DEPRECATED).
928
+ #
929
+ # ------------------------------------------------------------------------
930
+ # WARNING: avoid using this option if possible. Instead use ACLs to remove
931
+ # commands from the default user, and put them only in some admin user you
932
+ # create for administrative purposes.
933
+ # ------------------------------------------------------------------------
934
+ #
935
+ # It is possible to change the name of dangerous commands in a shared
936
+ # environment. For instance the CONFIG command may be renamed into something
937
+ # hard to guess so that it will still be available for internal-use tools
938
+ # but not available for general clients.
939
+ #
940
+ # Example:
941
+ #
942
+ # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
943
+ #
944
+ # It is also possible to completely kill a command by renaming it into
945
+ # an empty string:
946
+ #
947
+ # rename-command CONFIG ""
948
+ #
949
+ # Please note that changing the name of commands that are logged into the
950
+ # AOF file or transmitted to replicas may cause problems.
951
+
952
+ ################################### CLIENTS ####################################
953
+
954
+ # Set the max number of connected clients at the same time. By default
955
+ # this limit is set to 10000 clients, however if the Redis server is not
956
+ # able to configure the process file limit to allow for the specified limit
957
+ # the max number of allowed clients is set to the current file limit
958
+ # minus 32 (as Redis reserves a few file descriptors for internal uses).
959
+ #
960
+ # Once the limit is reached Redis will close all the new connections sending
961
+ # an error 'max number of clients reached'.
962
+ #
963
+ # IMPORTANT: When Redis Cluster is used, the max number of connections is also
964
+ # shared with the cluster bus: every node in the cluster will use two
965
+ # connections, one incoming and another outgoing. It is important to size the
966
+ # limit accordingly in case of very large clusters.
967
+ #
968
+ # maxclients 10000
969
+
970
+ ############################## MEMORY MANAGEMENT ################################
971
+
972
+ # Set a memory usage limit to the specified amount of bytes.
973
+ # When the memory limit is reached Redis will try to remove keys
974
+ # according to the eviction policy selected (see maxmemory-policy).
975
+ #
976
+ # If Redis can't remove keys according to the policy, or if the policy is
977
+ # set to 'noeviction', Redis will start to reply with errors to commands
978
+ # that would use more memory, like SET, LPUSH, and so on, and will continue
979
+ # to reply to read-only commands like GET.
980
+ #
981
+ # This option is usually useful when using Redis as an LRU or LFU cache, or to
982
+ # set a hard memory limit for an instance (using the 'noeviction' policy).
983
+ #
984
+ # WARNING: If you have replicas attached to an instance with maxmemory on,
985
+ # the size of the output buffers needed to feed the replicas are subtracted
986
+ # from the used memory count, so that network problems / resyncs will
987
+ # not trigger a loop where keys are evicted, and in turn the output
988
+ # buffer of replicas is full with DELs of keys evicted triggering the deletion
989
+ # of more keys, and so forth until the database is completely emptied.
990
+ #
991
+ # In short... if you have replicas attached it is suggested that you set a lower
992
+ # limit for maxmemory so that there is some free RAM on the system for replica
993
+ # output buffers (but this is not needed if the policy is 'noeviction').
994
+ #
995
+ # maxmemory <bytes>
996
+
997
+ # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
998
+ # is reached. You can select one from the following behaviors:
999
+ #
1000
+ # volatile-lru -> Evict using approximated LRU, only keys with an expire set.
1001
+ # allkeys-lru -> Evict any key using approximated LRU.
1002
+ # volatile-lfu -> Evict using approximated LFU, only keys with an expire set.
1003
+ # allkeys-lfu -> Evict any key using approximated LFU.
1004
+ # volatile-random -> Remove a random key having an expire set.
1005
+ # allkeys-random -> Remove a random key, any key.
1006
+ # volatile-ttl -> Remove the key with the nearest expire time (minor TTL)
1007
+ # noeviction -> Don't evict anything, just return an error on write operations.
1008
+ #
1009
+ # LRU means Least Recently Used
1010
+ # LFU means Least Frequently Used
1011
+ #
1012
+ # Both LRU, LFU and volatile-ttl are implemented using approximated
1013
+ # randomized algorithms.
1014
+ #
1015
+ # Note: with any of the above policies, when there are no suitable keys for
1016
+ # eviction, Redis will return an error on write operations that require
1017
+ # more memory. These are usually commands that create new keys, add data or
1018
+ # modify existing keys. A few examples are: SET, INCR, HSET, LPUSH, SUNIONSTORE,
1019
+ # SORT (due to the STORE argument), and EXEC (if the transaction includes any
1020
+ # command that requires memory).
1021
+ #
1022
+ # The default is:
1023
+ #
1024
+ # maxmemory-policy noeviction
1025
+
1026
+ # LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated
1027
+ # algorithms (in order to save memory), so you can tune it for speed or
1028
+ # accuracy. By default Redis will check five keys and pick the one that was
1029
+ # used least recently, you can change the sample size using the following
1030
+ # configuration directive.
1031
+ #
1032
+ # The default of 5 produces good enough results. 10 Approximates very closely
1033
+ # true LRU but costs more CPU. 3 is faster but not very accurate.
1034
+ #
1035
+ # maxmemory-samples 5
1036
+
1037
+ # Eviction processing is designed to function well with the default setting.
1038
+ # If there is an unusually large amount of write traffic, this value may need to
1039
+ # be increased. Decreasing this value may reduce latency at the risk of
1040
+ # eviction processing effectiveness
1041
+ # 0 = minimum latency, 10 = default, 100 = process without regard to latency
1042
+ #
1043
+ # maxmemory-eviction-tenacity 10
1044
+
1045
+ # Starting from Redis 5, by default a replica will ignore its maxmemory setting
1046
+ # (unless it is promoted to master after a failover or manually). It means
1047
+ # that the eviction of keys will be just handled by the master, sending the
1048
+ # DEL commands to the replica as keys evict in the master side.
1049
+ #
1050
+ # This behavior ensures that masters and replicas stay consistent, and is usually
1051
+ # what you want, however if your replica is writable, or you want the replica
1052
+ # to have a different memory setting, and you are sure all the writes performed
1053
+ # to the replica are idempotent, then you may change this default (but be sure
1054
+ # to understand what you are doing).
1055
+ #
1056
+ # Note that since the replica by default does not evict, it may end using more
1057
+ # memory than the one set via maxmemory (there are certain buffers that may
1058
+ # be larger on the replica, or data structures may sometimes take more memory
1059
+ # and so forth). So make sure you monitor your replicas and make sure they
1060
+ # have enough memory to never hit a real out-of-memory condition before the
1061
+ # master hits the configured maxmemory setting.
1062
+ #
1063
+ # replica-ignore-maxmemory yes
1064
+
1065
+ # Redis reclaims expired keys in two ways: upon access when those keys are
1066
+ # found to be expired, and also in background, in what is called the
1067
+ # "active expire key". The key space is slowly and interactively scanned
1068
+ # looking for expired keys to reclaim, so that it is possible to free memory
1069
+ # of keys that are expired and will never be accessed again in a short time.
1070
+ #
1071
+ # The default effort of the expire cycle will try to avoid having more than
1072
+ # ten percent of expired keys still in memory, and will try to avoid consuming
1073
+ # more than 25% of total memory and to add latency to the system. However
1074
+ # it is possible to increase the expire "effort" that is normally set to
1075
+ # "1", to a greater value, up to the value "10". At its maximum value the
1076
+ # system will use more CPU, longer cycles (and technically may introduce
1077
+ # more latency), and will tolerate less already expired keys still present
1078
+ # in the system. It's a tradeoff between memory, CPU and latency.
1079
+ #
1080
+ # active-expire-effort 1
1081
+
1082
+ ############################# LAZY FREEING ####################################
1083
+
1084
+ # Redis has two primitives to delete keys. One is called DEL and is a blocking
1085
+ # deletion of the object. It means that the server stops processing new commands
1086
+ # in order to reclaim all the memory associated with an object in a synchronous
1087
+ # way. If the key deleted is associated with a small object, the time needed
1088
+ # in order to execute the DEL command is very small and comparable to most other
1089
+ # O(1) or O(log_N) commands in Redis. However if the key is associated with an
1090
+ # aggregated value containing millions of elements, the server can block for
1091
+ # a long time (even seconds) in order to complete the operation.
1092
+ #
1093
+ # For the above reasons Redis also offers non blocking deletion primitives
1094
+ # such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and
1095
+ # FLUSHDB commands, in order to reclaim memory in background. Those commands
1096
+ # are executed in constant time. Another thread will incrementally free the
1097
+ # object in the background as fast as possible.
1098
+ #
1099
+ # DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled.
1100
+ # It's up to the design of the application to understand when it is a good
1101
+ # idea to use one or the other. However the Redis server sometimes has to
1102
+ # delete keys or flush the whole database as a side effect of other operations.
1103
+ # Specifically Redis deletes objects independently of a user call in the
1104
+ # following scenarios:
1105
+ #
1106
+ # 1) On eviction, because of the maxmemory and maxmemory policy configurations,
1107
+ # in order to make room for new data, without going over the specified
1108
+ # memory limit.
1109
+ # 2) Because of expire: when a key with an associated time to live (see the
1110
+ # EXPIRE command) must be deleted from memory.
1111
+ # 3) Because of a side effect of a command that stores data on a key that may
1112
+ # already exist. For example the RENAME command may delete the old key
1113
+ # content when it is replaced with another one. Similarly SUNIONSTORE
1114
+ # or SORT with STORE option may delete existing keys. The SET command
1115
+ # itself removes any old content of the specified key in order to replace
1116
+ # it with the specified string.
1117
+ # 4) During replication, when a replica performs a full resynchronization with
1118
+ # its master, the content of the whole database is removed in order to
1119
+ # load the RDB file just transferred.
1120
+ #
1121
+ # In all the above cases the default is to delete objects in a blocking way,
1122
+ # like if DEL was called. However you can configure each case specifically
1123
+ # in order to instead release memory in a non-blocking way like if UNLINK
1124
+ # was called, using the following configuration directives.
1125
+
1126
+ lazyfree-lazy-eviction no
1127
+ lazyfree-lazy-expire no
1128
+ lazyfree-lazy-server-del no
1129
+ replica-lazy-flush no
1130
+
1131
+ # It is also possible, for the case when to replace the user code DEL calls
1132
+ # with UNLINK calls is not easy, to modify the default behavior of the DEL
1133
+ # command to act exactly like UNLINK, using the following configuration
1134
+ # directive:
1135
+
1136
+ lazyfree-lazy-user-del no
1137
+
1138
+ # FLUSHDB, FLUSHALL, and SCRIPT FLUSH support both asynchronous and synchronous
1139
+ # deletion, which can be controlled by passing the [SYNC|ASYNC] flags into the
1140
+ # commands. When neither flag is passed, this directive will be used to determine
1141
+ # if the data should be deleted asynchronously.
1142
+
1143
+ lazyfree-lazy-user-flush no
1144
+
1145
+ ################################ THREADED I/O #################################
1146
+
1147
+ # Redis is mostly single threaded, however there are certain threaded
1148
+ # operations such as UNLINK, slow I/O accesses and other things that are
1149
+ # performed on side threads.
1150
+ #
1151
+ # Now it is also possible to handle Redis clients socket reads and writes
1152
+ # in different I/O threads. Since especially writing is so slow, normally
1153
+ # Redis users use pipelining in order to speed up the Redis performances per
1154
+ # core, and spawn multiple instances in order to scale more. Using I/O
1155
+ # threads it is possible to easily speedup two times Redis without resorting
1156
+ # to pipelining nor sharding of the instance.
1157
+ #
1158
+ # By default threading is disabled, we suggest enabling it only in machines
1159
+ # that have at least 4 or more cores, leaving at least one spare core.
1160
+ # Using more than 8 threads is unlikely to help much. We also recommend using
1161
+ # threaded I/O only if you actually have performance problems, with Redis
1162
+ # instances being able to use a quite big percentage of CPU time, otherwise
1163
+ # there is no point in using this feature.
1164
+ #
1165
+ # So for instance if you have a four cores boxes, try to use 2 or 3 I/O
1166
+ # threads, if you have a 8 cores, try to use 6 threads. In order to
1167
+ # enable I/O threads use the following configuration directive:
1168
+ #
1169
+ # io-threads 4
1170
+ #
1171
+ # Setting io-threads to 1 will just use the main thread as usual.
1172
+ # When I/O threads are enabled, we only use threads for writes, that is
1173
+ # to thread the write(2) syscall and transfer the client buffers to the
1174
+ # socket. However it is also possible to enable threading of reads and
1175
+ # protocol parsing using the following configuration directive, by setting
1176
+ # it to yes:
1177
+ #
1178
+ # io-threads-do-reads no
1179
+ #
1180
+ # Usually threading reads doesn't help much.
1181
+ #
1182
+ # NOTE 1: This configuration directive cannot be changed at runtime via
1183
+ # CONFIG SET. Aso this feature currently does not work when SSL is
1184
+ # enabled.
1185
+ #
1186
+ # NOTE 2: If you want to test the Redis speedup using redis-benchmark, make
1187
+ # sure you also run the benchmark itself in threaded mode, using the
1188
+ # --threads option to match the number of Redis threads, otherwise you'll not
1189
+ # be able to notice the improvements.
1190
+
1191
+ ############################ KERNEL OOM CONTROL ##############################
1192
+
1193
+ # On Linux, it is possible to hint the kernel OOM killer on what processes
1194
+ # should be killed first when out of memory.
1195
+ #
1196
+ # Enabling this feature makes Redis actively control the oom_score_adj value
1197
+ # for all its processes, depending on their role. The default scores will
1198
+ # attempt to have background child processes killed before all others, and
1199
+ # replicas killed before masters.
1200
+ #
1201
+ # Redis supports three options:
1202
+ #
1203
+ # no: Don't make changes to oom-score-adj (default).
1204
+ # yes: Alias to "relative" see below.
1205
+ # absolute: Values in oom-score-adj-values are written as is to the kernel.
1206
+ # relative: Values are used relative to the initial value of oom_score_adj when
1207
+ # the server starts and are then clamped to a range of -1000 to 1000.
1208
+ # Because typically the initial value is 0, they will often match the
1209
+ # absolute values.
1210
+ oom-score-adj no
1211
+
1212
+ # When oom-score-adj is used, this directive controls the specific values used
1213
+ # for master, replica and background child processes. Values range -2000 to
1214
+ # 2000 (higher means more likely to be killed).
1215
+ #
1216
+ # Unprivileged processes (not root, and without CAP_SYS_RESOURCE capabilities)
1217
+ # can freely increase their value, but not decrease it below its initial
1218
+ # settings. This means that setting oom-score-adj to "relative" and setting the
1219
+ # oom-score-adj-values to positive values will always succeed.
1220
+ oom-score-adj-values 0 200 800
1221
+
1222
+
1223
+ #################### KERNEL transparent hugepage CONTROL ######################
1224
+
1225
+ # Usually the kernel Transparent Huge Pages control is set to "madvise" or
1226
+ # or "never" by default (/sys/kernel/mm/transparent_hugepage/enabled), in which
1227
+ # case this config has no effect. On systems in which it is set to "always",
1228
+ # redis will attempt to disable it specifically for the redis process in order
1229
+ # to avoid latency problems specifically with fork(2) and CoW.
1230
+ # If for some reason you prefer to keep it enabled, you can set this config to
1231
+ # "no" and the kernel global to "always".
1232
+
1233
+ disable-thp yes
1234
+
1235
+ ############################## APPEND ONLY MODE ###############################
1236
+
1237
+ # By default Redis asynchronously dumps the dataset on disk. This mode is
1238
+ # good enough in many applications, but an issue with the Redis process or
1239
+ # a power outage may result into a few minutes of writes lost (depending on
1240
+ # the configured save points).
1241
+ #
1242
+ # The Append Only File is an alternative persistence mode that provides
1243
+ # much better durability. For instance using the default data fsync policy
1244
+ # (see later in the config file) Redis can lose just one second of writes in a
1245
+ # dramatic event like a server power outage, or a single write if something
1246
+ # wrong with the Redis process itself happens, but the operating system is
1247
+ # still running correctly.
1248
+ #
1249
+ # AOF and RDB persistence can be enabled at the same time without problems.
1250
+ # If the AOF is enabled on startup Redis will load the AOF, that is the file
1251
+ # with the better durability guarantees.
1252
+ #
1253
+ # Please check https://redis.io/topics/persistence for more information.
1254
+
1255
+ appendonly no
1256
+
1257
+ # The name of the append only file (default: "appendonly.aof")
1258
+
1259
+ appendfilename "appendonly.aof"
1260
+
1261
+ # The fsync() call tells the Operating System to actually write data on disk
1262
+ # instead of waiting for more data in the output buffer. Some OS will really flush
1263
+ # data on disk, some other OS will just try to do it ASAP.
1264
+ #
1265
+ # Redis supports three different modes:
1266
+ #
1267
+ # no: don't fsync, just let the OS flush the data when it wants. Faster.
1268
+ # always: fsync after every write to the append only log. Slow, Safest.
1269
+ # everysec: fsync only one time every second. Compromise.
1270
+ #
1271
+ # The default is "everysec", as that's usually the right compromise between
1272
+ # speed and data safety. It's up to you to understand if you can relax this to
1273
+ # "no" that will let the operating system flush the output buffer when
1274
+ # it wants, for better performances (but if you can live with the idea of
1275
+ # some data loss consider the default persistence mode that's snapshotting),
1276
+ # or on the contrary, use "always" that's very slow but a bit safer than
1277
+ # everysec.
1278
+ #
1279
+ # More details please check the following article:
1280
+ # http://antirez.com/post/redis-persistence-demystified.html
1281
+ #
1282
+ # If unsure, use "everysec".
1283
+
1284
+ # appendfsync always
1285
+ appendfsync everysec
1286
+ # appendfsync no
1287
+
1288
+ # When the AOF fsync policy is set to always or everysec, and a background
1289
+ # saving process (a background save or AOF log background rewriting) is
1290
+ # performing a lot of I/O against the disk, in some Linux configurations
1291
+ # Redis may block too long on the fsync() call. Note that there is no fix for
1292
+ # this currently, as even performing fsync in a different thread will block
1293
+ # our synchronous write(2) call.
1294
+ #
1295
+ # In order to mitigate this problem it's possible to use the following option
1296
+ # that will prevent fsync() from being called in the main process while a
1297
+ # BGSAVE or BGREWRITEAOF is in progress.
1298
+ #
1299
+ # This means that while another child is saving, the durability of Redis is
1300
+ # the same as "appendfsync none". In practical terms, this means that it is
1301
+ # possible to lose up to 30 seconds of log in the worst scenario (with the
1302
+ # default Linux settings).
1303
+ #
1304
+ # If you have latency problems turn this to "yes". Otherwise leave it as
1305
+ # "no" that is the safest pick from the point of view of durability.
1306
+
1307
+ no-appendfsync-on-rewrite no
1308
+
1309
+ # Automatic rewrite of the append only file.
1310
+ # Redis is able to automatically rewrite the log file implicitly calling
1311
+ # BGREWRITEAOF when the AOF log size grows by the specified percentage.
1312
+ #
1313
+ # This is how it works: Redis remembers the size of the AOF file after the
1314
+ # latest rewrite (if no rewrite has happened since the restart, the size of
1315
+ # the AOF at startup is used).
1316
+ #
1317
+ # This base size is compared to the current size. If the current size is
1318
+ # bigger than the specified percentage, the rewrite is triggered. Also
1319
+ # you need to specify a minimal size for the AOF file to be rewritten, this
1320
+ # is useful to avoid rewriting the AOF file even if the percentage increase
1321
+ # is reached but it is still pretty small.
1322
+ #
1323
+ # Specify a percentage of zero in order to disable the automatic AOF
1324
+ # rewrite feature.
1325
+
1326
+ auto-aof-rewrite-percentage 100
1327
+ auto-aof-rewrite-min-size 64mb
1328
+
1329
+ # An AOF file may be found to be truncated at the end during the Redis
1330
+ # startup process, when the AOF data gets loaded back into memory.
1331
+ # This may happen when the system where Redis is running
1332
+ # crashes, especially when an ext4 filesystem is mounted without the
1333
+ # data=ordered option (however this can't happen when Redis itself
1334
+ # crashes or aborts but the operating system still works correctly).
1335
+ #
1336
+ # Redis can either exit with an error when this happens, or load as much
1337
+ # data as possible (the default now) and start if the AOF file is found
1338
+ # to be truncated at the end. The following option controls this behavior.
1339
+ #
1340
+ # If aof-load-truncated is set to yes, a truncated AOF file is loaded and
1341
+ # the Redis server starts emitting a log to inform the user of the event.
1342
+ # Otherwise if the option is set to no, the server aborts with an error
1343
+ # and refuses to start. When the option is set to no, the user requires
1344
+ # to fix the AOF file using the "redis-check-aof" utility before to restart
1345
+ # the server.
1346
+ #
1347
+ # Note that if the AOF file will be found to be corrupted in the middle
1348
+ # the server will still exit with an error. This option only applies when
1349
+ # Redis will try to read more data from the AOF file but not enough bytes
1350
+ # will be found.
1351
+ aof-load-truncated yes
1352
+
1353
+ # When rewriting the AOF file, Redis is able to use an RDB preamble in the
1354
+ # AOF file for faster rewrites and recoveries. When this option is turned
1355
+ # on the rewritten AOF file is composed of two different stanzas:
1356
+ #
1357
+ # [RDB file][AOF tail]
1358
+ #
1359
+ # When loading, Redis recognizes that the AOF file starts with the "REDIS"
1360
+ # string and loads the prefixed RDB file, then continues loading the AOF
1361
+ # tail.
1362
+ aof-use-rdb-preamble yes
1363
+
1364
+ ################################ LUA SCRIPTING ###############################
1365
+
1366
+ # Max execution time of a Lua script in milliseconds.
1367
+ #
1368
+ # If the maximum execution time is reached Redis will log that a script is
1369
+ # still in execution after the maximum allowed time and will start to
1370
+ # reply to queries with an error.
1371
+ #
1372
+ # When a long running script exceeds the maximum execution time only the
1373
+ # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
1374
+ # used to stop a script that did not yet call any write commands. The second
1375
+ # is the only way to shut down the server in the case a write command was
1376
+ # already issued by the script but the user doesn't want to wait for the natural
1377
+ # termination of the script.
1378
+ #
1379
+ # Set it to 0 or a negative value for unlimited execution without warnings.
1380
+ lua-time-limit 5000
1381
+
1382
+ ################################ REDIS CLUSTER ###############################
1383
+
1384
+ # Normal Redis instances can't be part of a Redis Cluster; only nodes that are
1385
+ # started as cluster nodes can. In order to start a Redis instance as a
1386
+ # cluster node enable the cluster support uncommenting the following:
1387
+ #
1388
+ # cluster-enabled yes
1389
+
1390
+ # Every cluster node has a cluster configuration file. This file is not
1391
+ # intended to be edited by hand. It is created and updated by Redis nodes.
1392
+ # Every Redis Cluster node requires a different cluster configuration file.
1393
+ # Make sure that instances running in the same system do not have
1394
+ # overlapping cluster configuration file names.
1395
+ #
1396
+ # cluster-config-file nodes-6379.conf
1397
+
1398
+ # Cluster node timeout is the amount of milliseconds a node must be unreachable
1399
+ # for it to be considered in failure state.
1400
+ # Most other internal time limits are a multiple of the node timeout.
1401
+ #
1402
+ # cluster-node-timeout 15000
1403
+
1404
+ # A replica of a failing master will avoid to start a failover if its data
1405
+ # looks too old.
1406
+ #
1407
+ # There is no simple way for a replica to actually have an exact measure of
1408
+ # its "data age", so the following two checks are performed:
1409
+ #
1410
+ # 1) If there are multiple replicas able to failover, they exchange messages
1411
+ # in order to try to give an advantage to the replica with the best
1412
+ # replication offset (more data from the master processed).
1413
+ # Replicas will try to get their rank by offset, and apply to the start
1414
+ # of the failover a delay proportional to their rank.
1415
+ #
1416
+ # 2) Every single replica computes the time of the last interaction with
1417
+ # its master. This can be the last ping or command received (if the master
1418
+ # is still in the "connected" state), or the time that elapsed since the
1419
+ # disconnection with the master (if the replication link is currently down).
1420
+ # If the last interaction is too old, the replica will not try to failover
1421
+ # at all.
1422
+ #
1423
+ # The point "2" can be tuned by user. Specifically a replica will not perform
1424
+ # the failover if, since the last interaction with the master, the time
1425
+ # elapsed is greater than:
1426
+ #
1427
+ # (node-timeout * cluster-replica-validity-factor) + repl-ping-replica-period
1428
+ #
1429
+ # So for example if node-timeout is 30 seconds, and the cluster-replica-validity-factor
1430
+ # is 10, and assuming a default repl-ping-replica-period of 10 seconds, the
1431
+ # replica will not try to failover if it was not able to talk with the master
1432
+ # for longer than 310 seconds.
1433
+ #
1434
+ # A large cluster-replica-validity-factor may allow replicas with too old data to failover
1435
+ # a master, while a too small value may prevent the cluster from being able to
1436
+ # elect a replica at all.
1437
+ #
1438
+ # For maximum availability, it is possible to set the cluster-replica-validity-factor
1439
+ # to a value of 0, which means, that replicas will always try to failover the
1440
+ # master regardless of the last time they interacted with the master.
1441
+ # (However they'll always try to apply a delay proportional to their
1442
+ # offset rank).
1443
+ #
1444
+ # Zero is the only value able to guarantee that when all the partitions heal
1445
+ # the cluster will always be able to continue.
1446
+ #
1447
+ # cluster-replica-validity-factor 10
1448
+
1449
+ # Cluster replicas are able to migrate to orphaned masters, that are masters
1450
+ # that are left without working replicas. This improves the cluster ability
1451
+ # to resist to failures as otherwise an orphaned master can't be failed over
1452
+ # in case of failure if it has no working replicas.
1453
+ #
1454
+ # Replicas migrate to orphaned masters only if there are still at least a
1455
+ # given number of other working replicas for their old master. This number
1456
+ # is the "migration barrier". A migration barrier of 1 means that a replica
1457
+ # will migrate only if there is at least 1 other working replica for its master
1458
+ # and so forth. It usually reflects the number of replicas you want for every
1459
+ # master in your cluster.
1460
+ #
1461
+ # Default is 1 (replicas migrate only if their masters remain with at least
1462
+ # one replica). To disable migration just set it to a very large value or
1463
+ # set cluster-allow-replica-migration to 'no'.
1464
+ # A value of 0 can be set but is useful only for debugging and dangerous
1465
+ # in production.
1466
+ #
1467
+ # cluster-migration-barrier 1
1468
+
1469
+ # Turning off this option allows to use less automatic cluster configuration.
1470
+ # It both disables migration to orphaned masters and migration from masters
1471
+ # that became empty.
1472
+ #
1473
+ # Default is 'yes' (allow automatic migrations).
1474
+ #
1475
+ # cluster-allow-replica-migration yes
1476
+
1477
+ # By default Redis Cluster nodes stop accepting queries if they detect there
1478
+ # is at least a hash slot uncovered (no available node is serving it).
1479
+ # This way if the cluster is partially down (for example a range of hash slots
1480
+ # are no longer covered) all the cluster becomes, eventually, unavailable.
1481
+ # It automatically returns available as soon as all the slots are covered again.
1482
+ #
1483
+ # However sometimes you want the subset of the cluster which is working,
1484
+ # to continue to accept queries for the part of the key space that is still
1485
+ # covered. In order to do so, just set the cluster-require-full-coverage
1486
+ # option to no.
1487
+ #
1488
+ # cluster-require-full-coverage yes
1489
+
1490
+ # This option, when set to yes, prevents replicas from trying to failover its
1491
+ # master during master failures. However the replica can still perform a
1492
+ # manual failover, if forced to do so.
1493
+ #
1494
+ # This is useful in different scenarios, especially in the case of multiple
1495
+ # data center operations, where we want one side to never be promoted if not
1496
+ # in the case of a total DC failure.
1497
+ #
1498
+ # cluster-replica-no-failover no
1499
+
1500
+ # This option, when set to yes, allows nodes to serve read traffic while the
1501
+ # the cluster is in a down state, as long as it believes it owns the slots.
1502
+ #
1503
+ # This is useful for two cases. The first case is for when an application
1504
+ # doesn't require consistency of data during node failures or network partitions.
1505
+ # One example of this is a cache, where as long as the node has the data it
1506
+ # should be able to serve it.
1507
+ #
1508
+ # The second use case is for configurations that don't meet the recommended
1509
+ # three shards but want to enable cluster mode and scale later. A
1510
+ # master outage in a 1 or 2 shard configuration causes a read/write outage to the
1511
+ # entire cluster without this option set, with it set there is only a write outage.
1512
+ # Without a quorum of masters, slot ownership will not change automatically.
1513
+ #
1514
+ # cluster-allow-reads-when-down no
1515
+
1516
+ # In order to setup your cluster make sure to read the documentation
1517
+ # available at https://redis.io web site.
1518
+
1519
+ ########################## CLUSTER DOCKER/NAT support ########################
1520
+
1521
+ # In certain deployments, Redis Cluster nodes address discovery fails, because
1522
+ # addresses are NAT-ted or because ports are forwarded (the typical case is
1523
+ # Docker and other containers).
1524
+ #
1525
+ # In order to make Redis Cluster working in such environments, a static
1526
+ # configuration where each node knows its public address is needed. The
1527
+ # following four options are used for this scope, and are:
1528
+ #
1529
+ # * cluster-announce-ip
1530
+ # * cluster-announce-port
1531
+ # * cluster-announce-tls-port
1532
+ # * cluster-announce-bus-port
1533
+ #
1534
+ # Each instructs the node about its address, client ports (for connections
1535
+ # without and with TLS) and cluster message bus port. The information is then
1536
+ # published in the header of the bus packets so that other nodes will be able to
1537
+ # correctly map the address of the node publishing the information.
1538
+ #
1539
+ # If cluster-tls is set to yes and cluster-announce-tls-port is omitted or set
1540
+ # to zero, then cluster-announce-port refers to the TLS port. Note also that
1541
+ # cluster-announce-tls-port has no effect if cluster-tls is set to no.
1542
+ #
1543
+ # If the above options are not used, the normal Redis Cluster auto-detection
1544
+ # will be used instead.
1545
+ #
1546
+ # Note that when remapped, the bus port may not be at the fixed offset of
1547
+ # clients port + 10000, so you can specify any port and bus-port depending
1548
+ # on how they get remapped. If the bus-port is not set, a fixed offset of
1549
+ # 10000 will be used as usual.
1550
+ #
1551
+ # Example:
1552
+ #
1553
+ # cluster-announce-ip 10.1.1.5
1554
+ # cluster-announce-tls-port 6379
1555
+ # cluster-announce-port 0
1556
+ # cluster-announce-bus-port 6380
1557
+
1558
+ ################################## SLOW LOG ###################################
1559
+
1560
+ # The Redis Slow Log is a system to log queries that exceeded a specified
1561
+ # execution time. The execution time does not include the I/O operations
1562
+ # like talking with the client, sending the reply and so forth,
1563
+ # but just the time needed to actually execute the command (this is the only
1564
+ # stage of command execution where the thread is blocked and can not serve
1565
+ # other requests in the meantime).
1566
+ #
1567
+ # You can configure the slow log with two parameters: one tells Redis
1568
+ # what is the execution time, in microseconds, to exceed in order for the
1569
+ # command to get logged, and the other parameter is the length of the
1570
+ # slow log. When a new command is logged the oldest one is removed from the
1571
+ # queue of logged commands.
1572
+
1573
+ # The following time is expressed in microseconds, so 1000000 is equivalent
1574
+ # to one second. Note that a negative number disables the slow log, while
1575
+ # a value of zero forces the logging of every command.
1576
+ slowlog-log-slower-than 10000
1577
+
1578
+ # There is no limit to this length. Just be aware that it will consume memory.
1579
+ # You can reclaim memory used by the slow log with SLOWLOG RESET.
1580
+ slowlog-max-len 128
1581
+
1582
+ ################################ LATENCY MONITOR ##############################
1583
+
1584
+ # The Redis latency monitoring subsystem samples different operations
1585
+ # at runtime in order to collect data related to possible sources of
1586
+ # latency of a Redis instance.
1587
+ #
1588
+ # Via the LATENCY command this information is available to the user that can
1589
+ # print graphs and obtain reports.
1590
+ #
1591
+ # The system only logs operations that were performed in a time equal or
1592
+ # greater than the amount of milliseconds specified via the
1593
+ # latency-monitor-threshold configuration directive. When its value is set
1594
+ # to zero, the latency monitor is turned off.
1595
+ #
1596
+ # By default latency monitoring is disabled since it is mostly not needed
1597
+ # if you don't have latency issues, and collecting data has a performance
1598
+ # impact, that while very small, can be measured under big load. Latency
1599
+ # monitoring can easily be enabled at runtime using the command
1600
+ # "CONFIG SET latency-monitor-threshold <milliseconds>" if needed.
1601
+ latency-monitor-threshold 0
1602
+
1603
+ ############################# EVENT NOTIFICATION ##############################
1604
+
1605
+ # Redis can notify Pub/Sub clients about events happening in the key space.
1606
+ # This feature is documented at https://redis.io/topics/notifications
1607
+ #
1608
+ # For instance if keyspace events notification is enabled, and a client
1609
+ # performs a DEL operation on key "foo" stored in the Database 0, two
1610
+ # messages will be published via Pub/Sub:
1611
+ #
1612
+ # PUBLISH __keyspace@0__:foo del
1613
+ # PUBLISH __keyevent@0__:del foo
1614
+ #
1615
+ # It is possible to select the events that Redis will notify among a set
1616
+ # of classes. Every class is identified by a single character:
1617
+ #
1618
+ # K Keyspace events, published with __keyspace@<db>__ prefix.
1619
+ # E Keyevent events, published with __keyevent@<db>__ prefix.
1620
+ # g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
1621
+ # $ String commands
1622
+ # l List commands
1623
+ # s Set commands
1624
+ # h Hash commands
1625
+ # z Sorted set commands
1626
+ # x Expired events (events generated every time a key expires)
1627
+ # e Evicted events (events generated when a key is evicted for maxmemory)
1628
+ # t Stream commands
1629
+ # d Module key type events
1630
+ # m Key-miss events (Note: It is not included in the 'A' class)
1631
+ # A Alias for g$lshzxetd, so that the "AKE" string means all the events
1632
+ # (Except key-miss events which are excluded from 'A' due to their
1633
+ # unique nature).
1634
+ #
1635
+ # The "notify-keyspace-events" takes as argument a string that is composed
1636
+ # of zero or multiple characters. The empty string means that notifications
1637
+ # are disabled.
1638
+ #
1639
+ # Example: to enable list and generic events, from the point of view of the
1640
+ # event name, use:
1641
+ #
1642
+ # notify-keyspace-events Elg
1643
+ #
1644
+ # Example 2: to get the stream of the expired keys subscribing to channel
1645
+ # name __keyevent@0__:expired use:
1646
+ #
1647
+ # notify-keyspace-events Ex
1648
+ #
1649
+ # By default all notifications are disabled because most users don't need
1650
+ # this feature and the feature has some overhead. Note that if you don't
1651
+ # specify at least one of K or E, no events will be delivered.
1652
+ notify-keyspace-events ""
1653
+
1654
+ ############################### GOPHER SERVER #################################
1655
+
1656
+ # Redis contains an implementation of the Gopher protocol, as specified in
1657
+ # the RFC 1436 (https://www.ietf.org/rfc/rfc1436.txt).
1658
+ #
1659
+ # The Gopher protocol was very popular in the late '90s. It is an alternative
1660
+ # to the web, and the implementation both server and client side is so simple
1661
+ # that the Redis server has just 100 lines of code in order to implement this
1662
+ # support.
1663
+ #
1664
+ # What do you do with Gopher nowadays? Well Gopher never *really* died, and
1665
+ # lately there is a movement in order for the Gopher more hierarchical content
1666
+ # composed of just plain text documents to be resurrected. Some want a simpler
1667
+ # internet, others believe that the mainstream internet became too much
1668
+ # controlled, and it's cool to create an alternative space for people that
1669
+ # want a bit of fresh air.
1670
+ #
1671
+ # Anyway for the 10nth birthday of the Redis, we gave it the Gopher protocol
1672
+ # as a gift.
1673
+ #
1674
+ # --- HOW IT WORKS? ---
1675
+ #
1676
+ # The Redis Gopher support uses the inline protocol of Redis, and specifically
1677
+ # two kind of inline requests that were anyway illegal: an empty request
1678
+ # or any request that starts with "/" (there are no Redis commands starting
1679
+ # with such a slash). Normal RESP2/RESP3 requests are completely out of the
1680
+ # path of the Gopher protocol implementation and are served as usual as well.
1681
+ #
1682
+ # If you open a connection to Redis when Gopher is enabled and send it
1683
+ # a string like "/foo", if there is a key named "/foo" it is served via the
1684
+ # Gopher protocol.
1685
+ #
1686
+ # In order to create a real Gopher "hole" (the name of a Gopher site in Gopher
1687
+ # talking), you likely need a script like the following:
1688
+ #
1689
+ # https://github.com/antirez/gopher2redis
1690
+ #
1691
+ # --- SECURITY WARNING ---
1692
+ #
1693
+ # If you plan to put Redis on the internet in a publicly accessible address
1694
+ # to server Gopher pages MAKE SURE TO SET A PASSWORD to the instance.
1695
+ # Once a password is set:
1696
+ #
1697
+ # 1. The Gopher server (when enabled, not by default) will still serve
1698
+ # content via Gopher.
1699
+ # 2. However other commands cannot be called before the client will
1700
+ # authenticate.
1701
+ #
1702
+ # So use the 'requirepass' option to protect your instance.
1703
+ #
1704
+ # Note that Gopher is not currently supported when 'io-threads-do-reads'
1705
+ # is enabled.
1706
+ #
1707
+ # To enable Gopher support, uncomment the following line and set the option
1708
+ # from no (the default) to yes.
1709
+ #
1710
+ # gopher-enabled no
1711
+
1712
+ ############################### ADVANCED CONFIG ###############################
1713
+
1714
+ # Hashes are encoded using a memory efficient data structure when they have a
1715
+ # small number of entries, and the biggest entry does not exceed a given
1716
+ # threshold. These thresholds can be configured using the following directives.
1717
+ hash-max-ziplist-entries 512
1718
+ hash-max-ziplist-value 64
1719
+
1720
+ # Lists are also encoded in a special way to save a lot of space.
1721
+ # The number of entries allowed per internal list node can be specified
1722
+ # as a fixed maximum size or a maximum number of elements.
1723
+ # For a fixed maximum size, use -5 through -1, meaning:
1724
+ # -5: max size: 64 Kb <-- not recommended for normal workloads
1725
+ # -4: max size: 32 Kb <-- not recommended
1726
+ # -3: max size: 16 Kb <-- probably not recommended
1727
+ # -2: max size: 8 Kb <-- good
1728
+ # -1: max size: 4 Kb <-- good
1729
+ # Positive numbers mean store up to _exactly_ that number of elements
1730
+ # per list node.
1731
+ # The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size),
1732
+ # but if your use case is unique, adjust the settings as necessary.
1733
+ list-max-ziplist-size -2
1734
+
1735
+ # Lists may also be compressed.
1736
+ # Compress depth is the number of quicklist ziplist nodes from *each* side of
1737
+ # the list to *exclude* from compression. The head and tail of the list
1738
+ # are always uncompressed for fast push/pop operations. Settings are:
1739
+ # 0: disable all list compression
1740
+ # 1: depth 1 means "don't start compressing until after 1 node into the list,
1741
+ # going from either the head or tail"
1742
+ # So: [head]->node->node->...->node->[tail]
1743
+ # [head], [tail] will always be uncompressed; inner nodes will compress.
1744
+ # 2: [head]->[next]->node->node->...->node->[prev]->[tail]
1745
+ # 2 here means: don't compress head or head->next or tail->prev or tail,
1746
+ # but compress all nodes between them.
1747
+ # 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail]
1748
+ # etc.
1749
+ list-compress-depth 0
1750
+
1751
+ # Sets have a special encoding in just one case: when a set is composed
1752
+ # of just strings that happen to be integers in radix 10 in the range
1753
+ # of 64 bit signed integers.
1754
+ # The following configuration setting sets the limit in the size of the
1755
+ # set in order to use this special memory saving encoding.
1756
+ set-max-intset-entries 512
1757
+
1758
+ # Similarly to hashes and lists, sorted sets are also specially encoded in
1759
+ # order to save a lot of space. This encoding is only used when the length and
1760
+ # elements of a sorted set are below the following limits:
1761
+ zset-max-ziplist-entries 128
1762
+ zset-max-ziplist-value 64
1763
+
1764
+ # HyperLogLog sparse representation bytes limit. The limit includes the
1765
+ # 16 bytes header. When an HyperLogLog using the sparse representation crosses
1766
+ # this limit, it is converted into the dense representation.
1767
+ #
1768
+ # A value greater than 16000 is totally useless, since at that point the
1769
+ # dense representation is more memory efficient.
1770
+ #
1771
+ # The suggested value is ~ 3000 in order to have the benefits of
1772
+ # the space efficient encoding without slowing down too much PFADD,
1773
+ # which is O(N) with the sparse encoding. The value can be raised to
1774
+ # ~ 10000 when CPU is not a concern, but space is, and the data set is
1775
+ # composed of many HyperLogLogs with cardinality in the 0 - 15000 range.
1776
+ hll-sparse-max-bytes 3000
1777
+
1778
+ # Streams macro node max size / items. The stream data structure is a radix
1779
+ # tree of big nodes that encode multiple items inside. Using this configuration
1780
+ # it is possible to configure how big a single node can be in bytes, and the
1781
+ # maximum number of items it may contain before switching to a new node when
1782
+ # appending new stream entries. If any of the following settings are set to
1783
+ # zero, the limit is ignored, so for instance it is possible to set just a
1784
+ # max entries limit by setting max-bytes to 0 and max-entries to the desired
1785
+ # value.
1786
+ stream-node-max-bytes 4096
1787
+ stream-node-max-entries 100
1788
+
1789
+ # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
1790
+ # order to help rehashing the main Redis hash table (the one mapping top-level
1791
+ # keys to values). The hash table implementation Redis uses (see dict.c)
1792
+ # performs a lazy rehashing: the more operation you run into a hash table
1793
+ # that is rehashing, the more rehashing "steps" are performed, so if the
1794
+ # server is idle the rehashing is never complete and some more memory is used
1795
+ # by the hash table.
1796
+ #
1797
+ # The default is to use this millisecond 10 times every second in order to
1798
+ # actively rehash the main dictionaries, freeing memory when possible.
1799
+ #
1800
+ # If unsure:
1801
+ # use "activerehashing no" if you have hard latency requirements and it is
1802
+ # not a good thing in your environment that Redis can reply from time to time
1803
+ # to queries with 2 milliseconds delay.
1804
+ #
1805
+ # use "activerehashing yes" if you don't have such hard requirements but
1806
+ # want to free memory asap when possible.
1807
+ activerehashing yes
1808
+
1809
+ # The client output buffer limits can be used to force disconnection of clients
1810
+ # that are not reading data from the server fast enough for some reason (a
1811
+ # common reason is that a Pub/Sub client can't consume messages as fast as the
1812
+ # publisher can produce them).
1813
+ #
1814
+ # The limit can be set differently for the three different classes of clients:
1815
+ #
1816
+ # normal -> normal clients including MONITOR clients
1817
+ # replica -> replica clients
1818
+ # pubsub -> clients subscribed to at least one pubsub channel or pattern
1819
+ #
1820
+ # The syntax of every client-output-buffer-limit directive is the following:
1821
+ #
1822
+ # client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
1823
+ #
1824
+ # A client is immediately disconnected once the hard limit is reached, or if
1825
+ # the soft limit is reached and remains reached for the specified number of
1826
+ # seconds (continuously).
1827
+ # So for instance if the hard limit is 32 megabytes and the soft limit is
1828
+ # 16 megabytes / 10 seconds, the client will get disconnected immediately
1829
+ # if the size of the output buffers reach 32 megabytes, but will also get
1830
+ # disconnected if the client reaches 16 megabytes and continuously overcomes
1831
+ # the limit for 10 seconds.
1832
+ #
1833
+ # By default normal clients are not limited because they don't receive data
1834
+ # without asking (in a push way), but just after a request, so only
1835
+ # asynchronous clients may create a scenario where data is requested faster
1836
+ # than it can read.
1837
+ #
1838
+ # Instead there is a default limit for pubsub and replica clients, since
1839
+ # subscribers and replicas receive data in a push fashion.
1840
+ #
1841
+ # Both the hard or the soft limit can be disabled by setting them to zero.
1842
+ client-output-buffer-limit normal 0 0 0
1843
+ client-output-buffer-limit replica 256mb 64mb 60
1844
+ client-output-buffer-limit pubsub 32mb 8mb 60
1845
+
1846
+ # Client query buffers accumulate new commands. They are limited to a fixed
1847
+ # amount by default in order to avoid that a protocol desynchronization (for
1848
+ # instance due to a bug in the client) will lead to unbound memory usage in
1849
+ # the query buffer. However you can configure it here if you have very special
1850
+ # needs, such us huge multi/exec requests or alike.
1851
+ #
1852
+ # client-query-buffer-limit 1gb
1853
+
1854
+ # In the Redis protocol, bulk requests, that are, elements representing single
1855
+ # strings, are normally limited to 512 mb. However you can change this limit
1856
+ # here, but must be 1mb or greater
1857
+ #
1858
+ # proto-max-bulk-len 512mb
1859
+
1860
+ # Redis calls an internal function to perform many background tasks, like
1861
+ # closing connections of clients in timeout, purging expired keys that are
1862
+ # never requested, and so forth.
1863
+ #
1864
+ # Not all tasks are performed with the same frequency, but Redis checks for
1865
+ # tasks to perform according to the specified "hz" value.
1866
+ #
1867
+ # By default "hz" is set to 10. Raising the value will use more CPU when
1868
+ # Redis is idle, but at the same time will make Redis more responsive when
1869
+ # there are many keys expiring at the same time, and timeouts may be
1870
+ # handled with more precision.
1871
+ #
1872
+ # The range is between 1 and 500, however a value over 100 is usually not
1873
+ # a good idea. Most users should use the default of 10 and raise this up to
1874
+ # 100 only in environments where very low latency is required.
1875
+ hz 10
1876
+
1877
+ # Normally it is useful to have an HZ value which is proportional to the
1878
+ # number of clients connected. This is useful in order, for instance, to
1879
+ # avoid too many clients are processed for each background task invocation
1880
+ # in order to avoid latency spikes.
1881
+ #
1882
+ # Since the default HZ value by default is conservatively set to 10, Redis
1883
+ # offers, and enables by default, the ability to use an adaptive HZ value
1884
+ # which will temporarily raise when there are many connected clients.
1885
+ #
1886
+ # When dynamic HZ is enabled, the actual configured HZ will be used
1887
+ # as a baseline, but multiples of the configured HZ value will be actually
1888
+ # used as needed once more clients are connected. In this way an idle
1889
+ # instance will use very little CPU time while a busy instance will be
1890
+ # more responsive.
1891
+ dynamic-hz yes
1892
+
1893
+ # When a child rewrites the AOF file, if the following option is enabled
1894
+ # the file will be fsync-ed every 32 MB of data generated. This is useful
1895
+ # in order to commit the file to the disk more incrementally and avoid
1896
+ # big latency spikes.
1897
+ aof-rewrite-incremental-fsync yes
1898
+
1899
+ # When redis saves RDB file, if the following option is enabled
1900
+ # the file will be fsync-ed every 32 MB of data generated. This is useful
1901
+ # in order to commit the file to the disk more incrementally and avoid
1902
+ # big latency spikes.
1903
+ rdb-save-incremental-fsync yes
1904
+
1905
+ # Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good
1906
+ # idea to start with the default settings and only change them after investigating
1907
+ # how to improve the performances and how the keys LFU change over time, which
1908
+ # is possible to inspect via the OBJECT FREQ command.
1909
+ #
1910
+ # There are two tunable parameters in the Redis LFU implementation: the
1911
+ # counter logarithm factor and the counter decay time. It is important to
1912
+ # understand what the two parameters mean before changing them.
1913
+ #
1914
+ # The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis
1915
+ # uses a probabilistic increment with logarithmic behavior. Given the value
1916
+ # of the old counter, when a key is accessed, the counter is incremented in
1917
+ # this way:
1918
+ #
1919
+ # 1. A random number R between 0 and 1 is extracted.
1920
+ # 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1).
1921
+ # 3. The counter is incremented only if R < P.
1922
+ #
1923
+ # The default lfu-log-factor is 10. This is a table of how the frequency
1924
+ # counter changes with a different number of accesses with different
1925
+ # logarithmic factors:
1926
+ #
1927
+ # +--------+------------+------------+------------+------------+------------+
1928
+ # | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits |
1929
+ # +--------+------------+------------+------------+------------+------------+
1930
+ # | 0 | 104 | 255 | 255 | 255 | 255 |
1931
+ # +--------+------------+------------+------------+------------+------------+
1932
+ # | 1 | 18 | 49 | 255 | 255 | 255 |
1933
+ # +--------+------------+------------+------------+------------+------------+
1934
+ # | 10 | 10 | 18 | 142 | 255 | 255 |
1935
+ # +--------+------------+------------+------------+------------+------------+
1936
+ # | 100 | 8 | 11 | 49 | 143 | 255 |
1937
+ # +--------+------------+------------+------------+------------+------------+
1938
+ #
1939
+ # NOTE: The above table was obtained by running the following commands:
1940
+ #
1941
+ # redis-benchmark -n 1000000 incr foo
1942
+ # redis-cli object freq foo
1943
+ #
1944
+ # NOTE 2: The counter initial value is 5 in order to give new objects a chance
1945
+ # to accumulate hits.
1946
+ #
1947
+ # The counter decay time is the time, in minutes, that must elapse in order
1948
+ # for the key counter to be divided by two (or decremented if it has a value
1949
+ # less <= 10).
1950
+ #
1951
+ # The default value for the lfu-decay-time is 1. A special value of 0 means to
1952
+ # decay the counter every time it happens to be scanned.
1953
+ #
1954
+ # lfu-log-factor 10
1955
+ # lfu-decay-time 1
1956
+
1957
+ ########################### ACTIVE DEFRAGMENTATION #######################
1958
+ #
1959
+ # What is active defragmentation?
1960
+ # -------------------------------
1961
+ #
1962
+ # Active (online) defragmentation allows a Redis server to compact the
1963
+ # spaces left between small allocations and deallocations of data in memory,
1964
+ # thus allowing to reclaim back memory.
1965
+ #
1966
+ # Fragmentation is a natural process that happens with every allocator (but
1967
+ # less so with Jemalloc, fortunately) and certain workloads. Normally a server
1968
+ # restart is needed in order to lower the fragmentation, or at least to flush
1969
+ # away all the data and create it again. However thanks to this feature
1970
+ # implemented by Oran Agra for Redis 4.0 this process can happen at runtime
1971
+ # in a "hot" way, while the server is running.
1972
+ #
1973
+ # Basically when the fragmentation is over a certain level (see the
1974
+ # configuration options below) Redis will start to create new copies of the
1975
+ # values in contiguous memory regions by exploiting certain specific Jemalloc
1976
+ # features (in order to understand if an allocation is causing fragmentation
1977
+ # and to allocate it in a better place), and at the same time, will release the
1978
+ # old copies of the data. This process, repeated incrementally for all the keys
1979
+ # will cause the fragmentation to drop back to normal values.
1980
+ #
1981
+ # Important things to understand:
1982
+ #
1983
+ # 1. This feature is disabled by default, and only works if you compiled Redis
1984
+ # to use the copy of Jemalloc we ship with the source code of Redis.
1985
+ # This is the default with Linux builds.
1986
+ #
1987
+ # 2. You never need to enable this feature if you don't have fragmentation
1988
+ # issues.
1989
+ #
1990
+ # 3. Once you experience fragmentation, you can enable this feature when
1991
+ # needed with the command "CONFIG SET activedefrag yes".
1992
+ #
1993
+ # The configuration parameters are able to fine tune the behavior of the
1994
+ # defragmentation process. If you are not sure about what they mean it is
1995
+ # a good idea to leave the defaults untouched.
1996
+
1997
+ # Enabled active defragmentation
1998
+ # activedefrag no
1999
+
2000
+ # Minimum amount of fragmentation waste to start active defrag
2001
+ # active-defrag-ignore-bytes 100mb
2002
+
2003
+ # Minimum percentage of fragmentation to start active defrag
2004
+ # active-defrag-threshold-lower 10
2005
+
2006
+ # Maximum percentage of fragmentation at which we use maximum effort
2007
+ # active-defrag-threshold-upper 100
2008
+
2009
+ # Minimal effort for defrag in CPU percentage, to be used when the lower
2010
+ # threshold is reached
2011
+ # active-defrag-cycle-min 1
2012
+
2013
+ # Maximal effort for defrag in CPU percentage, to be used when the upper
2014
+ # threshold is reached
2015
+ # active-defrag-cycle-max 25
2016
+
2017
+ # Maximum number of set/hash/zset/list fields that will be processed from
2018
+ # the main dictionary scan
2019
+ # active-defrag-max-scan-fields 1000
2020
+
2021
+ # Jemalloc background thread for purging will be enabled by default
2022
+ jemalloc-bg-thread yes
2023
+
2024
+ # It is possible to pin different threads and processes of Redis to specific
2025
+ # CPUs in your system, in order to maximize the performances of the server.
2026
+ # This is useful both in order to pin different Redis threads in different
2027
+ # CPUs, but also in order to make sure that multiple Redis instances running
2028
+ # in the same host will be pinned to different CPUs.
2029
+ #
2030
+ # Normally you can do this using the "taskset" command, however it is also
2031
+ # possible to this via Redis configuration directly, both in Linux and FreeBSD.
2032
+ #
2033
+ # You can pin the server/IO threads, bio threads, aof rewrite child process, and
2034
+ # the bgsave child process. The syntax to specify the cpu list is the same as
2035
+ # the taskset command:
2036
+ #
2037
+ # Set redis server/io threads to cpu affinity 0,2,4,6:
2038
+ # server_cpulist 0-7:2
2039
+ #
2040
+ # Set bio threads to cpu affinity 1,3:
2041
+ # bio_cpulist 1,3
2042
+ #
2043
+ # Set aof rewrite child process to cpu affinity 8,9,10,11:
2044
+ # aof_rewrite_cpulist 8-11
2045
+ #
2046
+ # Set bgsave child process to cpu affinity 1,10,11
2047
+ # bgsave_cpulist 1,10-11
2048
+
2049
+ # In some cases redis will emit warnings and even refuse to start if it detects
2050
+ # that the system is in bad state, it is possible to suppress these warnings
2051
+ # by setting the following config which takes a space delimited list of warnings
2052
+ # to suppress
2053
+ #
2054
+ # ignore-warnings ARM64-COW-BUG