Skip to content
This repository
Newer
Older
100644 751 lines (675 sloc) 32.213 kb
ed9b544e »
2009-03-22 first commit
1 # Redis configuration file example
2
57c0cf8b » kashif
2011-12-28 Fixed some typos in redis.conf.
3 # Note on units: when memory size is needed, it is possible to specify
72324005 »
2010-04-22 new units for bytes specification
4 # it in the usual form of 1k 5GB 4M and so forth:
5 #
6 # 1k => 1000 bytes
7 # 1kb => 1024 bytes
8 # 1m => 1000000 bytes
9 # 1mb => 1024*1024 bytes
10 # 1g => 1000000000 bytes
11 # 1gb => 1024*1024*1024 bytes
12 #
13 # units are case insensitive so 1GB 1Gb 1gB are all the same.
14
d62bbfda » Dieken
2013-11-30 CONFIG REWRITE: don't throw some options on config rewrite
15 ################################## INCLUDES ###################################
16
17 # Include one or more other config files here. This is useful if you
18 # have a standard template that goes to all Redis server but also need
19 # to customize a few per-server settings. Include files can include
20 # other files, so use this wisely.
21 #
22 # Notice option "include" won't be rewritten by command "CONFIG REWRITE"
d33f3689 »
2013-12-19 Clarify include directive behavior in example redis.conf.
23 # from admin or Redis Sentinel. Since Redis always uses the last processed
24 # line as value of a configuration directive, you'd better put includes
25 # at the beginning of this file to avoid overwriting config change at runtime.
26 #
27 # If instead you are interested in using includes to override configuration
28 # options, it is better to use include as the last line.
d62bbfda » Dieken
2013-11-30 CONFIG REWRITE: don't throw some options on config rewrite
29 #
30 # include /path/to/local.conf
31 # include /path/to/other.conf
32
33 ################################ GENERAL #####################################
34
ed9b544e »
2009-03-22 first commit
35 # By default Redis does not run as a daemon. Use 'yes' if you need it.
36 # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
37 daemonize no
38
029245fe »
2010-05-06 clarified a few messages in redis.conf
39 # When running daemonized, Redis writes a pid file in /var/run/redis.pid by
40 # default. You can specify a custom pid file location here.
ed329fcf » lucsky
2009-03-23 Allow to specify the pid file from the config file.
41 pidfile /var/run/redis.pid
42
a5639e7d » pietern
2010-08-03 Change initialization to allow listening on both a port and socket
43 # Accept connections on the specified port, default is 6379.
68d6345d »
2011-02-07 If port zero is specified, Redis will not listen for TCP connections
44 # If port 0 is specified Redis will not listen on a TCP socket.
ed9b544e »
2009-03-22 first commit
45 port 6379
46
1406112e »
2014-01-31 Redis.conf comment about tcp-backlog option improved.
47 # TCP listen() backlog.
48 #
49 # In high requests-per-second environments you need an high backlog in order
50 # to avoid slow clients connections issues. Note that the Linux kernel
51 # will silently truncate it to the value of /proc/sys/net/core/somaxconn so
52 # make sure to raise both the value of somaxconn and tcp_max_syn_backlog
53 # in order to get the desired effect.
917b8514 »
2014-01-31 Option "backlog" renamed "tcp-backlog".
54 tcp-backlog 511
8dda9dbe » nmerdan
2013-11-08 Add support for listen(2) backlog definition
55
33c5f0a2 »
2013-07-08 Example redis.conf: bind to multiple interfaces documented.
56 # By default Redis listens for connections from all the network interfaces
57 # available on the server. It is possible to listen to just one or multiple
58 # interfaces using the "bind" configuration directive, followed by one or
59 # more IP addresses.
ed9b544e »
2009-03-22 first commit
60 #
33c5f0a2 »
2013-07-08 Example redis.conf: bind to multiple interfaces documented.
61 # Examples:
62 #
63 # bind 192.168.1.100 10.0.0.1
ed9b544e »
2009-03-22 first commit
64 # bind 127.0.0.1
65
edae7899 »
2013-12-05 Fixed typos in redis.conf file.
66 # Specify the path for the Unix socket that will be used to listen for
5d10923f » pietern
2010-10-13 Rename variable sockpath to unixsocket
67 # incoming connections. There is no default, so Redis will not listen
68 # on a unix socket when not specified.
a5639e7d » pietern
2010-08-03 Change initialization to allow listening on both a port and socket
69 #
5d10923f » pietern
2010-10-13 Rename variable sockpath to unixsocket
70 # unixsocket /tmp/redis.sock
85238765 » florean
2011-10-10 Added a config directive for a Unix socket mask
71 # unixsocketperm 755
a5639e7d » pietern
2010-08-03 Change initialization to allow listening on both a port and socket
72
0150db36 » tmm1
2009-05-19 Allow timeout=0 config to disable client timeouts
73 # Close the connection after a client is idle for N seconds (0 to disable)
aba4adb7 »
2011-10-31 use timeout 0 by default, as this is a common source of problems.
74 timeout 0
ed9b544e »
2009-03-22 first commit
75
0a14a654 »
2013-02-08 tcp-keepalive option documented in redis.conf.
76 # TCP keepalive.
77 #
8a22934c »
2013-02-09 TCP keep-alive. Better documentation in redis.conf.
78 # If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
79 # of communication. This is useful for two reasons:
0a14a654 »
2013-02-08 tcp-keepalive option documented in redis.conf.
80 #
8a22934c »
2013-02-09 TCP keep-alive. Better documentation in redis.conf.
81 # 1) Detect dead peers.
82 # 2) Take the connection alive from the point of view of network
83 # equipment in the middle.
84 #
85 # On Linux, the specified value (in seconds) is the period used to send ACKs.
86 # Note that to close the connection the double of the time is needed.
87 # On other kernels the period depends on the kernel configuration.
88 #
89 # A reasonable value for this option is 60 seconds.
0a14a654 »
2013-02-08 tcp-keepalive option documented in redis.conf.
90 tcp-keepalive 0
91
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
92 # Specify the server verbosity level.
93 # This can be one of:
121f70cf »
2009-12-16 lzf compression switched off by default now, with config file option …
94 # debug (a lot of information, useful for development/testing)
38aba9a1 »
2010-01-06 a new default redis.conf
95 # verbose (many rarely useful info, but not a mess like the debug level)
121f70cf »
2009-12-16 lzf compression switched off by default now, with config file option …
96 # notice (moderately verbose, what you want in production probably)
97 # warning (only very important / critical messages are logged)
c6f9ee88 »
2011-11-30 default log level is now notice.
98 loglevel notice
121f70cf »
2009-12-16 lzf compression switched off by default now, with config file option …
99
edae7899 »
2013-12-05 Fixed typos in redis.conf file.
100 # Specify the log file name. Also the empty string can be used to force
029245fe »
2010-05-06 clarified a few messages in redis.conf
101 # Redis to log on the standard output. Note that if you use standard
121f70cf »
2009-12-16 lzf compression switched off by default now, with config file option …
102 # output for logging but daemonize, logs will be sent to /dev/null
180cfaae »
2013-05-15 Added a define for most configuration defaults.
103 logfile ""
121f70cf »
2009-12-16 lzf compression switched off by default now, with config file option …
104
e1a586ee » jonahharris
2010-12-09 syslog support
105 # To enable logging to the system logger, just set 'syslog-enabled' to yes,
106 # and optionally update the other syslog parameters to suit your needs.
107 # syslog-enabled no
108
109 # Specify the syslog identity.
110 # syslog-ident redis
111
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
112 # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
e1a586ee » jonahharris
2010-12-09 syslog support
113 # syslog-facility local0
114
121f70cf »
2009-12-16 lzf compression switched off by default now, with config file option …
115 # Set the number of databases. The default database is DB 0, you can select
116 # a different one on a per-connection basis using SELECT <dbid> where
117 # dbid is a number between 0 and 'databases'-1
118 databases 16
119
d62bbfda » Dieken
2013-11-30 CONFIG REWRITE: don't throw some options on config rewrite
120 ################################ SNAPSHOTTING ################################
121f70cf »
2009-12-16 lzf compression switched off by default now, with config file option …
121 #
ed9b544e »
2009-03-22 first commit
122 # Save the DB on disk:
123 #
124 # save <seconds> <changes>
125 #
126 # Will save the DB if both the given number of seconds and the given
127 # number of write operations against the DB occurred.
128 #
129 # In the example below the behaviour will be to save:
130 # after 900 sec (15 min) if at least 1 key changed
131 # after 300 sec (5 min) if at least 10 keys changed
132 # after 60 sec if at least 10000 keys changed
e7546c63 »
2010-01-05 BGREWRITEAOF now works with swapping on
133 #
134 # Note: you can disable saving at all commenting all the "save" lines.
4aac3ff2 »
2012-01-16 It is now posible to flush all the previous saving points in redis.co…
135 #
136 # It is also possible to remove all the previously configured save
137 # points by adding a save directive with a single empty string argument
138 # like in the following example:
139 #
140 # save ""
e7546c63 »
2010-01-05 BGREWRITEAOF now works with swapping on
141
38aba9a1 »
2010-01-06 a new default redis.conf
142 save 900 1
143 save 300 10
144 save 60 10000
ed9b544e »
2009-03-22 first commit
145
4d3bbf35 »
2012-03-07 By default Redis refuses writes with an error if the latest BGSAVE fa…
146 # By default Redis will stop accepting writes if RDB snapshots are enabled
147 # (at least one save point) and the latest background save failed.
edae7899 »
2013-12-05 Fixed typos in redis.conf file.
148 # This will make the user aware (in a hard way) that data is not persisting
4d3bbf35 »
2012-03-07 By default Redis refuses writes with an error if the latest BGSAVE fa…
149 # on disk properly, otherwise chances are that no one will notice and some
edae7899 »
2013-12-05 Fixed typos in redis.conf file.
150 # disaster will happen.
4d3bbf35 »
2012-03-07 By default Redis refuses writes with an error if the latest BGSAVE fa…
151 #
152 # If the background saving process will start working again Redis will
153 # automatically allow writes again.
154 #
155 # However if you have setup your proper monitoring of the Redis server
156 # and persistence, you may want to disable this feature so that Redis will
4c53178c » AnuragRamdasan
2013-12-05 Fixed grammar: 'usually' to 'usual'
157 # continue to work as usual even if there are problems with disk,
4d3bbf35 »
2012-03-07 By default Redis refuses writes with an error if the latest BGSAVE fa…
158 # permissions, and so forth.
159 stop-writes-on-bgsave-error yes
160
121f70cf »
2009-12-16 lzf compression switched off by default now, with config file option …
161 # Compress string objects using LZF when dump .rdb databases?
b0553789 »
2009-12-16 LZF compression re-enabled by default, but with INIT_HTAB set to 0 to…
162 # For default that's set to 'yes' as it's almost always a win.
163 # If you want to save some CPU in the saving child set it to 'no' but
164 # the dataset will likely be bigger if you have compressible values or keys.
165 rdbcompression yes
121f70cf »
2009-12-16 lzf compression switched off by default now, with config file option …
166
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
167 # Since version 5 of RDB a CRC64 checksum is placed at the end of the file.
39d1e350 »
2012-04-10 It is now possible to enable/disable RDB checksum computation from re…
168 # This makes the format more resistant to corruption but there is a performance
169 # hit to pay (around 10%) when saving and loading RDB files, so you can disable it
170 # for maximum performances.
171 #
172 # RDB files created with checksum disabled have a checksum of zero that will
173 # tell the loading code to skip the check.
174 rdbchecksum yes
175
b8b553c8 »
2009-04-27 ability to specify a different file name for the DB
176 # The filename where to dump the DB
177 dbfilename dump.rdb
178
029245fe »
2010-05-06 clarified a few messages in redis.conf
179 # The working directory.
180 #
181 # The DB will be written inside this directory, with the filename specified
182 # above using the 'dbfilename' configuration directive.
183 #
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
184 # The Append Only File will also be created inside this directory.
029245fe »
2010-05-06 clarified a few messages in redis.conf
185 #
186 # Note that you must specify a directory here, not a file name.
ed9b544e »
2009-03-22 first commit
187 dir ./
188
189 ################################# REPLICATION #################################
190
191 # Master-Slave replication. Use slaveof to make a Redis instance a copy of
192 # another Redis server. Note that the configuration is local to the slave
193 # so for example it is possible to configure the slave to save the DB with a
194 # different interval, or to listen to another port, and so on.
3f477979 »
2009-12-12 TODO list modified. What's planned for 1.4 is now written in the ston…
195 #
ed9b544e »
2009-03-22 first commit
196 # slaveof <masterip> <masterport>
197
3f477979 »
2009-12-12 TODO list modified. What's planned for 1.4 is now written in the ston…
198 # If the master is password protected (using the "requirepass" configuration
199 # directive below) it is possible to tell the slave to authenticate before
200 # starting the replication synchronization process, otherwise the master will
201 # refuse the slave request.
202 #
203 # masterauth <master-password>
204
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
205 # When a slave loses its connection with the master, or when the replication
4ebfc455 »
2010-11-04 config option to select if when replication link with master a slave …
206 # is still in progress, the slave can act in two different ways:
207 #
208 # 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
92a157ea » jerem
2011-11-21 Fixed a typo in comments.
209 # still reply to client requests, possibly with out of date data, or the
4ebfc455 »
2010-11-04 config option to select if when replication link with master a slave …
210 # data set may just be empty if this is the first synchronization.
211 #
a74056f1 » stamhe
2013-03-02 point 2 of slave-serve-stale-data miss '-' between 'stale' and 'data'
212 # 2) if slave-serve-stale-data is set to 'no' the slave will reply with
4ebfc455 »
2010-11-04 config option to select if when replication link with master a slave …
213 # an error "SYNC with master in progress" to all the kind of commands
214 # but to INFO and SLAVEOF.
215 #
216 slave-serve-stale-data yes
217
05406168 »
2012-03-20 Support for read-only slaves. Semantical fixes.
218 # You can configure a slave instance to accept writes or not. Writing against
219 # a slave instance may be useful to store some ephemeral data (because data
220 # written on a slave will be easily deleted after resync with the master) but
9aba884b »
2012-03-21 Comments about security of slave-read-only in redis.coinf.
221 # may also cause problems if clients are writing to it because of a
222 # misconfiguration.
05406168 »
2012-03-20 Support for read-only slaves. Semantical fixes.
223 #
224 # Since Redis 2.6 by default slaves are read-only.
9aba884b »
2012-03-21 Comments about security of slave-read-only in redis.coinf.
225 #
226 # Note: read only slaves are not designed to be exposed to untrusted clients
227 # on the internet. It's just a protection layer against misuse of the instance.
228 # Still a read only slave exports by default all the administrative commands
b67f39da » AnuragRamdasan
2013-12-05 fixed typo
229 # such as CONFIG, DEBUG, and so forth. To a limited extent you can improve
9aba884b »
2012-03-21 Comments about security of slave-read-only in redis.coinf.
230 # security of read only slaves using 'rename-command' to shadow all the
231 # administrative / dangerous commands.
05406168 »
2012-03-20 Support for read-only slaves. Semantical fixes.
232 slave-read-only yes
233
8996bf77 »
2011-10-31 7c6da73
234 # Slaves send PINGs to server in a predefined interval. It's possible to change
235 # this interval with the repl_ping_slave_period option. The default value is 10
236 # seconds.
237 #
f15e33a8 » Herbert G. Fischer
2011-10-18 fixed typo in comments
238 # repl-ping-slave-period 10
8996bf77 »
2011-10-31 7c6da73
239
75bf91ab »
2013-05-27 redis.conf updated: repl-timeout now uesd by masters as well.
240 # The following option sets the replication timeout for:
241 #
242 # 1) Bulk transfer I/O during SYNC, from the point of view of slave.
243 # 2) Master timeout from the point of view of slaves (data, pings).
244 # 3) Slave timeout from the point of view of masters (REPLCONF ACK pings).
8996bf77 »
2011-10-31 7c6da73
245 #
85ccd576 »
2011-10-31 added more clarifications in redis.conf about ther right value to set…
246 # It is important to make sure that this value is greater than the value
247 # specified for repl-ping-slave-period otherwise a timeout will be detected
248 # every time there is low traffic between the master and the slave.
249 #
f15e33a8 » Herbert G. Fischer
2011-10-18 fixed typo in comments
250 # repl-timeout 60
8996bf77 »
2011-10-31 7c6da73
251
5f7dff4d »
2013-01-31 TCP_NODELAY after SYNC: changes to the implementation.
252 # Disable TCP_NODELAY on the slave socket after SYNC?
253 #
254 # If you select "yes" Redis will use a smaller number of TCP packets and
255 # less bandwidth to send data to slaves. But this can add a delay for
256 # the data to appear on the slave side, up to 40 milliseconds with
257 # Linux kernels using a default configuration.
258 #
259 # If you select "no" the delay for data to appear on the slave side will
260 # be reduced but more bandwidth will be used for replication.
261 #
262 # By default we optimize for low latency, but in very high traffic conditions
263 # or when the master and slaves are many hops away, turning this to "yes" may
264 # be a good idea.
265 repl-disable-tcp-nodelay no
266
700e5eb4 »
2013-01-30 PSYNC: work in progress, preview #2, rebased to unstable.
267 # Set the replication backlog size. The backlog is a buffer that accumulates
268 # slave data when slaves are disconnected for some time, so that when a slave
269 # wants to reconnect again, often a full resync is not needed, but a partial
270 # resync is enough, just passing the portion of data the slave missed while
271 # disconnected.
272 #
273 # The biggest the replication backlog, the longer the time the slave can be
274 # disconnected and later be able to perform a partial resynchronization.
275 #
276 # The backlog is only allocated once there is at least a slave connected.
277 #
278 # repl-backlog-size 1mb
279
280 # After a master has no longer connected slaves for some time, the backlog
281 # will be freed. The following option configures the amount of seconds that
282 # need to elapse, starting from the time the last slave disconnected, for
283 # the backlog buffer to be freed.
284 #
285 # A value of 0 means to never release the backlog.
286 #
287 # repl-backlog-ttl 3600
288
851ac9d0 »
2012-08-28 Sentinel: added documentation about slave-priority in redis.conf
289 # The slave priority is an integer number published by Redis in the INFO output.
290 # It is used by Redis Sentinel in order to select a slave to promote into a
291 # master if the master is no longer working correctly.
292 #
293 # A slave with a low priority number is considered better for promotion, so
294 # for instance if there are three slaves with priority 10, 100, 25 Sentinel will
edae7899 »
2013-12-05 Fixed typos in redis.conf file.
295 # pick the one with priority 10, that is the lowest.
851ac9d0 »
2012-08-28 Sentinel: added documentation about slave-priority in redis.conf
296 #
297 # However a special priority of 0 marks the slave as not able to perform the
298 # role of master, so a slave with priority of 0 will never be selected by
299 # Redis Sentinel for promotion.
300 #
301 # By default the priority is 100.
302 slave-priority 100
303
fc2587ec »
2013-05-28 min-slaves-to-write: initial description of the feature in redis.conf
304 # It is possible for a master to stop accepting writes if there are less than
305 # N slaves connected, having a lag less or equal than M seconds.
306 #
307 # The N slaves need to be in "online" state.
308 #
309 # The lag in seconds, that must be <= the specified value, is calculated from
310 # the last ping received from the slave, that is usually sent every second.
311 #
312 # This option does not GUARANTEES that N replicas will accept the write, but
313 # will limit the window of exposure for lost writes in case not enough slaves
314 # are available, to the specified number of seconds.
315 #
316 # For example to require at least 3 slaves with a lag <= 10 seconds use:
317 #
d0d67f8d »
2013-05-29 min-slaves-to-write: don't accept writes with less than N replicas.
318 # min-slaves-to-write 3
319 # min-slaves-max-lag 10
320 #
321 # Setting one or the other to 0 disables the feature.
322 #
323 # By default min-slaves-to-write is set to 0 (feature disabled) and
324 # min-slaves-max-lag is set to 10.
fc2587ec »
2013-05-28 min-slaves-to-write: initial description of the feature in redis.conf
325
f2aa84bd »
2009-03-26 Lua client added thanks to Daniele Alessandri
326 ################################## SECURITY ###################################
327
328 # Require clients to issue AUTH <PASSWORD> before processing any other
329 # commands. This might be useful in environments in which you do not trust
330 # others with access to the host running redis-server.
331 #
332 # This should stay commented out for backward compatibility and because most
333 # people do not need auth (e.g. they run their own servers).
1b677732 »
2010-05-10 CONFIG now can change appendfsync policy at run time
334 #
335 # Warning: since Redis is pretty fast an outside user can try up to
336 # 150k passwords per second against a good box. This means that you should
337 # use a very strong password otherwise it will be very easy to break.
3f477979 »
2009-12-12 TODO list modified. What's planned for 1.4 is now written in the ston…
338 #
290deb8b »
2009-04-08 TODO changes, minor change to default redis.conf
339 # requirepass foobared
f2aa84bd »
2009-03-26 Lua client added thanks to Daniele Alessandri
340
8d3e063a »
2010-11-03 added support for command renaming/suppression in redis.conf
341 # Command renaming.
342 #
57c0cf8b » kashif
2011-12-28 Fixed some typos in redis.conf.
343 # It is possible to change the name of dangerous commands in a shared
8d3e063a »
2010-11-03 added support for command renaming/suppression in redis.conf
344 # environment. For instance the CONFIG command may be renamed into something
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
345 # hard to guess so that it will still be available for internal-use tools
346 # but not available for general clients.
8d3e063a »
2010-11-03 added support for command renaming/suppression in redis.conf
347 #
348 # Example:
349 #
350 # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
351 #
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
352 # It is also possible to completely kill a command by renaming it into
8d3e063a »
2010-11-03 added support for command renaming/suppression in redis.conf
353 # an empty string:
354 #
355 # rename-command CONFIG ""
deccd104 »
2013-03-06 Add a warning about command renaming in redis.conf.
356 #
357 # Please note that changing the name of commands that are logged into the
358 # AOF file or transmitted to slaves may cause problems.
8d3e063a »
2010-11-03 added support for command renaming/suppression in redis.conf
359
285add55 »
2009-05-25 maxclients implemented, see redis.conf for details
360 ################################### LIMITS ####################################
361
58732c23 »
2011-10-31 maxclients configuration is now implemented dealing with the actual p…
362 # Set the max number of connected clients at the same time. By default
363 # this limit is set to 10000 clients, however if the Redis server is not
1caf0939 » guiquanz
2013-01-17 Fixed many typos.
364 # able to configure the process file limit to allow for the specified limit
58732c23 »
2011-10-31 maxclients configuration is now implemented dealing with the actual p…
365 # the max number of allowed clients is set to the current file limit
366 # minus 32 (as Redis reserves a few file descriptors for internal uses).
367 #
285add55 »
2009-05-25 maxclients implemented, see redis.conf for details
368 # Once the limit is reached Redis will close all the new connections sending
369 # an error 'max number of clients reached'.
3f477979 »
2009-12-12 TODO list modified. What's planned for 1.4 is now written in the ston…
370 #
58732c23 »
2011-10-31 maxclients configuration is now implemented dealing with the actual p…
371 # maxclients 10000
285add55 »
2009-05-25 maxclients implemented, see redis.conf for details
372
3fd78bcd »
2009-05-27 maxmemory implemented
373 # Don't use more memory than the specified amount of bytes.
cebb7b92 »
2012-02-08 redis.conf updated with new maxmemory semantics
374 # When the memory limit is reached Redis will try to remove keys
bf307cfb »
2013-12-06 Fixed typo in redis.conf.
375 # according to the eviction policy selected (see maxmemory-policy).
cebb7b92 »
2012-02-08 redis.conf updated with new maxmemory semantics
376 #
377 # If Redis can't remove keys according to the policy, or if the policy is
378 # set to 'noeviction', Redis will start to reply with errors to commands
379 # that would use more memory, like SET, LPUSH, and so on, and will continue
380 # to reply to read-only commands like GET.
381 #
382 # This option is usually useful when using Redis as an LRU cache, or to set
edae7899 »
2013-12-05 Fixed typos in redis.conf file.
383 # a hard memory limit for an instance (using the 'noeviction' policy).
cebb7b92 »
2012-02-08 redis.conf updated with new maxmemory semantics
384 #
385 # WARNING: If you have slaves attached to an instance with maxmemory on,
386 # the size of the output buffers needed to feed the slaves are subtracted
387 # from the used memory count, so that network problems / resyncs will
388 # not trigger a loop where keys are evicted, and in turn the output
389 # buffer of slaves is full with DELs of keys evicted triggering the deletion
390 # of more keys, and so forth until the database is completely emptied.
3f477979 »
2009-12-12 TODO list modified. What's planned for 1.4 is now written in the ston…
391 #
f9ef912c »
2012-02-08 more practical maxmemory+slaves hint in redis.conf
392 # In short... if you have slaves attached it is suggested that you set a lower
393 # limit for maxmemory so that there is some free RAM on the system for slave
394 # output buffers (but this is not needed if the policy is 'noeviction').
395 #
3fd78bcd »
2009-05-27 maxmemory implemented
396 # maxmemory <bytes>
397
165346ca »
2010-10-14 implemented different algorithms for maxmemory
398 # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
399 # is reached. You can select among five behaviors:
165346ca »
2010-10-14 implemented different algorithms for maxmemory
400 #
401 # volatile-lru -> remove the key with an expire set using an LRU algorithm
402 # allkeys-lru -> remove any key accordingly to the LRU algorithm
403 # volatile-random -> remove a random key with an expire set
dfc25454 » quiver
2012-03-10 fix typo of redis.conf
404 # allkeys-random -> remove a random key, any key
165346ca »
2010-10-14 implemented different algorithms for maxmemory
405 # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
5402c426 »
2010-11-08 added noeviction policy to redis maxmemory. ZSCORE removed from the l…
406 # noeviction -> don't expire at all, just return an error on write operations
407 #
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
408 # Note: with any of the above policies, Redis will return an error on write
5402c426 »
2010-11-08 added noeviction policy to redis maxmemory. ZSCORE removed from the l…
409 # operations, when there are not suitable keys for eviction.
410 #
411 # At the date of writing this commands are: set setnx setex append
412 # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
413 # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
414 # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
415 # getset mset msetnx exec sort
416 #
417 # The default is:
165346ca »
2010-10-14 implemented different algorithms for maxmemory
418 #
419 # maxmemory-policy volatile-lru
420
421 # LRU and minimal TTL algorithms are not precise algorithms but approximated
422 # algorithms (in order to save memory), so you can select as well the sample
423 # size to check. For instance for default Redis will check three keys and
424 # pick the one that was used less recently, you can change the sample size
425 # using the following configuration directive.
426 #
a3687929 »
2010-10-15 maxmemory-samples implemented in CONFIG command and configuration file
427 # maxmemory-samples 3
165346ca »
2010-10-14 implemented different algorithms for maxmemory
428
44b38ef4 »
2009-10-30 Initial implementation of append-only mode. Loading still not impleme…
429 ############################## APPEND ONLY MODE ###############################
430
c11a01a0 »
2012-04-20 redis.conf AOF section comments improved.
431 # By default Redis asynchronously dumps the dataset on disk. This mode is
432 # good enough in many applications, but an issue with the Redis process or
433 # a power outage may result into a few minutes of writes lost (depending on
434 # the configured save points).
435 #
436 # The Append Only File is an alternative persistence mode that provides
437 # much better durability. For instance using the default data fsync policy
438 # (see later in the config file) Redis can lose just one second of writes in a
439 # dramatic event like a server power outage, or a single write if something
440 # wrong with the Redis process itself happens, but the operating system is
441 # still running correctly.
442 #
443 # AOF and RDB persistence can be enabled at the same time without problems.
444 # If the AOF is enabled on startup Redis will load the AOF, that is the file
445 # with the better durability guarantees.
446 #
447 # Please check http://redis.io/topics/persistence for more information.
44b38ef4 »
2009-10-30 Initial implementation of append-only mode. Loading still not impleme…
448
4e141d5a »
2009-10-30 append only mode is now able to translate EXPIRE into EXPIREAT transp…
449 appendonly no
44b38ef4 »
2009-10-30 Initial implementation of append-only mode. Loading still not impleme…
450
f3b52411 » pietern
2010-05-07 make append only filename configurable
451 # The name of the append only file (default: "appendonly.aof")
673c42bb »
2013-12-19 Example redis.conf formatted to better show appendfilename option.
452
453 appendfilename "appendonly.aof"
f3b52411 » pietern
2010-05-07 make append only filename configurable
454
4e141d5a »
2009-10-30 append only mode is now able to translate EXPIRE into EXPIREAT transp…
455 # The fsync() call tells the Operating System to actually write data on disk
48f0308a »
2009-10-30 support for appendonly mode no, always, everysec
456 # instead to wait for more data in the output buffer. Some OS will really flush
457 # data on disk, some other OS will just try to do it ASAP.
458 #
459 # Redis supports three different modes:
460 #
461 # no: don't fsync, just let the OS flush the data when it wants. Faster.
462 # always: fsync after every write to the append only log . Slow, Safest.
c11a01a0 »
2012-04-20 redis.conf AOF section comments improved.
463 # everysec: fsync only one time every second. Compromise.
48f0308a »
2009-10-30 support for appendonly mode no, always, everysec
464 #
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
465 # The default is "everysec", as that's usually the right compromise between
6766f45e »
2010-02-06 multi bulk requests in redis-benchmark, default fsync policy changed …
466 # speed and data safety. It's up to you to understand if you can relax this to
ce6628da » diegok
2011-12-22 Fixed a config docs typo.
467 # "no" that will let the operating system flush the output buffer when
6766f45e »
2010-02-06 multi bulk requests in redis-benchmark, default fsync policy changed …
468 # it wants, for better performances (but if you can live with the idea of
469 # some data loss consider the default persistence mode that's snapshotting),
470 # or on the contrary, use "always" that's very slow but a bit safer than
471 # everysec.
472 #
c11a01a0 »
2012-04-20 redis.conf AOF section comments improved.
473 # More details please check the following article:
474 # http://antirez.com/post/redis-persistence-demystified.html
475 #
6766f45e »
2010-02-06 multi bulk requests in redis-benchmark, default fsync policy changed …
476 # If unsure, use "everysec".
477
478 # appendfsync always
479 appendfsync everysec
4e141d5a »
2009-10-30 append only mode is now able to translate EXPIRE into EXPIREAT transp…
480 # appendfsync no
48f0308a »
2009-10-30 support for appendonly mode no, always, everysec
481
d5d23dab »
2010-05-28 redis.conf new features the new option, a minor typo preventing the c…
482 # When the AOF fsync policy is set to always or everysec, and a background
483 # saving process (a background save or AOF log background rewriting) is
484 # performing a lot of I/O against the disk, in some Linux configurations
485 # Redis may block too long on the fsync() call. Note that there is no fix for
486 # this currently, as even performing fsync in a different thread will block
487 # our synchronous write(2) call.
488 #
489 # In order to mitigate this problem it's possible to use the following option
490 # that will prevent fsync() from being called in the main process while a
491 # BGSAVE or BGREWRITEAOF is in progress.
492 #
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
493 # This means that while another child is saving, the durability of Redis is
494 # the same as "appendfsync none". In practical terms, this means that it is
495 # possible to lose up to 30 seconds of log in the worst scenario (with the
d5d23dab »
2010-05-28 redis.conf new features the new option, a minor typo preventing the c…
496 # default Linux settings).
497 #
498 # If you have latency problems turn this to "yes". Otherwise leave it as
499 # "no" that is the safest pick from the point of view of durability.
673c42bb »
2013-12-19 Example redis.conf formatted to better show appendfilename option.
500
d5d23dab »
2010-05-28 redis.conf new features the new option, a minor typo preventing the c…
501 no-appendfsync-on-rewrite no
502
b333e239 »
2011-06-10 automatic AOF rewrite first implementation. Still to be tested.
503 # Automatic rewrite of the append only file.
504 # Redis is able to automatically rewrite the log file implicitly calling
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
505 # BGREWRITEAOF when the AOF log size grows by the specified percentage.
b333e239 »
2011-06-10 automatic AOF rewrite first implementation. Still to be tested.
506 #
507 # This is how it works: Redis remembers the size of the AOF file after the
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
508 # latest rewrite (if no rewrite has happened since the restart, the size of
b333e239 »
2011-06-10 automatic AOF rewrite first implementation. Still to be tested.
509 # the AOF at startup is used).
510 #
511 # This base size is compared to the current size. If the current size is
512 # bigger than the specified percentage, the rewrite is triggered. Also
513 # you need to specify a minimal size for the AOF file to be rewritten, this
514 # is useful to avoid rewriting the AOF file even if the percentage increase
515 # is reached but it is still pretty small.
516 #
57c0cf8b » kashif
2011-12-28 Fixed some typos in redis.conf.
517 # Specify a percentage of zero in order to disable the automatic AOF
b333e239 »
2011-06-10 automatic AOF rewrite first implementation. Still to be tested.
518 # rewrite feature.
519
520 auto-aof-rewrite-percentage 100
521 auto-aof-rewrite-min-size 64mb
522
eeffcf38 »
2011-05-06 Lua scripts max execution time
523 ################################ LUA SCRIPTING ###############################
524
525 # Max execution time of a Lua script in milliseconds.
115e3ff3 »
2011-10-27 If a Lua script executes for more time than the max time specified in…
526 #
527 # If the maximum execution time is reached Redis will log that a script is
57c0cf8b » kashif
2011-12-28 Fixed some typos in redis.conf.
528 # still in execution after the maximum allowed time and will start to
115e3ff3 »
2011-10-27 If a Lua script executes for more time than the max time specified in…
529 # reply to queries with an error.
530 #
57c0cf8b » kashif
2011-12-28 Fixed some typos in redis.conf.
531 # When a long running script exceed the maximum execution time only the
0b14e441 »
2011-11-18 redis.conf updated to reflect the new scripting timeout semantics.
532 # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
533 # used to stop a script that did not yet called write commands. The second
534 # is the only way to shut down the server in the case a write commands was
535 # already issue by the script but the user don't want to wait for the natural
536 # termination of the script.
115e3ff3 »
2011-10-27 If a Lua script executes for more time than the max time specified in…
537 #
538 # Set it to 0 or a negative value for unlimited execution without warnings.
539 lua-time-limit 5000
eeffcf38 »
2011-05-06 Lua scripts max execution time
540
35a60441 »
2011-06-30 slow log configuration implemented
541 ################################## SLOW LOG ###################################
542
543 # The Redis Slow Log is a system to log queries that exceeded a specified
544 # execution time. The execution time does not include the I/O operations
545 # like talking with the client, sending the reply and so forth,
546 # but just the time needed to actually execute the command (this is the only
547 # stage of command execution where the thread is blocked and can not serve
548 # other requests in the meantime).
549 #
550 # You can configure the slow log with two parameters: one tells Redis
551 # what is the execution time, in microseconds, to exceed in order for the
552 # command to get logged, and the other parameter is the length of the
553 # slow log. When a new command is logged the oldest one is removed from the
554 # queue of logged commands.
555
de32c37c »
2011-06-30 More redis.conf self-documentation. Now even queries that took exactl…
556 # The following time is expressed in microseconds, so 1000000 is equivalent
557 # to one second. Note that a negative number disables the slow log, while
558 # a value of zero forces the logging of every command.
35a60441 »
2011-06-30 slow log configuration implemented
559 slowlog-log-slower-than 10000
de32c37c »
2011-06-30 More redis.conf self-documentation. Now even queries that took exactl…
560
561 # There is no limit to this length. Just be aware that it will consume memory.
562 # You can reclaim memory used by the slow log with SLOWLOG RESET.
590d55a2 »
2012-04-21 Limit memory used by big SLOWLOG entries.
563 slowlog-max-len 128
35a60441 »
2011-06-30 slow log configuration implemented
564
dc1c91a8 »
2014-07-02 Latency monitor trheshold value is now configurable.
565 ################################ LATENCY MONITOR ##############################
566
567 # The Redis latency monitoring subsystem samples different operations
568 # at runtime in order to collect data related to possible sources of
569 # latency of a Redis instance.
570 #
571 # Via the LATENCY command this information is available to the user that can
572 # print graphs and obtain reports.
573 #
574 # The system only logs operations that were performed in a time equal or
575 # greater than the amount of milliseconds specified via the
576 # latency-monitor-threshold configuration directive. When its value is set
577 # to zero, the latency monitor is turned off.
578 #
579 # By default latency monitoring is disabled since it is mostly not needed
580 # if you don't have latency issues, and collecting data has a performance
581 # impact, that while very small, can be measured under big load. Latency
582 # monitoring can easily be enalbed at runtime using the command
583 # "CONFIG SET latency-monitor-threshold <milliseconds>" if needed.
584 latency-monitor-threshold 0
585
212edbc4 »
2013-01-23 Keyspace events notification API.
586 ############################# Event notification ##############################
587
588 # Redis can notify Pub/Sub clients about events happening in the key space.
589 # This feature is documented at http://redis.io/topics/keyspace-events
590 #
591 # For instance if keyspace events notification is enabled, and a client
592 # performs a DEL operation on key "foo" stored in the Database 0, two
593 # messages will be published via Pub/Sub:
594 #
595 # PUBLISH __keyspace@0__:foo del
596 # PUBLISH __keyevent@0__:del foo
597 #
b9bc4f91 »
2013-01-25 Keyspace events: it is now possible to select subclasses of events.
598 # It is possible to select the events that Redis will notify among a set
599 # of classes. Every class is identified by a single character:
600 #
601 # K Keyspace events, published with __keyspace@<db>__ prefix.
602 # E Keyevent events, published with __keyevent@<db>__ prefix.
603 # g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
604 # $ String commands
605 # l List commands
606 # s Set commands
607 # h Hash commands
608 # z Sorted set commands
609 # x Expired events (events generated every time a key expires)
610 # e Evicted events (events generated when a key is evicted for maxmemory)
611 # A Alias for g$lshzxe, so that the "AKE" string means all the events.
612 #
613 # The "notify-keyspace-events" takes as argument a string that is composed
614 # by zero or multiple characters. The empty string means that notifications
615 # are disabled at all.
616 #
617 # Example: to enable list and generic events, from the point of view of the
618 # event name, use:
619 #
620 # notify-keyspace-events Elg
621 #
622 # Example 2: to get the stream of the expired keys subscribing to channel
623 # name __keyevent@0__:expired use:
624 #
625 # notify-keyspace-events Ex
626 #
627 # By default all notifications are disabled because most users don't need
628 # this feature and the feature has some overhead. Note that if you don't
629 # specify at least one of K or E, no events will be delivered.
630 notify-keyspace-events ""
212edbc4 »
2013-01-23 Keyspace events notification API.
631
ed9b544e »
2009-03-22 first commit
632 ############################### ADVANCED CONFIG ###############################
633
d3ea4c86 » pietern
2012-01-25 Update default configuration
634 # Hashes are encoded using a memory efficient data structure when they have a
635 # small number of entries, and the biggest entry does not exceed a given
636 # threshold. These thresholds can be configured using the following directives.
637 hash-max-ziplist-entries 512
638 hash-max-ziplist-value 64
b3f83f12 » jzawodn
2010-03-19 support for include directive in config parser
639
6a246b1e »
2010-12-14 special encoding limits redefined, and all the config options for spe…
640 # Similarly to hashes, small lists are also encoded in a special way in order
641 # to save a lot of space. The special representation is only used when
642 # you are under the following limits:
643 list-max-ziplist-entries 512
644 list-max-ziplist-value 64
645
646 # Sets have a special encoding in just one case: when a set is composed
647 # of just strings that happens to be integers in radix 10 in the range
648 # of 64 bit signed integers.
649 # The following configuration setting sets the limit in the size of the
650 # set in order to use this special memory saving encoding.
651 set-max-intset-entries 512
652
3ea204e1 » pietern
2011-03-09 Configurable thresholds for encoded sorted sets
653 # Similarly to hashes and lists, sorted sets are also specially encoded in
654 # order to save a lot of space. This encoding is only used when the length and
655 # elements of a sorted set are below the following limits:
656 zset-max-ziplist-entries 128
657 zset-max-ziplist-value 64
658
614fcd49 »
2014-04-15 User-defined switch point between sparse-dense HLL encodings.
659 # HyperLogLog sparse representation bytes limit. The limit includes the
660 # 16 bytes header. When an HyperLogLog using the sparse representation crosses
662f5057 » nirvdrum
2014-04-22 Fixed typos.
661 # this limit, it is converted into the dense representation.
614fcd49 »
2014-04-15 User-defined switch point between sparse-dense HLL encodings.
662 #
663 # A value greater than 16000 is totally useless, since at that point the
664 # dense representation is more memory efficient.
665 #
666 # The suggested value is ~ 3000 in order to have the benefits of
667 # the space efficient encoding without slowing down too much PFADD,
662f5057 » nirvdrum
2014-04-22 Fixed typos.
668 # which is O(N) with the sparse encoding. The value can be raised to
614fcd49 »
2014-04-15 User-defined switch point between sparse-dense HLL encodings.
669 # ~ 10000 when CPU is not a concern, but space is, and the data set is
670 # composed of many HyperLogLogs with cardinality in the 0 - 15000 range.
671 hll-sparse-max-bytes 3000
672
8ca3e9d1 »
2010-04-15 Active rehashing
673 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
674 # order to help rehashing the main Redis hash table (the one mapping top-level
57c0cf8b » kashif
2011-12-28 Fixed some typos in redis.conf.
675 # keys to values). The hash table implementation Redis uses (see dict.c)
edae7899 »
2013-12-05 Fixed typos in redis.conf file.
676 # performs a lazy rehashing: the more operation you run into a hash table
57c0cf8b » kashif
2011-12-28 Fixed some typos in redis.conf.
677 # that is rehashing, the more rehashing "steps" are performed, so if the
8ca3e9d1 »
2010-04-15 Active rehashing
678 # server is idle the rehashing is never complete and some more memory is used
679 # by the hash table.
680 #
681 # The default is to use this millisecond 10 times every second in order to
682 # active rehashing the main dictionaries, freeing memory when possible.
683 #
684 # If unsure:
685 # use "activerehashing no" if you have hard latency requirements and it is
686 # not a good thing in your environment that Redis can reply form time to time
687 # to queries with 2 milliseconds delay.
688 #
689 # use "activerehashing yes" if you don't have such hard requirements but
690 # want to free memory asap when possible.
691 activerehashing yes
692
c8a607f2 »
2012-01-24 client-output-buffer-limit documented in redis.conf
693 # The client output buffer limits can be used to force disconnection of clients
694 # that are not reading data from the server fast enough for some reason (a
695 # common reason is that a Pub/Sub client can't consume messages as fast as the
696 # publisher can produce them).
697 #
698 # The limit can be set differently for the three different classes of clients:
699 #
b6a26b52 »
2014-06-16 Client types generalized.
700 # normal -> normal clients including MONITOR clients
701 # slave -> slave clients
45c60a90 » Dieken
2013-11-30 fix typo in redis.conf and sentinel.conf
702 # pubsub -> clients subscribed to at least one pubsub channel or pattern
c8a607f2 »
2012-01-24 client-output-buffer-limit documented in redis.conf
703 #
704 # The syntax of every client-output-buffer-limit directive is the following:
705 #
3cbce4f4 »
2012-01-24 redis.conf typo fixed in the client-output-buffer-limit documentation
706 # client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
c8a607f2 »
2012-01-24 client-output-buffer-limit documented in redis.conf
707 #
708 # A client is immediately disconnected once the hard limit is reached, or if
709 # the soft limit is reached and remains reached for the specified number of
710 # seconds (continuously).
711 # So for instance if the hard limit is 32 megabytes and the soft limit is
712 # 16 megabytes / 10 seconds, the client will get disconnected immediately
713 # if the size of the output buffers reach 32 megabytes, but will also get
714 # disconnected if the client reaches 16 megabytes and continuously overcomes
715 # the limit for 10 seconds.
716 #
717 # By default normal clients are not limited because they don't receive data
718 # without asking (in a push way), but just after a request, so only
719 # asynchronous clients may create a scenario where data is requested faster
720 # than it can read.
721 #
722 # Instead there is a default limit for pubsub and slave clients, since
723 # subscribers and slaves receive data in a push fashion.
724 #
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
725 # Both the hard or the soft limit can be disabled by setting them to zero.
c8a607f2 »
2012-01-24 client-output-buffer-limit documented in redis.conf
726 client-output-buffer-limit normal 0 0 0
727 client-output-buffer-limit slave 256mb 64mb 60
728 client-output-buffer-limit pubsub 32mb 8mb 60
729
a6d117b6 »
2012-12-14 serverCron() frequency is now a runtime parameter (was REDIS_HZ).
730 # Redis calls an internal function to perform many background tasks, like
edae7899 »
2013-12-05 Fixed typos in redis.conf file.
731 # closing connections of clients in timeout, purging expired keys that are
a6d117b6 »
2012-12-14 serverCron() frequency is now a runtime parameter (was REDIS_HZ).
732 # never requested, and so forth.
733 #
44d0eac5 » davidcelis
2013-02-03 Fix a few typos and improve grammar of redis.conf
734 # Not all tasks are performed with the same frequency, but Redis checks for
a6d117b6 »
2012-12-14 serverCron() frequency is now a runtime parameter (was REDIS_HZ).
735 # tasks to perform accordingly to the specified "hz" value.
736 #
737 # By default "hz" is set to 10. Raising the value will use more CPU when
738 # Redis is idle, but at the same time will make Redis more responsive when
739 # there are many keys expiring at the same time, and timeouts may be
740 # handled with more precision.
741 #
742 # The range is between 1 and 500, however a value over 100 is usually not
743 # a good idea. Most users should use the default of 10 and raise this up to
744 # 100 only in environments where very low latency is required.
745 hz 10
746
b06f13e7 »
2013-04-24 Config option to turn AOF rewrite incremental fsync on/off.
747 # When a child rewrites the AOF file, if the following option is enabled
748 # the file will be fsync-ed every 32 MB of data generated. This is useful
749 # in order to commit the file to the disk more incrementally and avoid
750 # big latency spikes.
751 aof-rewrite-incremental-fsync yes
752
Something went wrong with that request. Please try again.