redis.conf 92 KB

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