redis.conf 84 KB

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