Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 418 lines (364 sloc) 17.697 kB
ed9b544 @antirez first commit
antirez authored
1 # Redis configuration file example
2
7232400 @antirez new units for bytes specification
antirez authored
3 # Note on units: when memory size is needed, it is possible to specifiy
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
ed9b544 @antirez first commit
antirez authored
15 # By default Redis does not run as a daemon. Use 'yes' if you need it.
16 # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
17 daemonize no
18
029245f @antirez clarified a few messages in redis.conf
antirez authored
19 # When running daemonized, Redis writes a pid file in /var/run/redis.pid by
20 # default. You can specify a custom pid file location here.
ed329fc @lucsky Allow to specify the pid file from the config file.
lucsky authored
21 pidfile /var/run/redis.pid
22
a5639e7 @pietern Change initialization to allow listening on both a port and socket
pietern authored
23 # Accept connections on the specified port, default is 6379.
a36d524 @antirez If port zero is specified, Redis will not listen for TCP connections
antirez authored
24 # If port 0 is specified Redis will not listen on a TCP socket.
ed9b544 @antirez first commit
antirez authored
25 port 6379
26
27 # If you want you can bind a single interface, if the bind option is not
029245f @antirez clarified a few messages in redis.conf
antirez authored
28 # specified all the interfaces will listen for incoming connections.
ed9b544 @antirez first commit
antirez authored
29 #
30 # bind 127.0.0.1
31
5d10923 @pietern Rename variable sockpath to unixsocket
pietern authored
32 # Specify the path for the unix socket that will be used to listen for
33 # incoming connections. There is no default, so Redis will not listen
34 # on a unix socket when not specified.
a5639e7 @pietern Change initialization to allow listening on both a port and socket
pietern authored
35 #
5d10923 @pietern Rename variable sockpath to unixsocket
pietern authored
36 # unixsocket /tmp/redis.sock
09cefcf @florean Added a config directive for a Unix socket mask
florean authored
37 # unixsocketperm 755
a5639e7 @pietern Change initialization to allow listening on both a port and socket
pietern authored
38
0150db3 @tmm1 Allow timeout=0 config to disable client timeouts
tmm1 authored
39 # Close the connection after a client is idle for N seconds (0 to disable)
18fe946 @antirez use timeout 0 by default, as this is a common source of problems.
antirez authored
40 timeout 0
ed9b544 @antirez first commit
antirez authored
41
121f70c @antirez lzf compression switched off by default now, with config file option …
antirez authored
42 # Set server verbosity to 'debug'
43 # it can be one of:
44 # debug (a lot of information, useful for development/testing)
38aba9a @antirez a new default redis.conf
antirez authored
45 # verbose (many rarely useful info, but not a mess like the debug level)
121f70c @antirez lzf compression switched off by default now, with config file option …
antirez authored
46 # notice (moderately verbose, what you want in production probably)
47 # warning (only very important / critical messages are logged)
38aba9a @antirez a new default redis.conf
antirez authored
48 loglevel verbose
121f70c @antirez lzf compression switched off by default now, with config file option …
antirez authored
49
50 # Specify the log file name. Also 'stdout' can be used to force
029245f @antirez clarified a few messages in redis.conf
antirez authored
51 # Redis to log on the standard output. Note that if you use standard
121f70c @antirez lzf compression switched off by default now, with config file option …
antirez authored
52 # output for logging but daemonize, logs will be sent to /dev/null
53 logfile stdout
54
e1a586e @jonahharris syslog support
jonahharris authored
55 # To enable logging to the system logger, just set 'syslog-enabled' to yes,
56 # and optionally update the other syslog parameters to suit your needs.
57 # syslog-enabled no
58
59 # Specify the syslog identity.
60 # syslog-ident redis
61
62 # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
63 # syslog-facility local0
64
121f70c @antirez lzf compression switched off by default now, with config file option …
antirez authored
65 # Set the number of databases. The default database is DB 0, you can select
66 # a different one on a per-connection basis using SELECT <dbid> where
67 # dbid is a number between 0 and 'databases'-1
68 databases 16
69
70 ################################ SNAPSHOTTING #################################
71 #
ed9b544 @antirez first commit
antirez authored
72 # Save the DB on disk:
73 #
74 # save <seconds> <changes>
75 #
76 # Will save the DB if both the given number of seconds and the given
77 # number of write operations against the DB occurred.
78 #
79 # In the example below the behaviour will be to save:
80 # after 900 sec (15 min) if at least 1 key changed
81 # after 300 sec (5 min) if at least 10 keys changed
82 # after 60 sec if at least 10000 keys changed
e7546c6 @antirez BGREWRITEAOF now works with swapping on
antirez authored
83 #
84 # Note: you can disable saving at all commenting all the "save" lines.
85
38aba9a @antirez a new default redis.conf
antirez authored
86 save 900 1
87 save 300 10
88 save 60 10000
ed9b544 @antirez first commit
antirez authored
89
121f70c @antirez lzf compression switched off by default now, with config file option …
antirez authored
90 # Compress string objects using LZF when dump .rdb databases?
b055378 @antirez LZF compression re-enabled by default, but with INIT_HTAB set to 0 to…
antirez authored
91 # For default that's set to 'yes' as it's almost always a win.
92 # If you want to save some CPU in the saving child set it to 'no' but
93 # the dataset will likely be bigger if you have compressible values or keys.
94 rdbcompression yes
121f70c @antirez lzf compression switched off by default now, with config file option …
antirez authored
95
b8b553c @antirez ability to specify a different file name for the DB
antirez authored
96 # The filename where to dump the DB
97 dbfilename dump.rdb
98
029245f @antirez clarified a few messages in redis.conf
antirez authored
99 # The working directory.
100 #
101 # The DB will be written inside this directory, with the filename specified
102 # above using the 'dbfilename' configuration directive.
103 #
104 # Also the Append Only File will be created inside this directory.
105 #
106 # Note that you must specify a directory here, not a file name.
ed9b544 @antirez first commit
antirez authored
107 dir ./
108
109 ################################# REPLICATION #################################
110
111 # Master-Slave replication. Use slaveof to make a Redis instance a copy of
112 # another Redis server. Note that the configuration is local to the slave
113 # so for example it is possible to configure the slave to save the DB with a
114 # different interval, or to listen to another port, and so on.
3f47797 @antirez TODO list modified. What's planned for 1.4 is now written in the ston…
antirez authored
115 #
ed9b544 @antirez first commit
antirez authored
116 # slaveof <masterip> <masterport>
117
3f47797 @antirez TODO list modified. What's planned for 1.4 is now written in the ston…
antirez authored
118 # If the master is password protected (using the "requirepass" configuration
119 # directive below) it is possible to tell the slave to authenticate before
120 # starting the replication synchronization process, otherwise the master will
121 # refuse the slave request.
122 #
123 # masterauth <master-password>
124
4ebfc45 @antirez config option to select if when replication link with master a slave …
antirez authored
125 # When a slave lost the connection with the master, or when the replication
126 # is still in progress, the slave can act in two different ways:
127 #
128 # 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
129 # still reply to client requests, possibly with out of data data, or the
130 # data set may just be empty if this is the first synchronization.
131 #
132 # 2) if slave-serve-stale data is set to 'no' the slave will reply with
133 # an error "SYNC with master in progress" to all the kind of commands
134 # but to INFO and SLAVEOF.
135 #
136 slave-serve-stale-data yes
137
7c6da73 Added repl_ping_slave_period and repl_timeout options support
Herbert G. Fischer authored
138 # Slaves send PINGs to server in a predefined interval. It's possible to change
139 # this interval with the repl_ping_slave_period option. The default value is 10
140 # seconds.
141 #
421f6af fixed typo in comments
Herbert G. Fischer authored
142 # repl-ping-slave-period 10
7c6da73 Added repl_ping_slave_period and repl_timeout options support
Herbert G. Fischer authored
143
144 # The following option sets a timeout for both Bulk transfer I/O timeout and
145 # master data or ping response timeout. The default value is 60 seconds.
146 #
9e68987 @antirez added more clarifications in redis.conf about ther right value to set…
antirez authored
147 # It is important to make sure that this value is greater than the value
148 # specified for repl-ping-slave-period otherwise a timeout will be detected
149 # every time there is low traffic between the master and the slave.
150 #
421f6af fixed typo in comments
Herbert G. Fischer authored
151 # repl-timeout 60
7c6da73 Added repl_ping_slave_period and repl_timeout options support
Herbert G. Fischer authored
152
f2aa84b @antirez Lua client added thanks to Daniele Alessandri
antirez authored
153 ################################## SECURITY ###################################
154
155 # Require clients to issue AUTH <PASSWORD> before processing any other
156 # commands. This might be useful in environments in which you do not trust
157 # others with access to the host running redis-server.
158 #
159 # This should stay commented out for backward compatibility and because most
160 # people do not need auth (e.g. they run their own servers).
1b67773 @antirez CONFIG now can change appendfsync policy at run time
antirez authored
161 #
162 # Warning: since Redis is pretty fast an outside user can try up to
163 # 150k passwords per second against a good box. This means that you should
164 # use a very strong password otherwise it will be very easy to break.
3f47797 @antirez TODO list modified. What's planned for 1.4 is now written in the ston…
antirez authored
165 #
290deb8 @antirez TODO changes, minor change to default redis.conf
antirez authored
166 # requirepass foobared
f2aa84b @antirez Lua client added thanks to Daniele Alessandri
antirez authored
167
8d3e063 @antirez added support for command renaming/suppression in redis.conf
antirez authored
168 # Command renaming.
169 #
170 # It is possilbe to change the name of dangerous commands in a shared
171 # environment. For instance the CONFIG command may be renamed into something
172 # of hard to guess so that it will be still available for internal-use
173 # tools but not available for general clients.
174 #
175 # Example:
176 #
177 # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
178 #
179 # It is also possilbe to completely kill a command renaming it into
180 # an empty string:
181 #
182 # rename-command CONFIG ""
183
285add5 @antirez maxclients implemented, see redis.conf for details
antirez authored
184 ################################### LIMITS ####################################
185
186 # Set the max number of connected clients at the same time. By default there
187 # is no limit, and it's up to the number of file descriptors the Redis process
92f8e88 @antirez non-blocking VM data structures, just a start
antirez authored
188 # is able to open. The special value '0' means no limits.
285add5 @antirez maxclients implemented, see redis.conf for details
antirez authored
189 # Once the limit is reached Redis will close all the new connections sending
190 # an error 'max number of clients reached'.
3f47797 @antirez TODO list modified. What's planned for 1.4 is now written in the ston…
antirez authored
191 #
285add5 @antirez maxclients implemented, see redis.conf for details
antirez authored
192 # maxclients 128
193
3fd78bc @antirez maxmemory implemented
antirez authored
194 # Don't use more memory than the specified amount of bytes.
662f25e @antirez redis.conf updated with new maxmemory semantics
antirez authored
195 # When the memory limit is reached Redis will try to remove keys
196 # accordingly to the eviction policy selected (see maxmemmory-policy).
197 #
198 # If Redis can't remove keys according to the policy, or if the policy is
199 # set to 'noeviction', Redis will start to reply with errors to commands
200 # that would use more memory, like SET, LPUSH, and so on, and will continue
201 # to reply to read-only commands like GET.
202 #
203 # This option is usually useful when using Redis as an LRU cache, or to set
204 # an hard memory limit for an instance (using the 'noeviction' policy).
205 #
206 # WARNING: If you have slaves attached to an instance with maxmemory on,
207 # the size of the output buffers needed to feed the slaves are subtracted
208 # from the used memory count, so that network problems / resyncs will
209 # not trigger a loop where keys are evicted, and in turn the output
210 # buffer of slaves is full with DELs of keys evicted triggering the deletion
211 # of more keys, and so forth until the database is completely emptied.
3f47797 @antirez TODO list modified. What's planned for 1.4 is now written in the ston…
antirez authored
212 #
31f9f98 @antirez more practical maxmemory+slaves hint in redis.conf
antirez authored
213 # In short... if you have slaves attached it is suggested that you set a lower
214 # limit for maxmemory so that there is some free RAM on the system for slave
215 # output buffers (but this is not needed if the policy is 'noeviction').
3f47797 @antirez TODO list modified. What's planned for 1.4 is now written in the ston…
antirez authored
216 #
3fd78bc @antirez maxmemory implemented
antirez authored
217 # maxmemory <bytes>
218
165346c @antirez implemented different algorithms for maxmemory
antirez authored
219 # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
220 # is reached? You can select among five behavior:
221 #
222 # volatile-lru -> remove the key with an expire set using an LRU algorithm
223 # allkeys-lru -> remove any key accordingly to the LRU algorithm
224 # volatile-random -> remove a random key with an expire set
225 # allkeys->random -> remove a random key, any key
226 # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
5402c42 @antirez added noeviction policy to redis maxmemory. ZSCORE removed from the l…
antirez authored
227 # noeviction -> don't expire at all, just return an error on write operations
228 #
229 # Note: with all the kind of policies, Redis will return an error on write
230 # operations, when there are not suitable keys for eviction.
231 #
232 # At the date of writing this commands are: set setnx setex append
233 # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
234 # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
235 # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
236 # getset mset msetnx exec sort
237 #
238 # The default is:
165346c @antirez implemented different algorithms for maxmemory
antirez authored
239 #
240 # maxmemory-policy volatile-lru
241
242 # LRU and minimal TTL algorithms are not precise algorithms but approximated
243 # algorithms (in order to save memory), so you can select as well the sample
244 # size to check. For instance for default Redis will check three keys and
245 # pick the one that was used less recently, you can change the sample size
246 # using the following configuration directive.
247 #
a368792 @antirez maxmemory-samples implemented in CONFIG command and configuration file
antirez authored
248 # maxmemory-samples 3
165346c @antirez implemented different algorithms for maxmemory
antirez authored
249
44b38ef @antirez Initial implementation of append-only mode. Loading still not impleme…
antirez authored
250 ############################## APPEND ONLY MODE ###############################
251
252 # By default Redis asynchronously dumps the dataset on disk. If you can live
253 # with the idea that the latest records will be lost if something like a crash
254 # happens this is the preferred way to run Redis. If instead you care a lot
255 # about your data and don't want to that a single record can get lost you should
256 # enable the append only mode: when this mode is enabled Redis will append
4005fef @antirez Now PUBLISH commands are replicated to slaves
antirez authored
257 # every write operation received in the file appendonly.aof. This file will
44b38ef @antirez Initial implementation of append-only mode. Loading still not impleme…
antirez authored
258 # be read on startup in order to rebuild the full dataset in memory.
259 #
260 # Note that you can have both the async dumps and the append only file if you
261 # like (you have to comment the "save" statements above to disable the dumps).
262 # Still if append only mode is enabled Redis will load the data from the
263 # log file at startup ignoring the dump.rdb file.
0154acd @antirez appendfsync is now set to NO by default
antirez authored
264 #
49b99ab @antirez Changed the reply of BGSAVE and BGREWRITEAOF from +OK to a more meani…
antirez authored
265 # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
266 # log file in background when it gets too big.
44b38ef @antirez Initial implementation of append-only mode. Loading still not impleme…
antirez authored
267
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transp…
antirez authored
268 appendonly no
44b38ef @antirez Initial implementation of append-only mode. Loading still not impleme…
antirez authored
269
f3b5241 @pietern make append only filename configurable
pietern authored
270 # The name of the append only file (default: "appendonly.aof")
271 # appendfilename appendonly.aof
272
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transp…
antirez authored
273 # The fsync() call tells the Operating System to actually write data on disk
48f0308 @antirez support for appendonly mode no, always, everysec
antirez authored
274 # instead to wait for more data in the output buffer. Some OS will really flush
275 # data on disk, some other OS will just try to do it ASAP.
276 #
277 # Redis supports three different modes:
278 #
279 # no: don't fsync, just let the OS flush the data when it wants. Faster.
280 # always: fsync after every write to the append only log . Slow, Safest.
281 # everysec: fsync only if one second passed since the last fsync. Compromise.
282 #
6766f45 @antirez multi bulk requests in redis-benchmark, default fsync policy changed …
antirez authored
283 # The default is "everysec" that's usually the right compromise between
284 # speed and data safety. It's up to you to understand if you can relax this to
285 # "no" that will will let the operating system flush the output buffer when
286 # it wants, for better performances (but if you can live with the idea of
287 # some data loss consider the default persistence mode that's snapshotting),
288 # or on the contrary, use "always" that's very slow but a bit safer than
289 # everysec.
290 #
291 # If unsure, use "everysec".
292
293 # appendfsync always
294 appendfsync everysec
4e141d5 @antirez append only mode is now able to translate EXPIRE into EXPIREAT transp…
antirez authored
295 # appendfsync no
48f0308 @antirez support for appendonly mode no, always, everysec
antirez authored
296
d5d23da @antirez redis.conf new features the new option, a minor typo preventing the c…
antirez authored
297 # When the AOF fsync policy is set to always or everysec, and a background
298 # saving process (a background save or AOF log background rewriting) is
299 # performing a lot of I/O against the disk, in some Linux configurations
300 # Redis may block too long on the fsync() call. Note that there is no fix for
301 # this currently, as even performing fsync in a different thread will block
302 # our synchronous write(2) call.
303 #
304 # In order to mitigate this problem it's possible to use the following option
305 # that will prevent fsync() from being called in the main process while a
306 # BGSAVE or BGREWRITEAOF is in progress.
307 #
308 # This means that while another child is saving the durability of Redis is
309 # the same as "appendfsync none", that in pratical terms means that it is
310 # possible to lost up to 30 seconds of log in the worst scenario (with the
311 # default Linux settings).
312 #
313 # If you have latency problems turn this to "yes". Otherwise leave it as
314 # "no" that is the safest pick from the point of view of durability.
315 no-appendfsync-on-rewrite no
316
61751a4 @antirez AOF auto rewrite backported to 2.4
antirez authored
317 # Automatic rewrite of the append only file.
318 # Redis is able to automatically rewrite the log file implicitly calling
319 # BGREWRITEAOF when the AOF log size will growth by the specified percentage.
320 #
321 # This is how it works: Redis remembers the size of the AOF file after the
322 # latest rewrite (or if no rewrite happened since the restart, the size of
323 # the AOF at startup is used).
324 #
325 # This base size is compared to the current size. If the current size is
326 # bigger than the specified percentage, the rewrite is triggered. Also
327 # you need to specify a minimal size for the AOF file to be rewritten, this
328 # is useful to avoid rewriting the AOF file even if the percentage increase
329 # is reached but it is still pretty small.
330 #
331 # Specify a precentage of zero in order to disable the automatic AOF
332 # rewrite feature.
333
334 auto-aof-rewrite-percentage 100
335 auto-aof-rewrite-min-size 64mb
336
99509ab @antirez slow log merged into 2.4
antirez authored
337 ################################## SLOW LOG ###################################
338
339 # The Redis Slow Log is a system to log queries that exceeded a specified
340 # execution time. The execution time does not include the I/O operations
341 # like talking with the client, sending the reply and so forth,
342 # but just the time needed to actually execute the command (this is the only
343 # stage of command execution where the thread is blocked and can not serve
344 # other requests in the meantime).
345 #
346 # You can configure the slow log with two parameters: one tells Redis
347 # what is the execution time, in microseconds, to exceed in order for the
348 # command to get logged, and the other parameter is the length of the
349 # slow log. When a new command is logged the oldest one is removed from the
350 # queue of logged commands.
351
352 # The following time is expressed in microseconds, so 1000000 is equivalent
353 # to one second. Note that a negative number disables the slow log, while
354 # a value of zero forces the logging of every command.
355 slowlog-log-slower-than 10000
356
357 # There is no limit to this length. Just be aware that it will consume memory.
358 # You can reclaim memory used by the slow log with SLOWLOG RESET.
847fc09 @antirez Fixed typo in redis.conf related to slow log parameters
antirez authored
359 slowlog-max-len 1024
99509ab @antirez slow log merged into 2.4
antirez authored
360
ed9b544 @antirez first commit
antirez authored
361 ############################### ADVANCED CONFIG ###############################
362
cbba7dd @antirez HSET fixes, now the new pointer is stored back in the object pointer …
antirez authored
363 # Hashes are encoded in a special way (much more memory efficient) when they
364 # have at max a given numer of elements, and the biggest element does not
365 # exceed a given threshold. You can configure this limits with the following
366 # configuration directives.
99677e8 @antirez default hash encoding settings also fixed in redis.conf
antirez authored
367 hash-max-zipmap-entries 512
368 hash-max-zipmap-value 64
b3f83f1 @jzawodn support for include directive in config parser
jzawodn authored
369
6a246b1 @antirez special encoding limits redefined, and all the config options for spe…
antirez authored
370 # Similarly to hashes, small lists are also encoded in a special way in order
371 # to save a lot of space. The special representation is only used when
372 # you are under the following limits:
373 list-max-ziplist-entries 512
374 list-max-ziplist-value 64
375
376 # Sets have a special encoding in just one case: when a set is composed
377 # of just strings that happens to be integers in radix 10 in the range
378 # of 64 bit signed integers.
379 # The following configuration setting sets the limit in the size of the
380 # set in order to use this special memory saving encoding.
381 set-max-intset-entries 512
382
eab8382 @pietern Configurable thresholds for encoded sorted sets
pietern authored
383 # Similarly to hashes and lists, sorted sets are also specially encoded in
384 # order to save a lot of space. This encoding is only used when the length and
385 # elements of a sorted set are below the following limits:
386 zset-max-ziplist-entries 128
387 zset-max-ziplist-value 64
388
8ca3e9d @antirez Active rehashing
antirez authored
389 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
390 # order to help rehashing the main Redis hash table (the one mapping top-level
391 # keys to values). The hash table implementation redis uses (see dict.c)
392 # performs a lazy rehashing: the more operation you run into an hash table
393 # that is rhashing, the more rehashing "steps" are performed, so if the
394 # server is idle the rehashing is never complete and some more memory is used
395 # by the hash table.
396 #
397 # The default is to use this millisecond 10 times every second in order to
398 # active rehashing the main dictionaries, freeing memory when possible.
399 #
400 # If unsure:
401 # use "activerehashing no" if you have hard latency requirements and it is
402 # not a good thing in your environment that Redis can reply form time to time
403 # to queries with 2 milliseconds delay.
404 #
405 # use "activerehashing yes" if you don't have such hard requirements but
406 # want to free memory asap when possible.
407 activerehashing yes
408
b3f83f1 @jzawodn support for include directive in config parser
jzawodn authored
409 ################################## INCLUDES ###################################
410
411 # Include one or more other config files here. This is useful if you
412 # have a standard template that goes to all redis server but also need
413 # to customize a few per-server settings. Include files can include
414 # other files, so use this wisely.
415 #
416 # include /path/to/local.conf
417 # include /path/to/other.conf
Something went wrong with that request. Please try again.