redis.windows-service.conf 60 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336
  1. # Redis configuration file example
  2. # Note on units: when memory size is needed, it is possible to specify
  3. # it in the usual form of 1k 5GB 4M and so forth:
  4. #
  5. # 1k => 1000 bytes
  6. # 1kb => 1024 bytes
  7. # 1m => 1000000 bytes
  8. # 1mb => 1024*1024 bytes
  9. # 1g => 1000000000 bytes
  10. # 1gb => 1024*1024*1024 bytes
  11. #
  12. # units are case insensitive so 1GB 1Gb 1gB are all the same.
  13. ################################## INCLUDES ###################################
  14. # Include one or more other config files here. This is useful if you
  15. # have a standard template that goes to all Redis servers but also need
  16. # to customize a few per-server settings. Include files can include
  17. # other files, so use this wisely.
  18. #
  19. # Notice option "include" won't be rewritten by command "CONFIG REWRITE"
  20. # from admin or Redis Sentinel. Since Redis always uses the last processed
  21. # line as value of a configuration directive, you'd better put includes
  22. # at the beginning of this file to avoid overwriting config change at runtime.
  23. #
  24. # If instead you are interested in using includes to override configuration
  25. # options, it is better to use include as the last line.
  26. #
  27. # include .\path\to\local.conf
  28. # include c:\path\to\other.conf
  29. ################################## MODULES #####################################
  30. # Load modules at startup. If the server is not able to load modules
  31. # it will abort. It is possible to use multiple loadmodule directives.
  32. #
  33. # loadmodule .\path\to\my_module.dll
  34. # loadmodule c:\path\to\other_module.dll
  35. ################################## NETWORK #####################################
  36. # By default, if no "bind" configuration directive is specified, Redis listens
  37. # for connections from all the network interfaces available on the server.
  38. # It is possible to listen to just one or multiple selected interfaces using
  39. # the "bind" configuration directive, followed by one or more IP addresses.
  40. #
  41. # Examples:
  42. #
  43. # bind 192.168.1.100 10.0.0.1
  44. # bind 127.0.0.1 ::1
  45. #
  46. # ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the
  47. # internet, binding to all the interfaces is dangerous and will expose the
  48. # instance to everybody on the internet. So by default we uncomment the
  49. # following bind directive, that will force Redis to listen only into
  50. # the IPv4 loopback interface address (this means Redis will be able to
  51. # accept connections only from clients running into the same computer it
  52. # is running).
  53. #
  54. # IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES
  55. # JUST COMMENT THE FOLLOWING LINE.
  56. # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  57. bind 127.0.0.1
  58. # Protected mode is a layer of security protection, in order to avoid that
  59. # Redis instances left open on the internet are accessed and exploited.
  60. #
  61. # When protected mode is on and if:
  62. #
  63. # 1) The server is not binding explicitly to a set of addresses using the
  64. # "bind" directive.
  65. # 2) No password is configured.
  66. #
  67. # The server only accepts connections from clients connecting from the
  68. # IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain
  69. # sockets.
  70. #
  71. # By default protected mode is enabled. You should disable it only if
  72. # you are sure you want clients from other hosts to connect to Redis
  73. # even if no authentication is configured, nor a specific set of interfaces
  74. # are explicitly listed using the "bind" directive.
  75. protected-mode yes
  76. # Accept connections on the specified port, default is 6379 (IANA #815344).
  77. # If port 0 is specified Redis will not listen on a TCP socket.
  78. port 6379
  79. # TCP listen() backlog.
  80. #
  81. # In high requests-per-second environments you need an high backlog in order
  82. # to avoid slow clients connections issues. Note that the Linux kernel
  83. # will silently truncate it to the value of /proc/sys/net/core/somaxconn so
  84. # make sure to raise both the value of somaxconn and tcp_max_syn_backlog
  85. # in order to get the desired effect.
  86. tcp-backlog 511
  87. # Unix socket.
  88. #
  89. # Specify the path for the Unix socket that will be used to listen for
  90. # incoming connections. There is no default, so Redis will not listen
  91. # on a unix socket when not specified.
  92. #
  93. # unixsocket /tmp/redis.sock
  94. # unixsocketperm 700
  95. # Close the connection after a client is idle for N seconds (0 to disable)
  96. timeout 0
  97. # TCP keepalive.
  98. #
  99. # If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
  100. # of communication. This is useful for two reasons:
  101. #
  102. # 1) Detect dead peers.
  103. # 2) Take the connection alive from the point of view of network
  104. # equipment in the middle.
  105. #
  106. # On Linux, the specified value (in seconds) is the period used to send ACKs.
  107. # Note that to close the connection the double of the time is needed.
  108. # On other kernels the period depends on the kernel configuration.
  109. #
  110. # A reasonable value for this option is 300 seconds, which is the new
  111. # Redis default starting with Redis 3.2.1.
  112. tcp-keepalive 300
  113. ################################# GENERAL #####################################
  114. # By default Redis does not run as a daemon. Use 'yes' if you need it.
  115. # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
  116. # NOT SUPPORTED ON WINDOWS daemonize no
  117. # If you run Redis from upstart or systemd, Redis can interact with your
  118. # supervision tree. Options:
  119. # supervised no - no supervision interaction
  120. # supervised upstart - signal upstart by putting Redis into SIGSTOP mode
  121. # supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET
  122. # supervised auto - detect upstart or systemd method based on
  123. # UPSTART_JOB or NOTIFY_SOCKET environment variables
  124. # Note: these supervision methods only signal "process is ready."
  125. # They do not enable continuous liveness pings back to your supervisor.
  126. # NOT SUPPORTED ON WINDOWS supervised no
  127. # If a pid file is specified, Redis writes it where specified at startup
  128. # and removes it at exit.
  129. #
  130. # When the server runs non daemonized, no pid file is created if none is
  131. # specified in the configuration. When the server is daemonized, the pid file
  132. # is used even if not specified, defaulting to "/var/run/redis.pid".
  133. #
  134. # Creating a pid file is best effort: if Redis is not able to create it
  135. # nothing bad happens, the server will start and run normally.
  136. # NOT SUPPORTED ON WINDOWS pidfile /var/run/redis.pid
  137. # Specify the server verbosity level.
  138. # This can be one of:
  139. # debug (a lot of information, useful for development/testing)
  140. # verbose (many rarely useful info, but not a mess like the debug level)
  141. # notice (moderately verbose, what you want in production probably)
  142. # warning (only very important / critical messages are logged)
  143. loglevel notice
  144. # Specify the log file name. Also 'stdout' can be used to force
  145. # Redis to log on the standard output.
  146. logfile "server_log.txt"
  147. # To enable logging to the Windows EventLog, just set 'syslog-enabled' to
  148. # yes, and optionally update the other syslog parameters to suit your needs.
  149. # If Redis is installed and launched as a Windows Service, this will
  150. # automatically be enabled.
  151. syslog-enabled yes
  152. # Specify the source name of the events in the Windows Application log.
  153. syslog-ident redis
  154. # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
  155. # NOT SUPPORTED ON WINDOWS syslog-facility local0
  156. # Set the number of databases. The default database is DB 0, you can select
  157. # a different one on a per-connection basis using SELECT <dbid> where
  158. # dbid is a number between 0 and 'databases'-1
  159. databases 16
  160. # By default Redis shows an ASCII art logo only when started to log to the
  161. # standard output and if the standard output is a TTY. Basically this means
  162. # that normally a logo is displayed only in interactive sessions.
  163. #
  164. # However it is possible to force the pre-4.0 behavior and always show a
  165. # ASCII art logo in startup logs by setting the following option to yes.
  166. always-show-logo yes
  167. ################################ SNAPSHOTTING ################################
  168. #
  169. # Save the DB on disk:
  170. #
  171. # save <seconds> <changes>
  172. #
  173. # Will save the DB if both the given number of seconds and the given
  174. # number of write operations against the DB occurred.
  175. #
  176. # In the example below the behaviour will be to save:
  177. # after 900 sec (15 min) if at least 1 key changed
  178. # after 300 sec (5 min) if at least 10 keys changed
  179. # after 60 sec if at least 10000 keys changed
  180. #
  181. # Note: you can disable saving completely by commenting out all "save" lines.
  182. #
  183. # It is also possible to remove all the previously configured save
  184. # points by adding a save directive with a single empty string argument
  185. # like in the following example:
  186. #
  187. # save ""
  188. save 900 1
  189. save 300 10
  190. save 60 10000
  191. # By default Redis will stop accepting writes if RDB snapshots are enabled
  192. # (at least one save point) and the latest background save failed.
  193. # This will make the user aware (in a hard way) that data is not persisting
  194. # on disk properly, otherwise chances are that no one will notice and some
  195. # disaster will happen.
  196. #
  197. # If the background saving process will start working again Redis will
  198. # automatically allow writes again.
  199. #
  200. # However if you have setup your proper monitoring of the Redis server
  201. # and persistence, you may want to disable this feature so that Redis will
  202. # continue to work as usual even if there are problems with disk,
  203. # permissions, and so forth.
  204. stop-writes-on-bgsave-error yes
  205. # Compress string objects using LZF when dump .rdb databases?
  206. # For default that's set to 'yes' as it's almost always a win.
  207. # If you want to save some CPU in the saving child set it to 'no' but
  208. # the dataset will likely be bigger if you have compressible values or keys.
  209. rdbcompression yes
  210. # Since version 5 of RDB a CRC64 checksum is placed at the end of the file.
  211. # This makes the format more resistant to corruption but there is a performance
  212. # hit to pay (around 10%) when saving and loading RDB files, so you can disable it
  213. # for maximum performances.
  214. #
  215. # RDB files created with checksum disabled have a checksum of zero that will
  216. # tell the loading code to skip the check.
  217. rdbchecksum yes
  218. # The filename where to dump the DB
  219. dbfilename dump.rdb
  220. # The working directory.
  221. #
  222. # The DB will be written inside this directory, with the filename specified
  223. # above using the 'dbfilename' configuration directive.
  224. #
  225. # The Append Only File will also be created inside this directory.
  226. #
  227. # Note that you must specify a directory here, not a file name.
  228. dir ./
  229. ################################# REPLICATION #################################
  230. # Master-Replica replication. Use replicaof to make a Redis instance a copy of
  231. # another Redis server. A few things to understand ASAP about Redis replication.
  232. #
  233. # +------------------+ +---------------+
  234. # | Master | ---> | Replica |
  235. # | (receive writes) | | (exact copy) |
  236. # +------------------+ +---------------+
  237. #
  238. # 1) Redis replication is asynchronous, but you can configure a master to
  239. # stop accepting writes if it appears to be not connected with at least
  240. # a given number of replicas.
  241. # 2) Redis replicas are able to perform a partial resynchronization with the
  242. # master if the replication link is lost for a relatively small amount of
  243. # time. You may want to configure the replication backlog size (see the next
  244. # sections of this file) with a sensible value depending on your needs.
  245. # 3) Replication is automatic and does not need user intervention. After a
  246. # network partition replicas automatically try to reconnect to masters
  247. # and resynchronize with them.
  248. #
  249. # replicaof <masterip> <masterport>
  250. # If the master is password protected (using the "requirepass" configuration
  251. # directive below) it is possible to tell the replica to authenticate before
  252. # starting the replication synchronization process, otherwise the master will
  253. # refuse the replica request.
  254. #
  255. # masterauth <master-password>
  256. # When a replica loses its connection with the master, or when the replication
  257. # is still in progress, the replica can act in two different ways:
  258. #
  259. # 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will
  260. # still reply to client requests, possibly with out of date data, or the
  261. # data set may just be empty if this is the first synchronization.
  262. #
  263. # 2) if replica-serve-stale-data is set to 'no' the replica will reply with
  264. # an error "SYNC with master in progress" to all the kind of commands
  265. # but to INFO, replicaOF, AUTH, PING, SHUTDOWN, REPLCONF, ROLE, CONFIG,
  266. # SUBSCRIBE, UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB,
  267. # COMMAND, POST, HOST: and LATENCY.
  268. #
  269. replica-serve-stale-data yes
  270. # You can configure a replica instance to accept writes or not. Writing against
  271. # a replica instance may be useful to store some ephemeral data (because data
  272. # written on a replica will be easily deleted after resync with the master) but
  273. # may also cause problems if clients are writing to it because of a
  274. # misconfiguration.
  275. #
  276. # Since Redis 2.6 by default replicas are read-only.
  277. #
  278. # Note: read only replicas are not designed to be exposed to untrusted clients
  279. # on the internet. It's just a protection layer against misuse of the instance.
  280. # Still a read only replica exports by default all the administrative commands
  281. # such as CONFIG, DEBUG, and so forth. To a limited extent you can improve
  282. # security of read only replicas using 'rename-command' to shadow all the
  283. # administrative / dangerous commands.
  284. replica-read-only yes
  285. # Replication SYNC strategy: disk or socket.
  286. #
  287. # -------------------------------------------------------
  288. # WARNING: DISKLESS REPLICATION IS EXPERIMENTAL CURRENTLY
  289. # -------------------------------------------------------
  290. #
  291. # New replicas and reconnecting replicas that are not able to continue the replication
  292. # process just receiving differences, need to do what is called a "full
  293. # synchronization". An RDB file is transmitted from the master to the replicas.
  294. # The transmission can happen in two different ways:
  295. #
  296. # 1) Disk-backed: The Redis master creates a new process that writes the RDB
  297. # file on disk. Later the file is transferred by the parent
  298. # process to the replicas incrementally.
  299. # 2) Diskless: The Redis master creates a new process that directly writes the
  300. # RDB file to replica sockets, without touching the disk at all.
  301. #
  302. # With disk-backed replication, while the RDB file is generated, more replicas
  303. # can be queued and served with the RDB file as soon as the current child producing
  304. # the RDB file finishes its work. With diskless replication instead once
  305. # the transfer starts, new replicas arriving will be queued and a new transfer
  306. # will start when the current one terminates.
  307. #
  308. # When diskless replication is used, the master waits a configurable amount of
  309. # time (in seconds) before starting the transfer in the hope that multiple replicas
  310. # will arrive and the transfer can be parallelized.
  311. #
  312. # With slow disks and fast (large bandwidth) networks, diskless replication
  313. # works better.
  314. repl-diskless-sync no
  315. # When diskless replication is enabled, it is possible to configure the delay
  316. # the server waits in order to spawn the child that transfers the RDB via socket
  317. # to the replicas.
  318. #
  319. # This is important since once the transfer starts, it is not possible to serve
  320. # new replicas arriving, that will be queued for the next RDB transfer, so the server
  321. # waits a delay in order to let more replicas arrive.
  322. #
  323. # The delay is specified in seconds, and by default is 5 seconds. To disable
  324. # it entirely just set it to 0 seconds and the transfer will start ASAP.
  325. repl-diskless-sync-delay 5
  326. # Replicas send PINGs to server in a predefined interval. It's possible to change
  327. # this interval with the repl_ping_replica_period option. The default value is 10
  328. # seconds.
  329. #
  330. # repl-ping-replica-period 10
  331. # The following option sets the replication timeout for:
  332. #
  333. # 1) Bulk transfer I/O during SYNC, from the point of view of replica.
  334. # 2) Master timeout from the point of view of replicas (data, pings).
  335. # 3) Replica timeout from the point of view of masters (REPLCONF ACK pings).
  336. #
  337. # It is important to make sure that this value is greater than the value
  338. # specified for repl-ping-replica-period otherwise a timeout will be detected
  339. # every time there is low traffic between the master and the replica.
  340. #
  341. # repl-timeout 60
  342. # Disable TCP_NODELAY on the replica socket after SYNC?
  343. #
  344. # If you select "yes" Redis will use a smaller number of TCP packets and
  345. # less bandwidth to send data to replicas. But this can add a delay for
  346. # the data to appear on the replica side, up to 40 milliseconds with
  347. # Linux kernels using a default configuration.
  348. #
  349. # If you select "no" the delay for data to appear on the replica side will
  350. # be reduced but more bandwidth will be used for replication.
  351. #
  352. # By default we optimize for low latency, but in very high traffic conditions
  353. # or when the master and replicas are many hops away, turning this to "yes" may
  354. # be a good idea.
  355. repl-disable-tcp-nodelay no
  356. # Set the replication backlog size. The backlog is a buffer that accumulates
  357. # replica data when replicas are disconnected for some time, so that when a replica
  358. # wants to reconnect again, often a full resync is not needed, but a partial
  359. # resync is enough, just passing the portion of data the replica missed while
  360. # disconnected.
  361. #
  362. # The bigger the replication backlog, the longer the time the replica can be
  363. # disconnected and later be able to perform a partial resynchronization.
  364. #
  365. # The backlog is only allocated once there is at least a replica connected.
  366. #
  367. # repl-backlog-size 1mb
  368. # After a master has no longer connected replicas for some time, the backlog
  369. # will be freed. The following option configures the amount of seconds that
  370. # need to elapse, starting from the time the last replica disconnected, for
  371. # the backlog buffer to be freed.
  372. #
  373. # Note that replicas never free the backlog for timeout, since they may be
  374. # promoted to masters later, and should be able to correctly "partially
  375. # resynchronize" with the replicas: hence they should always accumulate backlog.
  376. #
  377. # A value of 0 means to never release the backlog.
  378. #
  379. # repl-backlog-ttl 3600
  380. # The replica priority is an integer number published by Redis in the INFO output.
  381. # It is used by Redis Sentinel in order to select a replica to promote into a
  382. # master if the master is no longer working correctly.
  383. #
  384. # A replica with a low priority number is considered better for promotion, so
  385. # for instance if there are three replicas with priority 10, 100, 25 Sentinel will
  386. # pick the one with priority 10, that is the lowest.
  387. #
  388. # However a special priority of 0 marks the replica as not able to perform the
  389. # role of master, so a replica with priority of 0 will never be selected by
  390. # Redis Sentinel for promotion.
  391. #
  392. # By default the priority is 100.
  393. replica-priority 100
  394. # It is possible for a master to stop accepting writes if there are less than
  395. # N replicas connected, having a lag less or equal than M seconds.
  396. #
  397. # The N replicas need to be in "online" state.
  398. #
  399. # The lag in seconds, that must be <= the specified value, is calculated from
  400. # the last ping received from the replica, that is usually sent every second.
  401. #
  402. # This option does not GUARANTEE that N replicas will accept the write, but
  403. # will limit the window of exposure for lost writes in case not enough replicas
  404. # are available, to the specified number of seconds.
  405. #
  406. # For example to require at least 3 replicas with a lag <= 10 seconds use:
  407. #
  408. # min-replicas-to-write 3
  409. # min-replicas-max-lag 10
  410. #
  411. # Setting one or the other to 0 disables the feature.
  412. #
  413. # By default min-replicas-to-write is set to 0 (feature disabled) and
  414. # min-replicas-max-lag is set to 10.
  415. # A Redis master is able to list the address and port of the attached
  416. # replicas in different ways. For example the "INFO replication" section
  417. # offers this information, which is used, among other tools, by
  418. # Redis Sentinel in order to discover replica instances.
  419. # Another place where this info is available is in the output of the
  420. # "ROLE" command of a master.
  421. #
  422. # The listed IP and address normally reported by a replica is obtained
  423. # in the following way:
  424. #
  425. # IP: The address is auto detected by checking the peer address
  426. # of the socket used by the replica to connect with the master.
  427. #
  428. # Port: The port is communicated by the replica during the replication
  429. # handshake, and is normally the port that the replica is using to
  430. # listen for connections.
  431. #
  432. # However when port forwarding or Network Address Translation (NAT) is
  433. # used, the replica may be actually reachable via different IP and port
  434. # pairs. The following two options can be used by a replica in order to
  435. # report to its master a specific set of IP and port, so that both INFO
  436. # and ROLE will report those values.
  437. #
  438. # There is no need to use both the options if you need to override just
  439. # the port or the IP address.
  440. #
  441. # replica-announce-ip 5.5.5.5
  442. # replica-announce-port 1234
  443. ################################## SECURITY ###################################
  444. # Require clients to issue AUTH <PASSWORD> before processing any other
  445. # commands. This might be useful in environments in which you do not trust
  446. # others with access to the host running redis-server.
  447. #
  448. # This should stay commented out for backward compatibility and because most
  449. # people do not need auth (e.g. they run their own servers).
  450. #
  451. # Warning: since Redis is pretty fast an outside user can try up to
  452. # 150k passwords per second against a good box. This means that you should
  453. # use a very strong password otherwise it will be very easy to break.
  454. #
  455. # requirepass foobared
  456. # Command renaming.
  457. #
  458. # It is possible to change the name of dangerous commands in a shared
  459. # environment. For instance the CONFIG command may be renamed into something
  460. # hard to guess so that it will still be available for internal-use tools
  461. # but not available for general clients.
  462. #
  463. # Example:
  464. #
  465. # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
  466. #
  467. # It is also possible to completely kill a command by renaming it into
  468. # an empty string:
  469. #
  470. # rename-command CONFIG ""
  471. #
  472. # Please note that changing the name of commands that are logged into the
  473. # AOF file or transmitted to replicas may cause problems.
  474. ################################### CLIENTS ####################################
  475. # Set the max number of connected clients at the same time. By default
  476. # this limit is set to 10000 clients, however if the Redis server is not
  477. # able to configure the process file limit to allow for the specified limit
  478. # the max number of allowed clients is set to the current file limit
  479. # minus 32 (as Redis reserves a few file descriptors for internal uses).
  480. #
  481. # Once the limit is reached Redis will close all the new connections sending
  482. # an error 'max number of clients reached'.
  483. #
  484. # maxclients 10000
  485. ############################## MEMORY MANAGEMENT ################################
  486. # If Redis is to be used as an in-memory-only cache without any kind of
  487. # persistence, then the fork() mechanism used by the background AOF/RDB
  488. # persistence is unnecessary. As an optimization, all persistence can be
  489. # turned off in the Windows version of Redis. This will redirect heap
  490. # allocations to the system heap allocator, and disable commands that would
  491. # otherwise cause fork() operations: BGSAVE and BGREWRITEAOF.
  492. # This flag may not be combined with any of the other flags that configure
  493. # AOF and RDB operations.
  494. # persistence-available [(yes)|no]
  495. # Set a memory usage limit to the specified amount of bytes.
  496. # When the memory limit is reached Redis will try to remove keys
  497. # according to the eviction policy selected (see maxmemory-policy).
  498. #
  499. # If Redis can't remove keys according to the policy, or if the policy is
  500. # set to 'noeviction', Redis will start to reply with errors to commands
  501. # that would use more memory, like SET, LPUSH, and so on, and will continue
  502. # to reply to read-only commands like GET.
  503. #
  504. # This option is usually useful when using Redis as an LRU or LFU cache, or to
  505. # set a hard memory limit for an instance (using the 'noeviction' policy).
  506. #
  507. # WARNING: If you have replicas attached to an instance with maxmemory on,
  508. # the size of the output buffers needed to feed the replicas are subtracted
  509. # from the used memory count, so that network problems / resyncs will
  510. # not trigger a loop where keys are evicted, and in turn the output
  511. # buffer of replicas is full with DELs of keys evicted triggering the deletion
  512. # of more keys, and so forth until the database is completely emptied.
  513. #
  514. # In short... if you have replicas attached it is suggested that you set a lower
  515. # limit for maxmemory so that there is some free RAM on the system for replica
  516. # output buffers (but this is not needed if the policy is 'noeviction').
  517. #
  518. # WARNING: not setting maxmemory will cause Redis to terminate with an
  519. # out-of-memory exception if the heap limit is reached.
  520. #
  521. # NOTE: since Redis uses the system paging file to allocate the heap memory,
  522. # the Working Set memory usage showed by the Windows Task Manager or by other
  523. # tools such as ProcessExplorer will not always be accurate. For example, right
  524. # after a background save of the RDB or the AOF files, the working set value
  525. # may drop significantly. In order to check the correct amount of memory used
  526. # by the redis-server to store the data, use the INFO client command. The INFO
  527. # command shows only the memory used to store the redis data, not the extra
  528. # memory used by the Windows process for its own requirements. Th3 extra amount
  529. # of memory not reported by the INFO command can be calculated subtracting the
  530. # Peak Working Set reported by the Windows Task Manager and the used_memory_peak
  531. # reported by the INFO command.
  532. #
  533. # maxmemory <bytes>
  534. # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
  535. # is reached. You can select among five behaviors:
  536. #
  537. # volatile-lru -> Evict using approximated LRU among the keys with an expire set.
  538. # allkeys-lru -> Evict any key using approximated LRU.
  539. # volatile-lfu -> Evict using approximated LFU among the keys with an expire set.
  540. # allkeys-lfu -> Evict any key using approximated LFU.
  541. # volatile-random -> Remove a random key among the ones with an expire set.
  542. # allkeys-random -> Remove a random key, any key.
  543. # volatile-ttl -> Remove the key with the nearest expire time (minor TTL)
  544. # noeviction -> Don't evict anything, just return an error on write operations.
  545. #
  546. # LRU means Least Recently Used
  547. # LFU means Least Frequently Used
  548. #
  549. # Both LRU, LFU and volatile-ttl are implemented using approximated
  550. # randomized algorithms.
  551. #
  552. # Note: with any of the above policies, Redis will return an error on write
  553. # operations, when there are no suitable keys for eviction.
  554. #
  555. # At the date of writing these commands are: set setnx setex append
  556. # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
  557. # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
  558. # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
  559. # getset mset msetnx exec sort
  560. #
  561. # The default is:
  562. #
  563. # maxmemory-policy noeviction
  564. # LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated
  565. # algorithms (in order to save memory), so you can tune it for speed or
  566. # accuracy. For default Redis will check five keys and pick the one that was
  567. # used less recently, you can change the sample size using the following
  568. # configuration directive.
  569. #
  570. # The default of 5 produces good enough results. 10 Approximates very closely
  571. # true LRU but costs more CPU. 3 is faster but not very accurate.
  572. #
  573. # maxmemory-samples 5
  574. # Starting from Redis 5, by default a replica will ignore its maxmemory setting
  575. # (unless it is promoted to master after a failover or manually). It means
  576. # that the eviction of keys will be just handled by the master, sending the
  577. # DEL commands to the replica as keys evict in the master side.
  578. #
  579. # This behavior ensures that masters and replicas stay consistent, and is usually
  580. # what you want, however if your replica is writable, or you want the replica to have
  581. # a different memory setting, and you are sure all the writes performed to the
  582. # replica are idempotent, then you may change this default (but be sure to understand
  583. # what you are doing).
  584. #
  585. # Note that since the replica by default does not evict, it may end using more
  586. # memory than the one set via maxmemory (there are certain buffers that may
  587. # be larger on the replica, or data structures may sometimes take more memory and so
  588. # forth). So make sure you monitor your replicas and make sure they have enough
  589. # memory to never hit a real out-of-memory condition before the master hits
  590. # the configured maxmemory setting.
  591. #
  592. # replica-ignore-maxmemory yes
  593. ############################# LAZY FREEING ####################################
  594. # Redis has two primitives to delete keys. One is called DEL and is a blocking
  595. # deletion of the object. It means that the server stops processing new commands
  596. # in order to reclaim all the memory associated with an object in a synchronous
  597. # way. If the key deleted is associated with a small object, the time needed
  598. # in order to execute the DEL command is very small and comparable to most other
  599. # O(1) or O(log_N) commands in Redis. However if the key is associated with an
  600. # aggregated value containing millions of elements, the server can block for
  601. # a long time (even seconds) in order to complete the operation.
  602. #
  603. # For the above reasons Redis also offers non blocking deletion primitives
  604. # such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and
  605. # FLUSHDB commands, in order to reclaim memory in background. Those commands
  606. # are executed in constant time. Another thread will incrementally free the
  607. # object in the background as fast as possible.
  608. #
  609. # DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled.
  610. # It's up to the design of the application to understand when it is a good
  611. # idea to use one or the other. However the Redis server sometimes has to
  612. # delete keys or flush the whole database as a side effect of other operations.
  613. # Specifically Redis deletes objects independently of a user call in the
  614. # following scenarios:
  615. #
  616. # 1) On eviction, because of the maxmemory and maxmemory policy configurations,
  617. # in order to make room for new data, without going over the specified
  618. # memory limit.
  619. # 2) Because of expire: when a key with an associated time to live (see the
  620. # EXPIRE command) must be deleted from memory.
  621. # 3) Because of a side effect of a command that stores data on a key that may
  622. # already exist. For example the RENAME command may delete the old key
  623. # content when it is replaced with another one. Similarly SUNIONSTORE
  624. # or SORT with STORE option may delete existing keys. The SET command
  625. # itself removes any old content of the specified key in order to replace
  626. # it with the specified string.
  627. # 4) During replication, when a replica performs a full resynchronization with
  628. # its master, the content of the whole database is removed in order to
  629. # load the RDB file just transferred.
  630. #
  631. # In all the above cases the default is to delete objects in a blocking way,
  632. # like if DEL was called. However you can configure each case specifically
  633. # in order to instead release memory in a non-blocking way like if UNLINK
  634. # was called, using the following configuration directives:
  635. lazyfree-lazy-eviction no
  636. lazyfree-lazy-expire no
  637. lazyfree-lazy-server-del no
  638. replica-lazy-flush no
  639. ############################## APPEND ONLY MODE ###############################
  640. # By default Redis asynchronously dumps the dataset on disk. This mode is
  641. # good enough in many applications, but an issue with the Redis process or
  642. # a power outage may result into a few minutes of writes lost (depending on
  643. # the configured save points).
  644. #
  645. # The Append Only File is an alternative persistence mode that provides
  646. # much better durability. For instance using the default data fsync policy
  647. # (see later in the config file) Redis can lose just one second of writes in a
  648. # dramatic event like a server power outage, or a single write if something
  649. # wrong with the Redis process itself happens, but the operating system is
  650. # still running correctly.
  651. #
  652. # AOF and RDB persistence can be enabled at the same time without problems.
  653. # If the AOF is enabled on startup Redis will load the AOF, that is the file
  654. # with the better durability guarantees.
  655. #
  656. # Please check http://redis.io/topics/persistence for more information.
  657. appendonly no
  658. # The name of the append only file (default: "appendonly.aof")
  659. appendfilename "appendonly.aof"
  660. # The fsync() call tells the Operating System to actually write data on disk
  661. # instead of waiting for more data in the output buffer. Some OS will really flush
  662. # data on disk, some other OS will just try to do it ASAP.
  663. #
  664. # Redis supports three different modes:
  665. #
  666. # no: don't fsync, just let the OS flush the data when it wants. Faster.
  667. # always: fsync after every write to the append only log. Slow, Safest.
  668. # everysec: fsync only one time every second. Compromise.
  669. #
  670. # The default is "everysec", as that's usually the right compromise between
  671. # speed and data safety. It's up to you to understand if you can relax this to
  672. # "no" that will let the operating system flush the output buffer when
  673. # it wants, for better performances (but if you can live with the idea of
  674. # some data loss consider the default persistence mode that's snapshotting),
  675. # or on the contrary, use "always" that's very slow but a bit safer than
  676. # everysec.
  677. #
  678. # More details please check the following article:
  679. # http://antirez.com/post/redis-persistence-demystified.html
  680. #
  681. # If unsure, use "everysec".
  682. # appendfsync always
  683. appendfsync everysec
  684. # appendfsync no
  685. # When the AOF fsync policy is set to always or everysec, and a background
  686. # saving process (a background save or AOF log background rewriting) is
  687. # performing a lot of I/O against the disk, in some Linux configurations
  688. # Redis may block too long on the fsync() call. Note that there is no fix for
  689. # this currently, as even performing fsync in a different thread will block
  690. # our synchronous write(2) call.
  691. #
  692. # In order to mitigate this problem it's possible to use the following option
  693. # that will prevent fsync() from being called in the main process while a
  694. # BGSAVE or BGREWRITEAOF is in progress.
  695. #
  696. # This means that while another child is saving, the durability of Redis is
  697. # the same as "appendfsync none". In practical terms, this means that it is
  698. # possible to lose up to 30 seconds of log in the worst scenario (with the
  699. # default Linux settings).
  700. #
  701. # If you have latency problems turn this to "yes". Otherwise leave it as
  702. # "no" that is the safest pick from the point of view of durability.
  703. no-appendfsync-on-rewrite no
  704. # Automatic rewrite of the append only file.
  705. # Redis is able to automatically rewrite the log file implicitly calling
  706. # BGREWRITEAOF when the AOF log size grows by the specified percentage.
  707. #
  708. # This is how it works: Redis remembers the size of the AOF file after the
  709. # latest rewrite (if no rewrite has happened since the restart, the size of
  710. # the AOF at startup is used).
  711. #
  712. # This base size is compared to the current size. If the current size is
  713. # bigger than the specified percentage, the rewrite is triggered. Also
  714. # you need to specify a minimal size for the AOF file to be rewritten, this
  715. # is useful to avoid rewriting the AOF file even if the percentage increase
  716. # is reached but it is still pretty small.
  717. #
  718. # Specify a percentage of zero in order to disable the automatic AOF
  719. # rewrite feature.
  720. auto-aof-rewrite-percentage 100
  721. auto-aof-rewrite-min-size 64mb
  722. # An AOF file may be found to be truncated at the end during the Redis
  723. # startup process, when the AOF data gets loaded back into memory.
  724. # This may happen when the system where Redis is running
  725. # crashes, especially when an ext4 filesystem is mounted without the
  726. # data=ordered option (however this can't happen when Redis itself
  727. # crashes or aborts but the operating system still works correctly).
  728. #
  729. # Redis can either exit with an error when this happens, or load as much
  730. # data as possible (the default now) and start if the AOF file is found
  731. # to be truncated at the end. The following option controls this behavior.
  732. #
  733. # If aof-load-truncated is set to yes, a truncated AOF file is loaded and
  734. # the Redis server starts emitting a log to inform the user of the event.
  735. # Otherwise if the option is set to no, the server aborts with an error
  736. # and refuses to start. When the option is set to no, the user requires
  737. # to fix the AOF file using the "redis-check-aof" utility before to restart
  738. # the server.
  739. #
  740. # Note that if the AOF file will be found to be corrupted in the middle
  741. # the server will still exit with an error. This option only applies when
  742. # Redis will try to read more data from the AOF file but not enough bytes
  743. # will be found.
  744. aof-load-truncated yes
  745. # When rewriting the AOF file, Redis is able to use an RDB preamble in the
  746. # AOF file for faster rewrites and recoveries. When this option is turned
  747. # on the rewritten AOF file is composed of two different stanzas:
  748. #
  749. # [RDB file][AOF tail]
  750. #
  751. # When loading Redis recognizes that the AOF file starts with the "REDIS"
  752. # string and loads the prefixed RDB file, and continues loading the AOF
  753. # tail.
  754. aof-use-rdb-preamble yes
  755. ################################ LUA SCRIPTING ###############################
  756. # Max execution time of a Lua script in milliseconds.
  757. #
  758. # If the maximum execution time is reached Redis will log that a script is
  759. # still in execution after the maximum allowed time and will start to
  760. # reply to queries with an error.
  761. #
  762. # When a long running script exceeds the maximum execution time only the
  763. # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
  764. # used to stop a script that did not yet called write commands. The second
  765. # is the only way to shut down the server in the case a write command was
  766. # already issued by the script but the user doesn't want to wait for the natural
  767. # termination of the script.
  768. #
  769. # Set it to 0 or a negative value for unlimited execution without warnings.
  770. lua-time-limit 5000
  771. ################################ REDIS CLUSTER ###############################
  772. # Normal Redis instances can't be part of a Redis Cluster; only nodes that are
  773. # started as cluster nodes can. In order to start a Redis instance as a
  774. # cluster node enable the cluster support uncommenting the following:
  775. #
  776. # cluster-enabled yes
  777. # Every cluster node has a cluster configuration file. This file is not
  778. # intended to be edited by hand. It is created and updated by Redis nodes.
  779. # Every Redis Cluster node requires a different cluster configuration file.
  780. # Make sure that instances running in the same system do not have
  781. # overlapping cluster configuration file names.
  782. #
  783. # cluster-config-file nodes-6379.conf
  784. # Cluster node timeout is the amount of milliseconds a node must be unreachable
  785. # for it to be considered in failure state.
  786. # Most other internal time limits are multiple of the node timeout.
  787. #
  788. # cluster-node-timeout 15000
  789. # A replica of a failing master will avoid to start a failover if its data
  790. # looks too old.
  791. #
  792. # There is no simple way for a replica to actually have an exact measure of
  793. # its "data age", so the following two checks are performed:
  794. #
  795. # 1) If there are multiple replicas able to failover, they exchange messages
  796. # in order to try to give an advantage to the replica with the best
  797. # replication offset (more data from the master processed).
  798. # Replicas will try to get their rank by offset, and apply to the start
  799. # of the failover a delay proportional to their rank.
  800. #
  801. # 2) Every single replica computes the time of the last interaction with
  802. # its master. This can be the last ping or command received (if the master
  803. # is still in the "connected" state), or the time that elapsed since the
  804. # disconnection with the master (if the replication link is currently down).
  805. # If the last interaction is too old, the replica will not try to failover
  806. # at all.
  807. #
  808. # The point "2" can be tuned by user. Specifically a replica will not perform
  809. # the failover if, since the last interaction with the master, the time
  810. # elapsed is greater than:
  811. #
  812. # (node-timeout * replica-validity-factor) + repl-ping-replica-period
  813. #
  814. # So for example if node-timeout is 30 seconds, and the replica-validity-factor
  815. # is 10, and assuming a default repl-ping-replica-period of 10 seconds, the
  816. # replica will not try to failover if it was not able to talk with the master
  817. # for longer than 310 seconds.
  818. #
  819. # A large replica-validity-factor may allow replicas with too old data to failover
  820. # a master, while a too small value may prevent the cluster from being able to
  821. # elect a replica at all.
  822. #
  823. # For maximum availability, it is possible to set the replica-validity-factor
  824. # to a value of 0, which means, that replicas will always try to failover the
  825. # master regardless of the last time they interacted with the master.
  826. # (However they'll always try to apply a delay proportional to their
  827. # offset rank).
  828. #
  829. # Zero is the only value able to guarantee that when all the partitions heal
  830. # the cluster will always be able to continue.
  831. #
  832. # cluster-replica-validity-factor 10
  833. # Cluster replicas are able to migrate to orphaned masters, that are masters
  834. # that are left without working replicas. This improves the cluster ability
  835. # to resist to failures as otherwise an orphaned master can't be failed over
  836. # in case of failure if it has no working replicas.
  837. #
  838. # Replicas migrate to orphaned masters only if there are still at least a
  839. # given number of other working replicas for their old master. This number
  840. # is the "migration barrier". A migration barrier of 1 means that a replica
  841. # will migrate only if there is at least 1 other working replica for its master
  842. # and so forth. It usually reflects the number of replicas you want for every
  843. # master in your cluster.
  844. #
  845. # Default is 1 (replicas migrate only if their masters remain with at least
  846. # one replica). To disable migration just set it to a very large value.
  847. # A value of 0 can be set but is useful only for debugging and dangerous
  848. # in production.
  849. #
  850. # cluster-migration-barrier 1
  851. # By default Redis Cluster nodes stop accepting queries if they detect there
  852. # is at least an hash slot uncovered (no available node is serving it).
  853. # This way if the cluster is partially down (for example a range of hash slots
  854. # are no longer covered) all the cluster becomes, eventually, unavailable.
  855. # It automatically returns available as soon as all the slots are covered again.
  856. #
  857. # However sometimes you want the subset of the cluster which is working,
  858. # to continue to accept queries for the part of the key space that is still
  859. # covered. In order to do so, just set the cluster-require-full-coverage
  860. # option to no.
  861. #
  862. # cluster-require-full-coverage yes
  863. # This option, when set to yes, prevents replicas from trying to failover its
  864. # master during master failures. However the master can still perform a
  865. # manual failover, if forced to do so.
  866. #
  867. # This is useful in different scenarios, especially in the case of multiple
  868. # data center operations, where we want one side to never be promoted if not
  869. # in the case of a total DC failure.
  870. #
  871. # cluster-replica-no-failover no
  872. # In order to setup your cluster make sure to read the documentation
  873. # available at http://redis.io web site.
  874. ########################## CLUSTER DOCKER/NAT support ########################
  875. # In certain deployments, Redis Cluster nodes address discovery fails, because
  876. # addresses are NAT-ted or because ports are forwarded (the typical case is
  877. # Docker and other containers).
  878. #
  879. # In order to make Redis Cluster working in such environments, a static
  880. # configuration where each node knows its public address is needed. The
  881. # following two options are used for this scope, and are:
  882. #
  883. # * cluster-announce-ip
  884. # * cluster-announce-port
  885. # * cluster-announce-bus-port
  886. #
  887. # Each instruct the node about its address, client port, and cluster message
  888. # bus port. The information is then published in the header of the bus packets
  889. # so that other nodes will be able to correctly map the address of the node
  890. # publishing the information.
  891. #
  892. # If the above options are not used, the normal Redis Cluster auto-detection
  893. # will be used instead.
  894. #
  895. # Note that when remapped, the bus port may not be at the fixed offset of
  896. # clients port + 10000, so you can specify any port and bus-port depending
  897. # on how they get remapped. If the bus-port is not set, a fixed offset of
  898. # 10000 will be used as usually.
  899. #
  900. # Example:
  901. #
  902. # cluster-announce-ip 10.1.1.5
  903. # cluster-announce-port 6379
  904. # cluster-announce-bus-port 6380
  905. ################################## SLOW LOG ###################################
  906. # The Redis Slow Log is a system to log queries that exceeded a specified
  907. # execution time. The execution time does not include the I/O operations
  908. # like talking with the client, sending the reply and so forth,
  909. # but just the time needed to actually execute the command (this is the only
  910. # stage of command execution where the thread is blocked and can not serve
  911. # other requests in the meantime).
  912. #
  913. # You can configure the slow log with two parameters: one tells Redis
  914. # what is the execution time, in microseconds, to exceed in order for the
  915. # command to get logged, and the other parameter is the length of the
  916. # slow log. When a new command is logged the oldest one is removed from the
  917. # queue of logged commands.
  918. # The following time is expressed in microseconds, so 1000000 is equivalent
  919. # to one second. Note that a negative number disables the slow log, while
  920. # a value of zero forces the logging of every command.
  921. slowlog-log-slower-than 10000
  922. # There is no limit to this length. Just be aware that it will consume memory.
  923. # You can reclaim memory used by the slow log with SLOWLOG RESET.
  924. slowlog-max-len 128
  925. ################################ LATENCY MONITOR ##############################
  926. # The Redis latency monitoring subsystem samples different operations
  927. # at runtime in order to collect data related to possible sources of
  928. # latency of a Redis instance.
  929. #
  930. # Via the LATENCY command this information is available to the user that can
  931. # print graphs and obtain reports.
  932. #
  933. # The system only logs operations that were performed in a time equal or
  934. # greater than the amount of milliseconds specified via the
  935. # latency-monitor-threshold configuration directive. When its value is set
  936. # to zero, the latency monitor is turned off.
  937. #
  938. # By default latency monitoring is disabled since it is mostly not needed
  939. # if you don't have latency issues, and collecting data has a performance
  940. # impact, that while very small, can be measured under big load. Latency
  941. # monitoring can easily be enabled at runtime using the command
  942. # "CONFIG SET latency-monitor-threshold <milliseconds>" if needed.
  943. latency-monitor-threshold 0
  944. ############################# EVENT NOTIFICATION ##############################
  945. # Redis can notify Pub/Sub clients about events happening in the key space.
  946. # This feature is documented at http://redis.io/topics/notifications
  947. #
  948. # For instance if keyspace events notification is enabled, and a client
  949. # performs a DEL operation on key "foo" stored in the Database 0, two
  950. # messages will be published via Pub/Sub:
  951. #
  952. # PUBLISH __keyspace@0__:foo del
  953. # PUBLISH __keyevent@0__:del foo
  954. #
  955. # It is possible to select the events that Redis will notify among a set
  956. # of classes. Every class is identified by a single character:
  957. #
  958. # K Keyspace events, published with __keyspace@<db>__ prefix.
  959. # E Keyevent events, published with __keyevent@<db>__ prefix.
  960. # g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
  961. # $ String commands
  962. # l List commands
  963. # s Set commands
  964. # h Hash commands
  965. # z Sorted set commands
  966. # x Expired events (events generated every time a key expires)
  967. # e Evicted events (events generated when a key is evicted for maxmemory)
  968. # A Alias for g$lshzxe, so that the "AKE" string means all the events.
  969. #
  970. # The "notify-keyspace-events" takes as argument a string that is composed
  971. # of zero or multiple characters. The empty string means that notifications
  972. # are disabled.
  973. #
  974. # Example: to enable list and generic events, from the point of view of the
  975. # event name, use:
  976. #
  977. # notify-keyspace-events Elg
  978. #
  979. # Example 2: to get the stream of the expired keys subscribing to channel
  980. # name __keyevent@0__:expired use:
  981. #
  982. # notify-keyspace-events Ex
  983. #
  984. # By default all notifications are disabled because most users don't need
  985. # this feature and the feature has some overhead. Note that if you don't
  986. # specify at least one of K or E, no events will be delivered.
  987. notify-keyspace-events ""
  988. ############################### ADVANCED CONFIG ###############################
  989. # Hashes are encoded using a memory efficient data structure when they have a
  990. # small number of entries, and the biggest entry does not exceed a given
  991. # threshold. These thresholds can be configured using the following directives.
  992. hash-max-ziplist-entries 512
  993. hash-max-ziplist-value 64
  994. # Lists are also encoded in a special way to save a lot of space.
  995. # The number of entries allowed per internal list node can be specified
  996. # as a fixed maximum size or a maximum number of elements.
  997. # For a fixed maximum size, use -5 through -1, meaning:
  998. # -5: max size: 64 Kb <-- not recommended for normal workloads
  999. # -4: max size: 32 Kb <-- not recommended
  1000. # -3: max size: 16 Kb <-- probably not recommended
  1001. # -2: max size: 8 Kb <-- good
  1002. # -1: max size: 4 Kb <-- good
  1003. # Positive numbers mean store up to _exactly_ that number of elements
  1004. # per list node.
  1005. # The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size),
  1006. # but if your use case is unique, adjust the settings as necessary.
  1007. list-max-ziplist-size -2
  1008. # Lists may also be compressed.
  1009. # Compress depth is the number of quicklist ziplist nodes from *each* side of
  1010. # the list to *exclude* from compression. The head and tail of the list
  1011. # are always uncompressed for fast push/pop operations. Settings are:
  1012. # 0: disable all list compression
  1013. # 1: depth 1 means "don't start compressing until after 1 node into the list,
  1014. # going from either the head or tail"
  1015. # So: [head]->node->node->...->node->[tail]
  1016. # [head], [tail] will always be uncompressed; inner nodes will compress.
  1017. # 2: [head]->[next]->node->node->...->node->[prev]->[tail]
  1018. # 2 here means: don't compress head or head->next or tail->prev or tail,
  1019. # but compress all nodes between them.
  1020. # 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail]
  1021. # etc.
  1022. list-compress-depth 0
  1023. # Sets have a special encoding in just one case: when a set is composed
  1024. # of just strings that happen to be integers in radix 10 in the range
  1025. # of 64 bit signed integers.
  1026. # The following configuration setting sets the limit in the size of the
  1027. # set in order to use this special memory saving encoding.
  1028. set-max-intset-entries 512
  1029. # Similarly to hashes and lists, sorted sets are also specially encoded in
  1030. # order to save a lot of space. This encoding is only used when the length and
  1031. # elements of a sorted set are below the following limits:
  1032. zset-max-ziplist-entries 128
  1033. zset-max-ziplist-value 64
  1034. # HyperLogLog sparse representation bytes limit. The limit includes the
  1035. # 16 bytes header. When an HyperLogLog using the sparse representation crosses
  1036. # this limit, it is converted into the dense representation.
  1037. #
  1038. # A value greater than 16000 is totally useless, since at that point the
  1039. # dense representation is more memory efficient.
  1040. #
  1041. # The suggested value is ~ 3000 in order to have the benefits of
  1042. # the space efficient encoding without slowing down too much PFADD,
  1043. # which is O(N) with the sparse encoding. The value can be raised to
  1044. # ~ 10000 when CPU is not a concern, but space is, and the data set is
  1045. # composed of many HyperLogLogs with cardinality in the 0 - 15000 range.
  1046. hll-sparse-max-bytes 3000
  1047. # Streams macro node max size / items. The stream data structure is a radix
  1048. # tree of big nodes that encode multiple items inside. Using this configuration
  1049. # it is possible to configure how big a single node can be in bytes, and the
  1050. # maximum number of items it may contain before switching to a new node when
  1051. # appending new stream entries. If any of the following settings are set to
  1052. # zero, the limit is ignored, so for instance it is possible to set just a
  1053. # max entires limit by setting max-bytes to 0 and max-entries to the desired
  1054. # value.
  1055. stream-node-max-bytes 4096
  1056. stream-node-max-entries 100
  1057. # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
  1058. # order to help rehashing the main Redis hash table (the one mapping top-level
  1059. # keys to values). The hash table implementation Redis uses (see dict.c)
  1060. # performs a lazy rehashing: the more operation you run into a hash table
  1061. # that is rehashing, the more rehashing "steps" are performed, so if the
  1062. # server is idle the rehashing is never complete and some more memory is used
  1063. # by the hash table.
  1064. #
  1065. # The default is to use this millisecond 10 times every second in order to
  1066. # actively rehash the main dictionaries, freeing memory when possible.
  1067. #
  1068. # If unsure:
  1069. # use "activerehashing no" if you have hard latency requirements and it is
  1070. # not a good thing in your environment that Redis can reply from time to time
  1071. # to queries with 2 milliseconds delay.
  1072. #
  1073. # use "activerehashing yes" if you don't have such hard requirements but
  1074. # want to free memory asap when possible.
  1075. activerehashing yes
  1076. # The client output buffer limits can be used to force disconnection of clients
  1077. # that are not reading data from the server fast enough for some reason (a
  1078. # common reason is that a Pub/Sub client can't consume messages as fast as the
  1079. # publisher can produce them).
  1080. #
  1081. # The limit can be set differently for the three different classes of clients:
  1082. #
  1083. # normal -> normal clients including MONITOR clients
  1084. # replica -> replica clients
  1085. # pubsub -> clients subscribed to at least one pubsub channel or pattern
  1086. #
  1087. # The syntax of every client-output-buffer-limit directive is the following:
  1088. #
  1089. # client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
  1090. #
  1091. # A client is immediately disconnected once the hard limit is reached, or if
  1092. # the soft limit is reached and remains reached for the specified number of
  1093. # seconds (continuously).
  1094. # So for instance if the hard limit is 32 megabytes and the soft limit is
  1095. # 16 megabytes / 10 seconds, the client will get disconnected immediately
  1096. # if the size of the output buffers reach 32 megabytes, but will also get
  1097. # disconnected if the client reaches 16 megabytes and continuously overcomes
  1098. # the limit for 10 seconds.
  1099. #
  1100. # By default normal clients are not limited because they don't receive data
  1101. # without asking (in a push way), but just after a request, so only
  1102. # asynchronous clients may create a scenario where data is requested faster
  1103. # than it can read.
  1104. #
  1105. # Instead there is a default limit for pubsub and replica clients, since
  1106. # subscribers and replicas receive data in a push fashion.
  1107. #
  1108. # Both the hard or the soft limit can be disabled by setting them to zero.
  1109. client-output-buffer-limit normal 0 0 0
  1110. client-output-buffer-limit replica 256mb 64mb 60
  1111. client-output-buffer-limit pubsub 32mb 8mb 60
  1112. # Client query buffers accumulate new commands. They are limited to a fixed
  1113. # amount by default in order to avoid that a protocol desynchronization (for
  1114. # instance due to a bug in the client) will lead to unbound memory usage in
  1115. # the query buffer. However you can configure it here if you have very special
  1116. # needs, such us huge multi/exec requests or alike.
  1117. #
  1118. # client-query-buffer-limit 1gb
  1119. # In the Redis protocol, bulk requests, that are, elements representing single
  1120. # strings, are normally limited ot 512 mb. However you can change this limit
  1121. # here.
  1122. #
  1123. # proto-max-bulk-len 512mb
  1124. # Redis calls an internal function to perform many background tasks, like
  1125. # closing connections of clients in timeout, purging expired keys that are
  1126. # never requested, and so forth.
  1127. #
  1128. # Not all tasks are performed with the same frequency, but Redis checks for
  1129. # tasks to perform according to the specified "hz" value.
  1130. #
  1131. # By default "hz" is set to 10. Raising the value will use more CPU when
  1132. # Redis is idle, but at the same time will make Redis more responsive when
  1133. # there are many keys expiring at the same time, and timeouts may be
  1134. # handled with more precision.
  1135. #
  1136. # The range is between 1 and 500, however a value over 100 is usually not
  1137. # a good idea. Most users should use the default of 10 and raise this up to
  1138. # 100 only in environments where very low latency is required.
  1139. hz 10
  1140. # Normally it is useful to have an HZ value which is proportional to the
  1141. # number of clients connected. This is useful in order, for instance, to
  1142. # avoid too many clients are processed for each background task invocation
  1143. # in order to avoid latency spikes.
  1144. #
  1145. # Since the default HZ value by default is conservatively set to 10, Redis
  1146. # offers, and enables by default, the ability to use an adaptive HZ value
  1147. # which will temporary raise when there are many connected clients.
  1148. #
  1149. # When dynamic HZ is enabled, the actual configured HZ will be used as
  1150. # as a baseline, but multiples of the configured HZ value will be actually
  1151. # used as needed once more clients are connected. In this way an idle
  1152. # instance will use very little CPU time while a busy instance will be
  1153. # more responsive.
  1154. dynamic-hz yes
  1155. # When a child rewrites the AOF file, if the following option is enabled
  1156. # the file will be fsync-ed every 32 MB of data generated. This is useful
  1157. # in order to commit the file to the disk more incrementally and avoid
  1158. # big latency spikes.
  1159. aof-rewrite-incremental-fsync yes
  1160. # When redis saves RDB file, if the following option is enabled
  1161. # the file will be fsync-ed every 32 MB of data generated. This is useful
  1162. # in order to commit the file to the disk more incrementally and avoid
  1163. # big latency spikes.
  1164. rdb-save-incremental-fsync yes
  1165. # Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good
  1166. # idea to start with the default settings and only change them after investigating
  1167. # how to improve the performances and how the keys LFU change over time, which
  1168. # is possible to inspect via the OBJECT FREQ command.
  1169. #
  1170. # There are two tunable parameters in the Redis LFU implementation: the
  1171. # counter logarithm factor and the counter decay time. It is important to
  1172. # understand what the two parameters mean before changing them.
  1173. #
  1174. # The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis
  1175. # uses a probabilistic increment with logarithmic behavior. Given the value
  1176. # of the old counter, when a key is accessed, the counter is incremented in
  1177. # this way:
  1178. #
  1179. # 1. A random number R between 0 and 1 is extracted.
  1180. # 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1).
  1181. # 3. The counter is incremented only if R < P.
  1182. #
  1183. # The default lfu-log-factor is 10. This is a table of how the frequency
  1184. # counter changes with a different number of accesses with different
  1185. # logarithmic factors:
  1186. #
  1187. # +--------+------------+------------+------------+------------+------------+
  1188. # | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits |
  1189. # +--------+------------+------------+------------+------------+------------+
  1190. # | 0 | 104 | 255 | 255 | 255 | 255 |
  1191. # +--------+------------+------------+------------+------------+------------+
  1192. # | 1 | 18 | 49 | 255 | 255 | 255 |
  1193. # +--------+------------+------------+------------+------------+------------+
  1194. # | 10 | 10 | 18 | 142 | 255 | 255 |
  1195. # +--------+------------+------------+------------+------------+------------+
  1196. # | 100 | 8 | 11 | 49 | 143 | 255 |
  1197. # +--------+------------+------------+------------+------------+------------+
  1198. #
  1199. # NOTE: The above table was obtained by running the following commands:
  1200. #
  1201. # redis-benchmark -n 1000000 incr foo
  1202. # redis-cli object freq foo
  1203. #
  1204. # NOTE 2: The counter initial value is 5 in order to give new objects a chance
  1205. # to accumulate hits.
  1206. #
  1207. # The counter decay time is the time, in minutes, that must elapse in order
  1208. # for the key counter to be divided by two (or decremented if it has a value
  1209. # less <= 10).
  1210. #
  1211. # The default value for the lfu-decay-time is 1. A Special value of 0 means to
  1212. # decay the counter every time it happens to be scanned.
  1213. #
  1214. # lfu-log-factor 10
  1215. # lfu-decay-time 1
  1216. ################################## INCLUDES ###################################
  1217. # Include one or more other config files here. This is useful if you
  1218. # have a standard template that goes to all Redis server but also need
  1219. # to customize a few per-server settings. Include files can include
  1220. # other files, so use this wisely.
  1221. #
  1222. # include /path/to/local.conf
  1223. # include /path/to/other.conf