redis.conf 92 KB

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