redis.conf 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050
  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. ################################## NETWORK #####################################
  35. # By default, if no "bind" configuration directive is specified, Redis listens
  36. # for connections from all the network interfaces available on the server.
  37. # It is possible to listen to just one or multiple selected interfaces using
  38. # the "bind" configuration directive, followed by one or more IP addresses.
  39. #
  40. # Examples:
  41. #
  42. # bind 192.168.1.100 10.0.0.1
  43. # bind 127.0.0.1 ::1
  44. #
  45. # ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the
  46. # internet, binding to all the interfaces is dangerous and will expose the
  47. # instance to everybody on the internet. So by default we uncomment the
  48. # following bind directive, that will force Redis to listen only into
  49. # the IPv4 lookback interface address (this means Redis will be able to
  50. # accept connections only from clients running into the same computer it
  51. # is running).
  52. #
  53. # IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES
  54. # JUST COMMENT THE FOLLOWING LINE.
  55. # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  56. bind 127.0.0.1
  57. # Protected mode is a layer of security protection, in order to avoid that
  58. # Redis instances left open on the internet are accessed and exploited.
  59. #
  60. # When protected mode is on and if:
  61. #
  62. # 1) The server is not binding explicitly to a set of addresses using the
  63. # "bind" directive.
  64. # 2) No password is configured.
  65. #
  66. # The server only accepts connections from clients connecting from the
  67. # IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain
  68. # sockets.
  69. #
  70. # By default protected mode is enabled. You should disable it only if
  71. # you are sure you want clients from other hosts to connect to Redis
  72. # even if no authentication is configured, nor a specific set of interfaces
  73. # are explicitly listed using the "bind" directive.
  74. protected-mode yes
  75. # Accept connections on the specified port, default is 6379 (IANA #815344).
  76. # If port 0 is specified Redis will not listen on a TCP socket.
  77. port 6379
  78. # TCP listen() backlog.
  79. #
  80. # In high requests-per-second environments you need an high backlog in order
  81. # to avoid slow clients connections issues. Note that the Linux kernel
  82. # will silently truncate it to the value of /proc/sys/net/core/somaxconn so
  83. # make sure to raise both the value of somaxconn and tcp_max_syn_backlog
  84. # in order to get the desired effect.
  85. tcp-backlog 511
  86. # Unix socket.
  87. #
  88. # Specify the path for the Unix socket that will be used to listen for
  89. # incoming connections. There is no default, so Redis will not listen
  90. # on a unix socket when not specified.
  91. #
  92. # unixsocket /tmp/redis.sock
  93. # unixsocketperm 700
  94. # Close the connection after a client is idle for N seconds (0 to disable)
  95. timeout 0
  96. # TCP keepalive.
  97. #
  98. # If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
  99. # of communication. This is useful for two reasons:
  100. #
  101. # 1) Detect dead peers.
  102. # 2) Take the connection alive from the point of view of network
  103. # equipment in the middle.
  104. #
  105. # On Linux, the specified value (in seconds) is the period used to send ACKs.
  106. # Note that to close the connection the double of the time is needed.
  107. # On other kernels the period depends on the kernel configuration.
  108. #
  109. # A reasonable value for this option is 300 seconds, which is the new
  110. # Redis default starting with Redis 3.2.1.
  111. tcp-keepalive 300
  112. ################################# GENERAL #####################################
  113. # By default Redis does not run as a daemon. Use 'yes' if you need it.
  114. # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
  115. daemonize no
  116. # If you run Redis from upstart or systemd, Redis can interact with your
  117. # supervision tree. Options:
  118. # supervised no - no supervision interaction
  119. # supervised upstart - signal upstart by putting Redis into SIGSTOP mode
  120. # supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET
  121. # supervised auto - detect upstart or systemd method based on
  122. # UPSTART_JOB or NOTIFY_SOCKET environment variables
  123. # Note: these supervision methods only signal "process is ready."
  124. # They do not enable continuous liveness pings back to your supervisor.
  125. supervised no
  126. # If a pid file is specified, Redis writes it where specified at startup
  127. # and removes it at exit.
  128. #
  129. # When the server runs non daemonized, no pid file is created if none is
  130. # specified in the configuration. When the server is daemonized, the pid file
  131. # is used even if not specified, defaulting to "/var/run/redis.pid".
  132. #
  133. # Creating a pid file is best effort: if Redis is not able to create it
  134. # nothing bad happens, the server will start and run normally.
  135. # Specify the server verbosity level.
  136. # This can be one of:
  137. # debug (a lot of information, useful for development/testing)
  138. # verbose (many rarely useful info, but not a mess like the debug level)
  139. # notice (moderately verbose, what you want in production probably)
  140. # warning (only very important / critical messages are logged)
  141. loglevel notice
  142. # Specify the log file name. Also the empty string can be used to force
  143. # Redis to log on the standard output. Note that if you use standard
  144. # output for logging but daemonize, logs will be sent to /dev/null
  145. # To enable logging to the system logger, just set 'syslog-enabled' to yes,
  146. # and optionally update the other syslog parameters to suit your needs.
  147. # syslog-enabled no
  148. # Specify the syslog identity.
  149. # syslog-ident redis
  150. # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
  151. # syslog-facility local0
  152. # Set the number of databases. The default database is DB 0, you can select
  153. # a different one on a per-connection basis using SELECT <dbid> where
  154. # dbid is a number between 0 and 'databases'-1
  155. databases 16
  156. ################################ SNAPSHOTTING ################################
  157. #
  158. # Save the DB on disk:
  159. #
  160. # save <seconds> <changes>
  161. #
  162. # Will save the DB if both the given number of seconds and the given
  163. # number of write operations against the DB occurred.
  164. #
  165. # In the example below the behaviour will be to save:
  166. # after 900 sec (15 min) if at least 1 key changed
  167. # after 300 sec (5 min) if at least 10 keys changed
  168. # after 60 sec if at least 10000 keys changed
  169. #
  170. # Note: you can disable saving completely by commenting out all "save" lines.
  171. #
  172. # It is also possible to remove all the previously configured save
  173. # points by adding a save directive with a single empty string argument
  174. # like in the following example:
  175. #
  176. # save ""
  177. save 900 1
  178. save 300 10
  179. save 60 10000
  180. # By default Redis will stop accepting writes if RDB snapshots are enabled
  181. # (at least one save point) and the latest background save failed.
  182. # This will make the user aware (in a hard way) that data is not persisting
  183. # on disk properly, otherwise chances are that no one will notice and some
  184. # disaster will happen.
  185. #
  186. # If the background saving process will start working again Redis will
  187. # automatically allow writes again.
  188. #
  189. # However if you have setup your proper monitoring of the Redis server
  190. # and persistence, you may want to disable this feature so that Redis will
  191. # continue to work as usual even if there are problems with disk,
  192. # permissions, and so forth.
  193. stop-writes-on-bgsave-error yes
  194. # Compress string objects using LZF when dump .rdb databases?
  195. # For default that's set to 'yes' as it's almost always a win.
  196. # If you want to save some CPU in the saving child set it to 'no' but
  197. # the dataset will likely be bigger if you have compressible values or keys.
  198. rdbcompression yes
  199. # Since version 5 of RDB a CRC64 checksum is placed at the end of the file.
  200. # This makes the format more resistant to corruption but there is a performance
  201. # hit to pay (around 10%) when saving and loading RDB files, so you can disable it
  202. # for maximum performances.
  203. #
  204. # RDB files created with checksum disabled have a checksum of zero that will
  205. # tell the loading code to skip the check.
  206. rdbchecksum yes
  207. # The filename where to dump the DB
  208. dbfilename dump.rdb
  209. # The working directory.
  210. #
  211. # The DB will be written inside this directory, with the filename specified
  212. # above using the 'dbfilename' configuration directive.
  213. #
  214. # The Append Only File will also be created inside this directory.
  215. #
  216. # Note that you must specify a directory here, not a file name.
  217. dir /redis/data
  218. ################################# REPLICATION #################################
  219. # Master-Slave replication. Use slaveof to make a Redis instance a copy of
  220. # another Redis server. A few things to understand ASAP about Redis replication.
  221. #
  222. # 1) Redis replication is asynchronous, but you can configure a master to
  223. # stop accepting writes if it appears to be not connected with at least
  224. # a given number of slaves.
  225. # 2) Redis slaves are able to perform a partial resynchronization with the
  226. # master if the replication link is lost for a relatively small amount of
  227. # time. You may want to configure the replication backlog size (see the next
  228. # sections of this file) with a sensible value depending on your needs.
  229. # 3) Replication is automatic and does not need user intervention. After a
  230. # network partition slaves automatically try to reconnect to masters
  231. # and resynchronize with them.
  232. #
  233. # slaveof <masterip> <masterport>
  234. # If the master is password protected (using the "requirepass" configuration
  235. # directive below) it is possible to tell the slave to authenticate before
  236. # starting the replication synchronization process, otherwise the master will
  237. # refuse the slave request.
  238. #
  239. # masterauth <master-password>
  240. # When a slave loses its connection with the master, or when the replication
  241. # is still in progress, the slave can act in two different ways:
  242. #
  243. # 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
  244. # still reply to client requests, possibly with out of date data, or the
  245. # data set may just be empty if this is the first synchronization.
  246. #
  247. # 2) if slave-serve-stale-data is set to 'no' the slave will reply with
  248. # an error "SYNC with master in progress" to all the kind of commands
  249. # but to INFO and SLAVEOF.
  250. #
  251. slave-serve-stale-data yes
  252. # You can configure a slave instance to accept writes or not. Writing against
  253. # a slave instance may be useful to store some ephemeral data (because data
  254. # written on a slave will be easily deleted after resync with the master) but
  255. # may also cause problems if clients are writing to it because of a
  256. # misconfiguration.
  257. #
  258. # Since Redis 2.6 by default slaves are read-only.
  259. #
  260. # Note: read only slaves are not designed to be exposed to untrusted clients
  261. # on the internet. It's just a protection layer against misuse of the instance.
  262. # Still a read only slave exports by default all the administrative commands
  263. # such as CONFIG, DEBUG, and so forth. To a limited extent you can improve
  264. # security of read only slaves using 'rename-command' to shadow all the
  265. # administrative / dangerous commands.
  266. slave-read-only yes
  267. # Replication SYNC strategy: disk or socket.
  268. #
  269. # -------------------------------------------------------
  270. # WARNING: DISKLESS REPLICATION IS EXPERIMENTAL CURRENTLY
  271. # -------------------------------------------------------
  272. #
  273. # New slaves and reconnecting slaves that are not able to continue the replication
  274. # process just receiving differences, need to do what is called a "full
  275. # synchronization". An RDB file is transmitted from the master to the slaves.
  276. # The transmission can happen in two different ways:
  277. #
  278. # 1) Disk-backed: The Redis master creates a new process that writes the RDB
  279. # file on disk. Later the file is transferred by the parent
  280. # process to the slaves incrementally.
  281. # 2) Diskless: The Redis master creates a new process that directly writes the
  282. # RDB file to slave sockets, without touching the disk at all.
  283. #
  284. # With disk-backed replication, while the RDB file is generated, more slaves
  285. # can be queued and served with the RDB file as soon as the current child producing
  286. # the RDB file finishes its work. With diskless replication instead once
  287. # the transfer starts, new slaves arriving will be queued and a new transfer
  288. # will start when the current one terminates.
  289. #
  290. # When diskless replication is used, the master waits a configurable amount of
  291. # time (in seconds) before starting the transfer in the hope that multiple slaves
  292. # will arrive and the transfer can be parallelized.
  293. #
  294. # With slow disks and fast (large bandwidth) networks, diskless replication
  295. # works better.
  296. repl-diskless-sync no
  297. # When diskless replication is enabled, it is possible to configure the delay
  298. # the server waits in order to spawn the child that transfers the RDB via socket
  299. # to the slaves.
  300. #
  301. # This is important since once the transfer starts, it is not possible to serve
  302. # new slaves arriving, that will be queued for the next RDB transfer, so the server
  303. # waits a delay in order to let more slaves arrive.
  304. #
  305. # The delay is specified in seconds, and by default is 5 seconds. To disable
  306. # it entirely just set it to 0 seconds and the transfer will start ASAP.
  307. repl-diskless-sync-delay 5
  308. # Slaves send PINGs to server in a predefined interval. It's possible to change
  309. # this interval with the repl_ping_slave_period option. The default value is 10
  310. # seconds.
  311. #
  312. # repl-ping-slave-period 10
  313. # The following option sets the replication timeout for:
  314. #
  315. # 1) Bulk transfer I/O during SYNC, from the point of view of slave.
  316. # 2) Master timeout from the point of view of slaves (data, pings).
  317. # 3) Slave timeout from the point of view of masters (REPLCONF ACK pings).
  318. #
  319. # It is important to make sure that this value is greater than the value
  320. # specified for repl-ping-slave-period otherwise a timeout will be detected
  321. # every time there is low traffic between the master and the slave.
  322. #
  323. # repl-timeout 60
  324. # Disable TCP_NODELAY on the slave socket after SYNC?
  325. #
  326. # If you select "yes" Redis will use a smaller number of TCP packets and
  327. # less bandwidth to send data to slaves. But this can add a delay for
  328. # the data to appear on the slave side, up to 40 milliseconds with
  329. # Linux kernels using a default configuration.
  330. #
  331. # If you select "no" the delay for data to appear on the slave side will
  332. # be reduced but more bandwidth will be used for replication.
  333. #
  334. # By default we optimize for low latency, but in very high traffic conditions
  335. # or when the master and slaves are many hops away, turning this to "yes" may
  336. # be a good idea.
  337. repl-disable-tcp-nodelay no
  338. # Set the replication backlog size. The backlog is a buffer that accumulates
  339. # slave data when slaves are disconnected for some time, so that when a slave
  340. # wants to reconnect again, often a full resync is not needed, but a partial
  341. # resync is enough, just passing the portion of data the slave missed while
  342. # disconnected.
  343. #
  344. # The bigger the replication backlog, the longer the time the slave can be
  345. # disconnected and later be able to perform a partial resynchronization.
  346. #
  347. # The backlog is only allocated once there is at least a slave connected.
  348. #
  349. # repl-backlog-size 1mb
  350. # After a master has no longer connected slaves for some time, the backlog
  351. # will be freed. The following option configures the amount of seconds that
  352. # need to elapse, starting from the time the last slave disconnected, for
  353. # the backlog buffer to be freed.
  354. #
  355. # A value of 0 means to never release the backlog.
  356. #
  357. # repl-backlog-ttl 3600
  358. # The slave priority is an integer number published by Redis in the INFO output.
  359. # It is used by Redis Sentinel in order to select a slave to promote into a
  360. # master if the master is no longer working correctly.
  361. #
  362. # A slave with a low priority number is considered better for promotion, so
  363. # for instance if there are three slaves with priority 10, 100, 25 Sentinel will
  364. # pick the one with priority 10, that is the lowest.
  365. #
  366. # However a special priority of 0 marks the slave as not able to perform the
  367. # role of master, so a slave with priority of 0 will never be selected by
  368. # Redis Sentinel for promotion.
  369. #
  370. # By default the priority is 100.
  371. slave-priority 100
  372. # It is possible for a master to stop accepting writes if there are less than
  373. # N slaves connected, having a lag less or equal than M seconds.
  374. #
  375. # The N slaves need to be in "online" state.
  376. #
  377. # The lag in seconds, that must be <= the specified value, is calculated from
  378. # the last ping received from the slave, that is usually sent every second.
  379. #
  380. # This option does not GUARANTEE that N replicas will accept the write, but
  381. # will limit the window of exposure for lost writes in case not enough slaves
  382. # are available, to the specified number of seconds.
  383. #
  384. # For example to require at least 3 slaves with a lag <= 10 seconds use:
  385. #
  386. # min-slaves-to-write 3
  387. # min-slaves-max-lag 10
  388. #
  389. # Setting one or the other to 0 disables the feature.
  390. #
  391. # By default min-slaves-to-write is set to 0 (feature disabled) and
  392. # min-slaves-max-lag is set to 10.
  393. # A Redis master is able to list the address and port of the attached
  394. # slaves in different ways. For example the "INFO replication" section
  395. # offers this information, which is used, among other tools, by
  396. # Redis Sentinel in order to discover slave instances.
  397. # Another place where this info is available is in the output of the
  398. # "ROLE" command of a masteer.
  399. #
  400. # The listed IP and address normally reported by a slave is obtained
  401. # in the following way:
  402. #
  403. # IP: The address is auto detected by checking the peer address
  404. # of the socket used by the slave to connect with the master.
  405. #
  406. # Port: The port is communicated by the slave during the replication
  407. # handshake, and is normally the port that the slave is using to
  408. # list for connections.
  409. #
  410. # However when port forwarding or Network Address Translation (NAT) is
  411. # used, the slave may be actually reachable via different IP and port
  412. # pairs. The following two options can be used by a slave in order to
  413. # report to its master a specific set of IP and port, so that both INFO
  414. # and ROLE will report those values.
  415. #
  416. # There is no need to use both the options if you need to override just
  417. # the port or the IP address.
  418. #
  419. # slave-announce-ip 5.5.5.5
  420. # slave-announce-port 1234
  421. ################################## SECURITY ###################################
  422. # Require clients to issue AUTH <PASSWORD> before processing any other
  423. # commands. This might be useful in environments in which you do not trust
  424. # others with access to the host running redis-server.
  425. #
  426. # This should stay commented out for backward compatibility and because most
  427. # people do not need auth (e.g. they run their own servers).
  428. #
  429. # Warning: since Redis is pretty fast an outside user can try up to
  430. # 150k passwords per second against a good box. This means that you should
  431. # use a very strong password otherwise it will be very easy to break.
  432. #
  433. requirepass redis
  434. # Command renaming.
  435. #
  436. # It is possible to change the name of dangerous commands in a shared
  437. # environment. For instance the CONFIG command may be renamed into something
  438. # hard to guess so that it will still be available for internal-use tools
  439. # but not available for general clients.
  440. #
  441. # Example:
  442. #
  443. # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
  444. #
  445. # It is also possible to completely kill a command by renaming it into
  446. # an empty string:
  447. #
  448. # rename-command CONFIG ""
  449. #
  450. # Please note that changing the name of commands that are logged into the
  451. # AOF file or transmitted to slaves may cause problems.
  452. ################################### LIMITS ####################################
  453. # Set the max number of connected clients at the same time. By default
  454. # this limit is set to 10000 clients, however if the Redis server is not
  455. # able to configure the process file limit to allow for the specified limit
  456. # the max number of allowed clients is set to the current file limit
  457. # minus 32 (as Redis reserves a few file descriptors for internal uses).
  458. #
  459. # Once the limit is reached Redis will close all the new connections sending
  460. # an error 'max number of clients reached'.
  461. #
  462. # maxclients 10000
  463. # Don't use more memory than the specified amount of bytes.
  464. # When the memory limit is reached Redis will try to remove keys
  465. # according to the eviction policy selected (see maxmemory-policy).
  466. #
  467. # If Redis can't remove keys according to the policy, or if the policy is
  468. # set to 'noeviction', Redis will start to reply with errors to commands
  469. # that would use more memory, like SET, LPUSH, and so on, and will continue
  470. # to reply to read-only commands like GET.
  471. #
  472. # This option is usually useful when using Redis as an LRU cache, or to set
  473. # a hard memory limit for an instance (using the 'noeviction' policy).
  474. #
  475. # WARNING: If you have slaves attached to an instance with maxmemory on,
  476. # the size of the output buffers needed to feed the slaves are subtracted
  477. # from the used memory count, so that network problems / resyncs will
  478. # not trigger a loop where keys are evicted, and in turn the output
  479. # buffer of slaves is full with DELs of keys evicted triggering the deletion
  480. # of more keys, and so forth until the database is completely emptied.
  481. #
  482. # In short... if you have slaves attached it is suggested that you set a lower
  483. # limit for maxmemory so that there is some free RAM on the system for slave
  484. # output buffers (but this is not needed if the policy is 'noeviction').
  485. #
  486. # maxmemory <bytes>
  487. # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
  488. # is reached. You can select among five behaviors:
  489. #
  490. # volatile-lru -> remove the key with an expire set using an LRU algorithm
  491. # allkeys-lru -> remove any key according to the LRU algorithm
  492. # volatile-random -> remove a random key with an expire set
  493. # allkeys-random -> remove a random key, any key
  494. # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
  495. # noeviction -> don't expire at all, just return an error on write operations
  496. #
  497. # Note: with any of the above policies, Redis will return an error on write
  498. # operations, when there are no suitable keys for eviction.
  499. #
  500. # At the date of writing these commands are: set setnx setex append
  501. # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
  502. # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
  503. # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
  504. # getset mset msetnx exec sort
  505. #
  506. # The default is:
  507. #
  508. # maxmemory-policy noeviction
  509. # LRU and minimal TTL algorithms are not precise algorithms but approximated
  510. # algorithms (in order to save memory), so you can tune it for speed or
  511. # accuracy. For default Redis will check five keys and pick the one that was
  512. # used less recently, you can change the sample size using the following
  513. # configuration directive.
  514. #
  515. # The default of 5 produces good enough results. 10 Approximates very closely
  516. # true LRU but costs a bit more CPU. 3 is very fast but not very accurate.
  517. #
  518. # maxmemory-samples 5
  519. ############################## APPEND ONLY MODE ###############################
  520. # By default Redis asynchronously dumps the dataset on disk. This mode is
  521. # good enough in many applications, but an issue with the Redis process or
  522. # a power outage may result into a few minutes of writes lost (depending on
  523. # the configured save points).
  524. #
  525. # The Append Only File is an alternative persistence mode that provides
  526. # much better durability. For instance using the default data fsync policy
  527. # (see later in the config file) Redis can lose just one second of writes in a
  528. # dramatic event like a server power outage, or a single write if something
  529. # wrong with the Redis process itself happens, but the operating system is
  530. # still running correctly.
  531. #
  532. # AOF and RDB persistence can be enabled at the same time without problems.
  533. # If the AOF is enabled on startup Redis will load the AOF, that is the file
  534. # with the better durability guarantees.
  535. #
  536. # Please check http://redis.io/topics/persistence for more information.
  537. appendonly no
  538. # The name of the append only file (default: "appendonly.aof")
  539. appendfilename "appendonly.aof"
  540. # The fsync() call tells the Operating System to actually write data on disk
  541. # instead of waiting for more data in the output buffer. Some OS will really flush
  542. # data on disk, some other OS will just try to do it ASAP.
  543. #
  544. # Redis supports three different modes:
  545. #
  546. # no: don't fsync, just let the OS flush the data when it wants. Faster.
  547. # always: fsync after every write to the append only log. Slow, Safest.
  548. # everysec: fsync only one time every second. Compromise.
  549. #
  550. # The default is "everysec", as that's usually the right compromise between
  551. # speed and data safety. It's up to you to understand if you can relax this to
  552. # "no" that will let the operating system flush the output buffer when
  553. # it wants, for better performances (but if you can live with the idea of
  554. # some data loss consider the default persistence mode that's snapshotting),
  555. # or on the contrary, use "always" that's very slow but a bit safer than
  556. # everysec.
  557. #
  558. # More details please check the following article:
  559. # http://antirez.com/post/redis-persistence-demystified.html
  560. #
  561. # If unsure, use "everysec".
  562. # appendfsync always
  563. appendfsync everysec
  564. # appendfsync no
  565. # When the AOF fsync policy is set to always or everysec, and a background
  566. # saving process (a background save or AOF log background rewriting) is
  567. # performing a lot of I/O against the disk, in some Linux configurations
  568. # Redis may block too long on the fsync() call. Note that there is no fix for
  569. # this currently, as even performing fsync in a different thread will block
  570. # our synchronous write(2) call.
  571. #
  572. # In order to mitigate this problem it's possible to use the following option
  573. # that will prevent fsync() from being called in the main process while a
  574. # BGSAVE or BGREWRITEAOF is in progress.
  575. #
  576. # This means that while another child is saving, the durability of Redis is
  577. # the same as "appendfsync none". In practical terms, this means that it is
  578. # possible to lose up to 30 seconds of log in the worst scenario (with the
  579. # default Linux settings).
  580. #
  581. # If you have latency problems turn this to "yes". Otherwise leave it as
  582. # "no" that is the safest pick from the point of view of durability.
  583. no-appendfsync-on-rewrite no
  584. # Automatic rewrite of the append only file.
  585. # Redis is able to automatically rewrite the log file implicitly calling
  586. # BGREWRITEAOF when the AOF log size grows by the specified percentage.
  587. #
  588. # This is how it works: Redis remembers the size of the AOF file after the
  589. # latest rewrite (if no rewrite has happened since the restart, the size of
  590. # the AOF at startup is used).
  591. #
  592. # This base size is compared to the current size. If the current size is
  593. # bigger than the specified percentage, the rewrite is triggered. Also
  594. # you need to specify a minimal size for the AOF file to be rewritten, this
  595. # is useful to avoid rewriting the AOF file even if the percentage increase
  596. # is reached but it is still pretty small.
  597. #
  598. # Specify a percentage of zero in order to disable the automatic AOF
  599. # rewrite feature.
  600. auto-aof-rewrite-percentage 100
  601. auto-aof-rewrite-min-size 64mb
  602. # An AOF file may be found to be truncated at the end during the Redis
  603. # startup process, when the AOF data gets loaded back into memory.
  604. # This may happen when the system where Redis is running
  605. # crashes, especially when an ext4 filesystem is mounted without the
  606. # data=ordered option (however this can't happen when Redis itself
  607. # crashes or aborts but the operating system still works correctly).
  608. #
  609. # Redis can either exit with an error when this happens, or load as much
  610. # data as possible (the default now) and start if the AOF file is found
  611. # to be truncated at the end. The following option controls this behavior.
  612. #
  613. # If aof-load-truncated is set to yes, a truncated AOF file is loaded and
  614. # the Redis server starts emitting a log to inform the user of the event.
  615. # Otherwise if the option is set to no, the server aborts with an error
  616. # and refuses to start. When the option is set to no, the user requires
  617. # to fix the AOF file using the "redis-check-aof" utility before to restart
  618. # the server.
  619. #
  620. # Note that if the AOF file will be found to be corrupted in the middle
  621. # the server will still exit with an error. This option only applies when
  622. # Redis will try to read more data from the AOF file but not enough bytes
  623. # will be found.
  624. aof-load-truncated yes
  625. ################################ LUA SCRIPTING ###############################
  626. # Max execution time of a Lua script in milliseconds.
  627. #
  628. # If the maximum execution time is reached Redis will log that a script is
  629. # still in execution after the maximum allowed time and will start to
  630. # reply to queries with an error.
  631. #
  632. # When a long running script exceeds the maximum execution time only the
  633. # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
  634. # used to stop a script that did not yet called write commands. The second
  635. # is the only way to shut down the server in the case a write command was
  636. # already issued by the script but the user doesn't want to wait for the natural
  637. # termination of the script.
  638. #
  639. # Set it to 0 or a negative value for unlimited execution without warnings.
  640. lua-time-limit 5000
  641. ################################ REDIS CLUSTER ###############################
  642. #
  643. # ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  644. # WARNING EXPERIMENTAL: Redis Cluster is considered to be stable code, however
  645. # in order to mark it as "mature" we need to wait for a non trivial percentage
  646. # of users to deploy it in production.
  647. # ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  648. #
  649. # Normal Redis instances can't be part of a Redis Cluster; only nodes that are
  650. # started as cluster nodes can. In order to start a Redis instance as a
  651. # cluster node enable the cluster support uncommenting the following:
  652. #
  653. # cluster-enabled yes
  654. # Every cluster node has a cluster configuration file. This file is not
  655. # intended to be edited by hand. It is created and updated by Redis nodes.
  656. # Every Redis Cluster node requires a different cluster configuration file.
  657. # Make sure that instances running in the same system do not have
  658. # overlapping cluster configuration file names.
  659. #
  660. # cluster-config-file nodes-6379.conf
  661. # Cluster node timeout is the amount of milliseconds a node must be unreachable
  662. # for it to be considered in failure state.
  663. # Most other internal time limits are multiple of the node timeout.
  664. #
  665. # cluster-node-timeout 15000
  666. # A slave of a failing master will avoid to start a failover if its data
  667. # looks too old.
  668. #
  669. # There is no simple way for a slave to actually have a exact measure of
  670. # its "data age", so the following two checks are performed:
  671. #
  672. # 1) If there are multiple slaves able to failover, they exchange messages
  673. # in order to try to give an advantage to the slave with the best
  674. # replication offset (more data from the master processed).
  675. # Slaves will try to get their rank by offset, and apply to the start
  676. # of the failover a delay proportional to their rank.
  677. #
  678. # 2) Every single slave computes the time of the last interaction with
  679. # its master. This can be the last ping or command received (if the master
  680. # is still in the "connected" state), or the time that elapsed since the
  681. # disconnection with the master (if the replication link is currently down).
  682. # If the last interaction is too old, the slave will not try to failover
  683. # at all.
  684. #
  685. # The point "2" can be tuned by user. Specifically a slave will not perform
  686. # the failover if, since the last interaction with the master, the time
  687. # elapsed is greater than:
  688. #
  689. # (node-timeout * slave-validity-factor) + repl-ping-slave-period
  690. #
  691. # So for example if node-timeout is 30 seconds, and the slave-validity-factor
  692. # is 10, and assuming a default repl-ping-slave-period of 10 seconds, the
  693. # slave will not try to failover if it was not able to talk with the master
  694. # for longer than 310 seconds.
  695. #
  696. # A large slave-validity-factor may allow slaves with too old data to failover
  697. # a master, while a too small value may prevent the cluster from being able to
  698. # elect a slave at all.
  699. #
  700. # For maximum availability, it is possible to set the slave-validity-factor
  701. # to a value of 0, which means, that slaves will always try to failover the
  702. # master regardless of the last time they interacted with the master.
  703. # (However they'll always try to apply a delay proportional to their
  704. # offset rank).
  705. #
  706. # Zero is the only value able to guarantee that when all the partitions heal
  707. # the cluster will always be able to continue.
  708. #
  709. # cluster-slave-validity-factor 10
  710. # Cluster slaves are able to migrate to orphaned masters, that are masters
  711. # that are left without working slaves. This improves the cluster ability
  712. # to resist to failures as otherwise an orphaned master can't be failed over
  713. # in case of failure if it has no working slaves.
  714. #
  715. # Slaves migrate to orphaned masters only if there are still at least a
  716. # given number of other working slaves for their old master. This number
  717. # is the "migration barrier". A migration barrier of 1 means that a slave
  718. # will migrate only if there is at least 1 other working slave for its master
  719. # and so forth. It usually reflects the number of slaves you want for every
  720. # master in your cluster.
  721. #
  722. # Default is 1 (slaves migrate only if their masters remain with at least
  723. # one slave). To disable migration just set it to a very large value.
  724. # A value of 0 can be set but is useful only for debugging and dangerous
  725. # in production.
  726. #
  727. # cluster-migration-barrier 1
  728. # By default Redis Cluster nodes stop accepting queries if they detect there
  729. # is at least an hash slot uncovered (no available node is serving it).
  730. # This way if the cluster is partially down (for example a range of hash slots
  731. # are no longer covered) all the cluster becomes, eventually, unavailable.
  732. # It automatically returns available as soon as all the slots are covered again.
  733. #
  734. # However sometimes you want the subset of the cluster which is working,
  735. # to continue to accept queries for the part of the key space that is still
  736. # covered. In order to do so, just set the cluster-require-full-coverage
  737. # option to no.
  738. #
  739. # cluster-require-full-coverage yes
  740. # In order to setup your cluster make sure to read the documentation
  741. # available at http://redis.io web site.
  742. ################################## SLOW LOG ###################################
  743. # The Redis Slow Log is a system to log queries that exceeded a specified
  744. # execution time. The execution time does not include the I/O operations
  745. # like talking with the client, sending the reply and so forth,
  746. # but just the time needed to actually execute the command (this is the only
  747. # stage of command execution where the thread is blocked and can not serve
  748. # other requests in the meantime).
  749. #
  750. # You can configure the slow log with two parameters: one tells Redis
  751. # what is the execution time, in microseconds, to exceed in order for the
  752. # command to get logged, and the other parameter is the length of the
  753. # slow log. When a new command is logged the oldest one is removed from the
  754. # queue of logged commands.
  755. # The following time is expressed in microseconds, so 1000000 is equivalent
  756. # to one second. Note that a negative number disables the slow log, while
  757. # a value of zero forces the logging of every command.
  758. slowlog-log-slower-than 10000
  759. # There is no limit to this length. Just be aware that it will consume memory.
  760. # You can reclaim memory used by the slow log with SLOWLOG RESET.
  761. slowlog-max-len 128
  762. ################################ LATENCY MONITOR ##############################
  763. # The Redis latency monitoring subsystem samples different operations
  764. # at runtime in order to collect data related to possible sources of
  765. # latency of a Redis instance.
  766. #
  767. # Via the LATENCY command this information is available to the user that can
  768. # print graphs and obtain reports.
  769. #
  770. # The system only logs operations that were performed in a time equal or
  771. # greater than the amount of milliseconds specified via the
  772. # latency-monitor-threshold configuration directive. When its value is set
  773. # to zero, the latency monitor is turned off.
  774. #
  775. # By default latency monitoring is disabled since it is mostly not needed
  776. # if you don't have latency issues, and collecting data has a performance
  777. # impact, that while very small, can be measured under big load. Latency
  778. # monitoring can easily be enabled at runtime using the command
  779. # "CONFIG SET latency-monitor-threshold <milliseconds>" if needed.
  780. latency-monitor-threshold 0
  781. ############################# EVENT NOTIFICATION ##############################
  782. # Redis can notify Pub/Sub clients about events happening in the key space.
  783. # This feature is documented at http://redis.io/topics/notifications
  784. #
  785. # For instance if keyspace events notification is enabled, and a client
  786. # performs a DEL operation on key "foo" stored in the Database 0, two
  787. # messages will be published via Pub/Sub:
  788. #
  789. # PUBLISH __keyspace@0__:foo del
  790. # PUBLISH __keyevent@0__:del foo
  791. #
  792. # It is possible to select the events that Redis will notify among a set
  793. # of classes. Every class is identified by a single character:
  794. #
  795. # K Keyspace events, published with __keyspace@<db>__ prefix.
  796. # E Keyevent events, published with __keyevent@<db>__ prefix.
  797. # g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
  798. # $ String commands
  799. # l List commands
  800. # s Set commands
  801. # h Hash commands
  802. # z Sorted set commands
  803. # x Expired events (events generated every time a key expires)
  804. # e Evicted events (events generated when a key is evicted for maxmemory)
  805. # A Alias for g$lshzxe, so that the "AKE" string means all the events.
  806. #
  807. # The "notify-keyspace-events" takes as argument a string that is composed
  808. # of zero or multiple characters. The empty string means that notifications
  809. # are disabled.
  810. #
  811. # Example: to enable list and generic events, from the point of view of the
  812. # event name, use:
  813. #
  814. # notify-keyspace-events Elg
  815. #
  816. # Example 2: to get the stream of the expired keys subscribing to channel
  817. # name __keyevent@0__:expired use:
  818. #
  819. # notify-keyspace-events Ex
  820. #
  821. # By default all notifications are disabled because most users don't need
  822. # this feature and the feature has some overhead. Note that if you don't
  823. # specify at least one of K or E, no events will be delivered.
  824. notify-keyspace-events ""
  825. ############################### ADVANCED CONFIG ###############################
  826. # Hashes are encoded using a memory efficient data structure when they have a
  827. # small number of entries, and the biggest entry does not exceed a given
  828. # threshold. These thresholds can be configured using the following directives.
  829. hash-max-ziplist-entries 512
  830. hash-max-ziplist-value 64
  831. # Lists are also encoded in a special way to save a lot of space.
  832. # The number of entries allowed per internal list node can be specified
  833. # as a fixed maximum size or a maximum number of elements.
  834. # For a fixed maximum size, use -5 through -1, meaning:
  835. # -5: max size: 64 Kb <-- not recommended for normal workloads
  836. # -4: max size: 32 Kb <-- not recommended
  837. # -3: max size: 16 Kb <-- probably not recommended
  838. # -2: max size: 8 Kb <-- good
  839. # -1: max size: 4 Kb <-- good
  840. # Positive numbers mean store up to _exactly_ that number of elements
  841. # per list node.
  842. # The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size),
  843. # but if your use case is unique, adjust the settings as necessary.
  844. list-max-ziplist-size -2
  845. # Lists may also be compressed.
  846. # Compress depth is the number of quicklist ziplist nodes from *each* side of
  847. # the list to *exclude* from compression. The head and tail of the list
  848. # are always uncompressed for fast push/pop operations. Settings are:
  849. # 0: disable all list compression
  850. # 1: depth 1 means "don't start compressing until after 1 node into the list,
  851. # going from either the head or tail"
  852. # So: [head]->node->node->...->node->[tail]
  853. # [head], [tail] will always be uncompressed; inner nodes will compress.
  854. # 2: [head]->[next]->node->node->...->node->[prev]->[tail]
  855. # 2 here means: don't compress head or head->next or tail->prev or tail,
  856. # but compress all nodes between them.
  857. # 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail]
  858. # etc.
  859. list-compress-depth 0
  860. # Sets have a special encoding in just one case: when a set is composed
  861. # of just strings that happen to be integers in radix 10 in the range
  862. # of 64 bit signed integers.
  863. # The following configuration setting sets the limit in the size of the
  864. # set in order to use this special memory saving encoding.
  865. set-max-intset-entries 512
  866. # Similarly to hashes and lists, sorted sets are also specially encoded in
  867. # order to save a lot of space. This encoding is only used when the length and
  868. # elements of a sorted set are below the following limits:
  869. zset-max-ziplist-entries 128
  870. zset-max-ziplist-value 64
  871. # HyperLogLog sparse representation bytes limit. The limit includes the
  872. # 16 bytes header. When an HyperLogLog using the sparse representation crosses
  873. # this limit, it is converted into the dense representation.
  874. #
  875. # A value greater than 16000 is totally useless, since at that point the
  876. # dense representation is more memory efficient.
  877. #
  878. # The suggested value is ~ 3000 in order to have the benefits of
  879. # the space efficient encoding without slowing down too much PFADD,
  880. # which is O(N) with the sparse encoding. The value can be raised to
  881. # ~ 10000 when CPU is not a concern, but space is, and the data set is
  882. # composed of many HyperLogLogs with cardinality in the 0 - 15000 range.
  883. hll-sparse-max-bytes 3000
  884. # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
  885. # order to help rehashing the main Redis hash table (the one mapping top-level
  886. # keys to values). The hash table implementation Redis uses (see dict.c)
  887. # performs a lazy rehashing: the more operation you run into a hash table
  888. # that is rehashing, the more rehashing "steps" are performed, so if the
  889. # server is idle the rehashing is never complete and some more memory is used
  890. # by the hash table.
  891. #
  892. # The default is to use this millisecond 10 times every second in order to
  893. # actively rehash the main dictionaries, freeing memory when possible.
  894. #
  895. # If unsure:
  896. # use "activerehashing no" if you have hard latency requirements and it is
  897. # not a good thing in your environment that Redis can reply from time to time
  898. # to queries with 2 milliseconds delay.
  899. #
  900. # use "activerehashing yes" if you don't have such hard requirements but
  901. # want to free memory asap when possible.
  902. activerehashing yes
  903. # The client output buffer limits can be used to force disconnection of clients
  904. # that are not reading data from the server fast enough for some reason (a
  905. # common reason is that a Pub/Sub client can't consume messages as fast as the
  906. # publisher can produce them).
  907. #
  908. # The limit can be set differently for the three different classes of clients:
  909. #
  910. # normal -> normal clients including MONITOR clients
  911. # slave -> slave clients
  912. # pubsub -> clients subscribed to at least one pubsub channel or pattern
  913. #
  914. # The syntax of every client-output-buffer-limit directive is the following:
  915. #
  916. # client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
  917. #
  918. # A client is immediately disconnected once the hard limit is reached, or if
  919. # the soft limit is reached and remains reached for the specified number of
  920. # seconds (continuously).
  921. # So for instance if the hard limit is 32 megabytes and the soft limit is
  922. # 16 megabytes / 10 seconds, the client will get disconnected immediately
  923. # if the size of the output buffers reach 32 megabytes, but will also get
  924. # disconnected if the client reaches 16 megabytes and continuously overcomes
  925. # the limit for 10 seconds.
  926. #
  927. # By default normal clients are not limited because they don't receive data
  928. # without asking (in a push way), but just after a request, so only
  929. # asynchronous clients may create a scenario where data is requested faster
  930. # than it can read.
  931. #
  932. # Instead there is a default limit for pubsub and slave clients, since
  933. # subscribers and slaves receive data in a push fashion.
  934. #
  935. # Both the hard or the soft limit can be disabled by setting them to zero.
  936. client-output-buffer-limit normal 0 0 0
  937. client-output-buffer-limit slave 256mb 64mb 60
  938. client-output-buffer-limit pubsub 32mb 8mb 60
  939. # Redis calls an internal function to perform many background tasks, like
  940. # closing connections of clients in timeout, purging expired keys that are
  941. # never requested, and so forth.
  942. #
  943. # Not all tasks are performed with the same frequency, but Redis checks for
  944. # tasks to perform according to the specified "hz" value.
  945. #
  946. # By default "hz" is set to 10. Raising the value will use more CPU when
  947. # Redis is idle, but at the same time will make Redis more responsive when
  948. # there are many keys expiring at the same time, and timeouts may be
  949. # handled with more precision.
  950. #
  951. # The range is between 1 and 500, however a value over 100 is usually not
  952. # a good idea. Most users should use the default of 10 and raise this up to
  953. # 100 only in environments where very low latency is required.
  954. hz 10
  955. # When a child rewrites the AOF file, if the following option is enabled
  956. # the file will be fsync-ed every 32 MB of data generated. This is useful
  957. # in order to commit the file to the disk more incrementally and avoid
  958. # big latency spikes.
  959. aof-rewrite-incremental-fsync yes