]> git.saurik.com Git - redis.git/blob - redis.conf
Add stdint.h in endianconv.h to fix issue #336.
[redis.git] / redis.conf
1 # Redis configuration file example
2
3 # Note on units: when memory size is needed, it is possible to specify
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
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
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.
21 pidfile /var/run/redis.pid
22
23 # Accept connections on the specified port, default is 6379.
24 # If port 0 is specified Redis will not listen on a TCP socket.
25 port 6379
26
27 # If you want you can bind a single interface, if the bind option is not
28 # specified all the interfaces will listen for incoming connections.
29 #
30 # bind 127.0.0.1
31
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.
35 #
36 # unixsocket /tmp/redis.sock
37 # unixsocketperm 755
38
39 # Close the connection after a client is idle for N seconds (0 to disable)
40 timeout 0
41
42 # Set server verbosity to 'debug'
43 # it can be one of:
44 # debug (a lot of information, useful for development/testing)
45 # verbose (many rarely useful info, but not a mess like the debug level)
46 # notice (moderately verbose, what you want in production probably)
47 # warning (only very important / critical messages are logged)
48 loglevel notice
49
50 # Specify the log file name. Also 'stdout' can be used to force
51 # Redis to log on the standard output. Note that if you use standard
52 # output for logging but daemonize, logs will be sent to /dev/null
53 logfile stdout
54
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
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 #
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
83 #
84 # Note: you can disable saving at all commenting all the "save" lines.
85 #
86 # It is also possible to remove all the previously configured save
87 # points by adding a save directive with a single empty string argument
88 # like in the following example:
89 #
90 # save ""
91
92 save 900 1
93 save 300 10
94 save 60 10000
95
96 # Compress string objects using LZF when dump .rdb databases?
97 # For default that's set to 'yes' as it's almost always a win.
98 # If you want to save some CPU in the saving child set it to 'no' but
99 # the dataset will likely be bigger if you have compressible values or keys.
100 rdbcompression yes
101
102 # The filename where to dump the DB
103 dbfilename dump.rdb
104
105 # The working directory.
106 #
107 # The DB will be written inside this directory, with the filename specified
108 # above using the 'dbfilename' configuration directive.
109 #
110 # Also the Append Only File will be created inside this directory.
111 #
112 # Note that you must specify a directory here, not a file name.
113 dir ./
114
115 ################################# REPLICATION #################################
116
117 # Master-Slave replication. Use slaveof to make a Redis instance a copy of
118 # another Redis server. Note that the configuration is local to the slave
119 # so for example it is possible to configure the slave to save the DB with a
120 # different interval, or to listen to another port, and so on.
121 #
122 # slaveof <masterip> <masterport>
123
124 # If the master is password protected (using the "requirepass" configuration
125 # directive below) it is possible to tell the slave to authenticate before
126 # starting the replication synchronization process, otherwise the master will
127 # refuse the slave request.
128 #
129 # masterauth <master-password>
130
131 # When a slave lost the connection with the master, or when the replication
132 # is still in progress, the slave can act in two different ways:
133 #
134 # 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
135 # still reply to client requests, possibly with out of date data, or the
136 # data set may just be empty if this is the first synchronization.
137 #
138 # 2) if slave-serve-stale data is set to 'no' the slave will reply with
139 # an error "SYNC with master in progress" to all the kind of commands
140 # but to INFO and SLAVEOF.
141 #
142 slave-serve-stale-data yes
143
144 # Slaves send PINGs to server in a predefined interval. It's possible to change
145 # this interval with the repl_ping_slave_period option. The default value is 10
146 # seconds.
147 #
148 # repl-ping-slave-period 10
149
150 # The following option sets a timeout for both Bulk transfer I/O timeout and
151 # master data or ping response timeout. The default value is 60 seconds.
152 #
153 # It is important to make sure that this value is greater than the value
154 # specified for repl-ping-slave-period otherwise a timeout will be detected
155 # every time there is low traffic between the master and the slave.
156 #
157 # repl-timeout 60
158
159 ################################## SECURITY ###################################
160
161 # Require clients to issue AUTH <PASSWORD> before processing any other
162 # commands. This might be useful in environments in which you do not trust
163 # others with access to the host running redis-server.
164 #
165 # This should stay commented out for backward compatibility and because most
166 # people do not need auth (e.g. they run their own servers).
167 #
168 # Warning: since Redis is pretty fast an outside user can try up to
169 # 150k passwords per second against a good box. This means that you should
170 # use a very strong password otherwise it will be very easy to break.
171 #
172 # requirepass foobared
173
174 # Command renaming.
175 #
176 # It is possible to change the name of dangerous commands in a shared
177 # environment. For instance the CONFIG command may be renamed into something
178 # of hard to guess so that it will be still available for internal-use
179 # tools but not available for general clients.
180 #
181 # Example:
182 #
183 # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
184 #
185 # It is also possible to completely kill a command renaming it into
186 # an empty string:
187 #
188 # rename-command CONFIG ""
189
190 ################################### LIMITS ####################################
191
192 # Set the max number of connected clients at the same time. By default
193 # this limit is set to 10000 clients, however if the Redis server is not
194 # able ot configure the process file limit to allow for the specified limit
195 # the max number of allowed clients is set to the current file limit
196 # minus 32 (as Redis reserves a few file descriptors for internal uses).
197 #
198 # Once the limit is reached Redis will close all the new connections sending
199 # an error 'max number of clients reached'.
200 #
201 # maxclients 10000
202
203 # Don't use more memory than the specified amount of bytes.
204 # When the memory limit is reached Redis will try to remove keys with an
205 # EXPIRE set. It will try to start freeing keys that are going to expire
206 # in little time and preserve keys with a longer time to live.
207 # Redis will also try to remove objects from free lists if possible.
208 #
209 # If all this fails, Redis will start to reply with errors to commands
210 # that will use more memory, like SET, LPUSH, and so on, and will continue
211 # to reply to most read-only commands like GET.
212 #
213 # WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
214 # 'state' server or cache, not as a real DB. When Redis is used as a real
215 # database the memory usage will grow over the weeks, it will be obvious if
216 # it is going to use too much memory in the long run, and you'll have the time
217 # to upgrade. With maxmemory after the limit is reached you'll start to get
218 # errors for write operations, and this may even lead to DB inconsistency.
219 #
220 # maxmemory <bytes>
221
222 # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
223 # is reached? You can select among five behavior:
224 #
225 # volatile-lru -> remove the key with an expire set using an LRU algorithm
226 # allkeys-lru -> remove any key accordingly to the LRU algorithm
227 # volatile-random -> remove a random key with an expire set
228 # allkeys->random -> remove a random key, any key
229 # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
230 # noeviction -> don't expire at all, just return an error on write operations
231 #
232 # Note: with all the kind of policies, Redis will return an error on write
233 # operations, when there are not suitable keys for eviction.
234 #
235 # At the date of writing this commands are: set setnx setex append
236 # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
237 # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
238 # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
239 # getset mset msetnx exec sort
240 #
241 # The default is:
242 #
243 # maxmemory-policy volatile-lru
244
245 # LRU and minimal TTL algorithms are not precise algorithms but approximated
246 # algorithms (in order to save memory), so you can select as well the sample
247 # size to check. For instance for default Redis will check three keys and
248 # pick the one that was used less recently, you can change the sample size
249 # using the following configuration directive.
250 #
251 # maxmemory-samples 3
252
253 ############################## APPEND ONLY MODE ###############################
254
255 # By default Redis asynchronously dumps the dataset on disk. If you can live
256 # with the idea that the latest records will be lost if something like a crash
257 # happens this is the preferred way to run Redis. If instead you care a lot
258 # about your data and don't want to that a single record can get lost you should
259 # enable the append only mode: when this mode is enabled Redis will append
260 # every write operation received in the file appendonly.aof. This file will
261 # be read on startup in order to rebuild the full dataset in memory.
262 #
263 # Note that you can have both the async dumps and the append only file if you
264 # like (you have to comment the "save" statements above to disable the dumps).
265 # Still if append only mode is enabled Redis will load the data from the
266 # log file at startup ignoring the dump.rdb file.
267 #
268 # IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
269 # log file in background when it gets too big.
270
271 appendonly no
272
273 # The name of the append only file (default: "appendonly.aof")
274 # appendfilename appendonly.aof
275
276 # The fsync() call tells the Operating System to actually write data on disk
277 # instead to wait for more data in the output buffer. Some OS will really flush
278 # data on disk, some other OS will just try to do it ASAP.
279 #
280 # Redis supports three different modes:
281 #
282 # no: don't fsync, just let the OS flush the data when it wants. Faster.
283 # always: fsync after every write to the append only log . Slow, Safest.
284 # everysec: fsync only if one second passed since the last fsync. Compromise.
285 #
286 # The default is "everysec" that's usually the right compromise between
287 # speed and data safety. It's up to you to understand if you can relax this to
288 # "no" that will let the operating system flush the output buffer when
289 # it wants, for better performances (but if you can live with the idea of
290 # some data loss consider the default persistence mode that's snapshotting),
291 # or on the contrary, use "always" that's very slow but a bit safer than
292 # everysec.
293 #
294 # If unsure, use "everysec".
295
296 # appendfsync always
297 appendfsync everysec
298 # appendfsync no
299
300 # When the AOF fsync policy is set to always or everysec, and a background
301 # saving process (a background save or AOF log background rewriting) is
302 # performing a lot of I/O against the disk, in some Linux configurations
303 # Redis may block too long on the fsync() call. Note that there is no fix for
304 # this currently, as even performing fsync in a different thread will block
305 # our synchronous write(2) call.
306 #
307 # In order to mitigate this problem it's possible to use the following option
308 # that will prevent fsync() from being called in the main process while a
309 # BGSAVE or BGREWRITEAOF is in progress.
310 #
311 # This means that while another child is saving the durability of Redis is
312 # the same as "appendfsync none", that in practical terms means that it is
313 # possible to lost up to 30 seconds of log in the worst scenario (with the
314 # default Linux settings).
315 #
316 # If you have latency problems turn this to "yes". Otherwise leave it as
317 # "no" that is the safest pick from the point of view of durability.
318 no-appendfsync-on-rewrite no
319
320 # Automatic rewrite of the append only file.
321 # Redis is able to automatically rewrite the log file implicitly calling
322 # BGREWRITEAOF when the AOF log size will growth by the specified percentage.
323 #
324 # This is how it works: Redis remembers the size of the AOF file after the
325 # latest rewrite (or if no rewrite happened since the restart, the size of
326 # the AOF at startup is used).
327 #
328 # This base size is compared to the current size. If the current size is
329 # bigger than the specified percentage, the rewrite is triggered. Also
330 # you need to specify a minimal size for the AOF file to be rewritten, this
331 # is useful to avoid rewriting the AOF file even if the percentage increase
332 # is reached but it is still pretty small.
333 #
334 # Specify a percentage of zero in order to disable the automatic AOF
335 # rewrite feature.
336
337 auto-aof-rewrite-percentage 100
338 auto-aof-rewrite-min-size 64mb
339
340 ################################ LUA SCRIPTING ###############################
341
342 # Max execution time of a Lua script in milliseconds.
343 #
344 # If the maximum execution time is reached Redis will log that a script is
345 # still in execution after the maximum allowed time and will start to
346 # reply to queries with an error.
347 #
348 # When a long running script exceed the maximum execution time only the
349 # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
350 # used to stop a script that did not yet called write commands. The second
351 # is the only way to shut down the server in the case a write commands was
352 # already issue by the script but the user don't want to wait for the natural
353 # termination of the script.
354 #
355 # Set it to 0 or a negative value for unlimited execution without warnings.
356 lua-time-limit 5000
357
358 ################################ REDIS CLUSTER ###############################
359 #
360 # Normal Redis instances can't be part of a Redis Cluster, only nodes that are
361 # started as cluster nodes can. In order to start a Redis instance as a
362 # cluster node enable the cluster support uncommenting the following:
363 #
364 # cluster-enabled yes
365
366 # Every cluster node has a cluster configuration file. This file is not
367 # intended to be edited by hand. It is created and updated by Redis nodes.
368 # Every Redis Cluster node requires a different cluster configuration file.
369 # Make sure that instances running in the same system does not have
370 # overlapping cluster configuration file names.
371 #
372 # cluster-config-file nodes-6379.conf
373
374 # In order to setup your cluster make sure to read the documentation
375 # available at http://redis.io web site.
376
377 ################################## SLOW LOG ###################################
378
379 # The Redis Slow Log is a system to log queries that exceeded a specified
380 # execution time. The execution time does not include the I/O operations
381 # like talking with the client, sending the reply and so forth,
382 # but just the time needed to actually execute the command (this is the only
383 # stage of command execution where the thread is blocked and can not serve
384 # other requests in the meantime).
385 #
386 # You can configure the slow log with two parameters: one tells Redis
387 # what is the execution time, in microseconds, to exceed in order for the
388 # command to get logged, and the other parameter is the length of the
389 # slow log. When a new command is logged the oldest one is removed from the
390 # queue of logged commands.
391
392 # The following time is expressed in microseconds, so 1000000 is equivalent
393 # to one second. Note that a negative number disables the slow log, while
394 # a value of zero forces the logging of every command.
395 slowlog-log-slower-than 10000
396
397 # There is no limit to this length. Just be aware that it will consume memory.
398 # You can reclaim memory used by the slow log with SLOWLOG RESET.
399 slowlog-max-len 1024
400
401 ############################### ADVANCED CONFIG ###############################
402
403 # Hashes are encoded in a special way (much more memory efficient) when they
404 # have at max a given number of elements, and the biggest element does not
405 # exceed a given threshold. You can configure this limits with the following
406 # configuration directives.
407 hash-max-zipmap-entries 512
408 hash-max-zipmap-value 64
409
410 # Similarly to hashes, small lists are also encoded in a special way in order
411 # to save a lot of space. The special representation is only used when
412 # you are under the following limits:
413 list-max-ziplist-entries 512
414 list-max-ziplist-value 64
415
416 # Sets have a special encoding in just one case: when a set is composed
417 # of just strings that happens to be integers in radix 10 in the range
418 # of 64 bit signed integers.
419 # The following configuration setting sets the limit in the size of the
420 # set in order to use this special memory saving encoding.
421 set-max-intset-entries 512
422
423 # Similarly to hashes and lists, sorted sets are also specially encoded in
424 # order to save a lot of space. This encoding is only used when the length and
425 # elements of a sorted set are below the following limits:
426 zset-max-ziplist-entries 128
427 zset-max-ziplist-value 64
428
429 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
430 # order to help rehashing the main Redis hash table (the one mapping top-level
431 # keys to values). The hash table implementation Redis uses (see dict.c)
432 # performs a lazy rehashing: the more operation you run into an hash table
433 # that is rehashing, the more rehashing "steps" are performed, so if the
434 # server is idle the rehashing is never complete and some more memory is used
435 # by the hash table.
436 #
437 # The default is to use this millisecond 10 times every second in order to
438 # active rehashing the main dictionaries, freeing memory when possible.
439 #
440 # If unsure:
441 # use "activerehashing no" if you have hard latency requirements and it is
442 # not a good thing in your environment that Redis can reply form time to time
443 # to queries with 2 milliseconds delay.
444 #
445 # use "activerehashing yes" if you don't have such hard requirements but
446 # want to free memory asap when possible.
447 activerehashing yes
448
449 # The client output buffer limits can be used to force disconnection of clients
450 # that are not reading data from the server fast enough for some reason (a
451 # common reason is that a Pub/Sub client can't consume messages as fast as the
452 # publisher can produce them).
453 #
454 # The limit can be set differently for the three different classes of clients:
455 #
456 # normal -> normal clients
457 # slave -> slave clients and MONITOR clients
458 # pubsub -> clients subcribed to at least one pubsub channel or pattern
459 #
460 # The syntax of every client-output-buffer-limit directive is the following:
461 #
462 # client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
463 #
464 # A client is immediately disconnected once the hard limit is reached, or if
465 # the soft limit is reached and remains reached for the specified number of
466 # seconds (continuously).
467 # So for instance if the hard limit is 32 megabytes and the soft limit is
468 # 16 megabytes / 10 seconds, the client will get disconnected immediately
469 # if the size of the output buffers reach 32 megabytes, but will also get
470 # disconnected if the client reaches 16 megabytes and continuously overcomes
471 # the limit for 10 seconds.
472 #
473 # By default normal clients are not limited because they don't receive data
474 # without asking (in a push way), but just after a request, so only
475 # asynchronous clients may create a scenario where data is requested faster
476 # than it can read.
477 #
478 # Instead there is a default limit for pubsub and slave clients, since
479 # subscribers and slaves receive data in a push fashion.
480 #
481 # Both the hard or the soft limit can be disabled just setting it to zero.
482 client-output-buffer-limit normal 0 0 0
483 client-output-buffer-limit slave 256mb 64mb 60
484 client-output-buffer-limit pubsub 32mb 8mb 60
485
486 ################################## INCLUDES ###################################
487
488 # Include one or more other config files here. This is useful if you
489 # have a standard template that goes to all Redis server but also need
490 # to customize a few per-server settings. Include files can include
491 # other files, so use this wisely.
492 #
493 # include /path/to/local.conf
494 # include /path/to/other.conf