You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

redis.conf 69KB

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