]> git.saurik.com Git - redis.git/blob - redis.conf
Allow Pub/Sub in contexts where other commands are blocked.
[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 # By default Redis will stop accepting writes if RDB snapshots are enabled
97 # (at least one save point) and the latest background save failed.
98 # This will make the user aware (in an hard way) that data is not persisting
99 # on disk properly, otherwise chances are that no one will notice and some
100 # distater will happen.
101 #
102 # If the background saving process will start working again Redis will
103 # automatically allow writes again.
104 #
105 # However if you have setup your proper monitoring of the Redis server
106 # and persistence, you may want to disable this feature so that Redis will
107 # continue to work as usually even if there are problems with disk,
108 # permissions, and so forth.
109 stop-writes-on-bgsave-error yes
110
111 # Compress string objects using LZF when dump .rdb databases?
112 # For default that's set to 'yes' as it's almost always a win.
113 # If you want to save some CPU in the saving child set it to 'no' but
114 # the dataset will likely be bigger if you have compressible values or keys.
115 rdbcompression yes
116
117 # Since verison 5 of RDB a CRC64 checksum is placed at the end of the file.
118 # This makes the format more resistant to corruption but there is a performance
119 # hit to pay (around 10%) when saving and loading RDB files, so you can disable it
120 # for maximum performances.
121 #
122 # RDB files created with checksum disabled have a checksum of zero that will
123 # tell the loading code to skip the check.
124 rdbchecksum yes
125
126 # The filename where to dump the DB
127 dbfilename dump.rdb
128
129 # The working directory.
130 #
131 # The DB will be written inside this directory, with the filename specified
132 # above using the 'dbfilename' configuration directive.
133 #
134 # Also the Append Only File will be created inside this directory.
135 #
136 # Note that you must specify a directory here, not a file name.
137 dir ./
138
139 ################################# REPLICATION #################################
140
141 # Master-Slave replication. Use slaveof to make a Redis instance a copy of
142 # another Redis server. Note that the configuration is local to the slave
143 # so for example it is possible to configure the slave to save the DB with a
144 # different interval, or to listen to another port, and so on.
145 #
146 # slaveof <masterip> <masterport>
147
148 # If the master is password protected (using the "requirepass" configuration
149 # directive below) it is possible to tell the slave to authenticate before
150 # starting the replication synchronization process, otherwise the master will
151 # refuse the slave request.
152 #
153 # masterauth <master-password>
154
155 # When a slave lost the connection with the master, or when the replication
156 # is still in progress, the slave can act in two different ways:
157 #
158 # 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will
159 # still reply to client requests, possibly with out of date data, or the
160 # data set may just be empty if this is the first synchronization.
161 #
162 # 2) if slave-serve-stale data is set to 'no' the slave will reply with
163 # an error "SYNC with master in progress" to all the kind of commands
164 # but to INFO and SLAVEOF.
165 #
166 slave-serve-stale-data yes
167
168 # You can configure a slave instance to accept writes or not. Writing against
169 # a slave instance may be useful to store some ephemeral data (because data
170 # written on a slave will be easily deleted after resync with the master) but
171 # may also cause problems if clients are writing to it because of a
172 # misconfiguration.
173 #
174 # Since Redis 2.6 by default slaves are read-only.
175 #
176 # Note: read only slaves are not designed to be exposed to untrusted clients
177 # on the internet. It's just a protection layer against misuse of the instance.
178 # Still a read only slave exports by default all the administrative commands
179 # such as CONFIG, DEBUG, and so forth. To a limited extend you can improve
180 # security of read only slaves using 'rename-command' to shadow all the
181 # administrative / dangerous commands.
182 slave-read-only yes
183
184 # Slaves send PINGs to server in a predefined interval. It's possible to change
185 # this interval with the repl_ping_slave_period option. The default value is 10
186 # seconds.
187 #
188 # repl-ping-slave-period 10
189
190 # The following option sets a timeout for both Bulk transfer I/O timeout and
191 # master data or ping response timeout. The default value is 60 seconds.
192 #
193 # It is important to make sure that this value is greater than the value
194 # specified for repl-ping-slave-period otherwise a timeout will be detected
195 # every time there is low traffic between the master and the slave.
196 #
197 # repl-timeout 60
198
199 ################################## SECURITY ###################################
200
201 # Require clients to issue AUTH <PASSWORD> before processing any other
202 # commands. This might be useful in environments in which you do not trust
203 # others with access to the host running redis-server.
204 #
205 # This should stay commented out for backward compatibility and because most
206 # people do not need auth (e.g. they run their own servers).
207 #
208 # Warning: since Redis is pretty fast an outside user can try up to
209 # 150k passwords per second against a good box. This means that you should
210 # use a very strong password otherwise it will be very easy to break.
211 #
212 # requirepass foobared
213
214 # Command renaming.
215 #
216 # It is possible to change the name of dangerous commands in a shared
217 # environment. For instance the CONFIG command may be renamed into something
218 # of hard to guess so that it will be still available for internal-use
219 # tools but not available for general clients.
220 #
221 # Example:
222 #
223 # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
224 #
225 # It is also possible to completely kill a command renaming it into
226 # an empty string:
227 #
228 # rename-command CONFIG ""
229
230 ################################### LIMITS ####################################
231
232 # Set the max number of connected clients at the same time. By default
233 # this limit is set to 10000 clients, however if the Redis server is not
234 # able ot configure the process file limit to allow for the specified limit
235 # the max number of allowed clients is set to the current file limit
236 # minus 32 (as Redis reserves a few file descriptors for internal uses).
237 #
238 # Once the limit is reached Redis will close all the new connections sending
239 # an error 'max number of clients reached'.
240 #
241 # maxclients 10000
242
243 # Don't use more memory than the specified amount of bytes.
244 # When the memory limit is reached Redis will try to remove keys
245 # accordingly to the eviction policy selected (see maxmemmory-policy).
246 #
247 # If Redis can't remove keys according to the policy, or if the policy is
248 # set to 'noeviction', Redis will start to reply with errors to commands
249 # that would use more memory, like SET, LPUSH, and so on, and will continue
250 # to reply to read-only commands like GET.
251 #
252 # This option is usually useful when using Redis as an LRU cache, or to set
253 # an hard memory limit for an instance (using the 'noeviction' policy).
254 #
255 # WARNING: If you have slaves attached to an instance with maxmemory on,
256 # the size of the output buffers needed to feed the slaves are subtracted
257 # from the used memory count, so that network problems / resyncs will
258 # not trigger a loop where keys are evicted, and in turn the output
259 # buffer of slaves is full with DELs of keys evicted triggering the deletion
260 # of more keys, and so forth until the database is completely emptied.
261 #
262 # In short... if you have slaves attached it is suggested that you set a lower
263 # limit for maxmemory so that there is some free RAM on the system for slave
264 # output buffers (but this is not needed if the policy is 'noeviction').
265 #
266 # maxmemory <bytes>
267
268 # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
269 # is reached? You can select among five behavior:
270 #
271 # volatile-lru -> remove the key with an expire set using an LRU algorithm
272 # allkeys-lru -> remove any key accordingly to the LRU algorithm
273 # volatile-random -> remove a random key with an expire set
274 # allkeys-random -> remove a random key, any key
275 # volatile-ttl -> remove the key with the nearest expire time (minor TTL)
276 # noeviction -> don't expire at all, just return an error on write operations
277 #
278 # Note: with all the kind of policies, Redis will return an error on write
279 # operations, when there are not suitable keys for eviction.
280 #
281 # At the date of writing this commands are: set setnx setex append
282 # incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd
283 # sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby
284 # zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby
285 # getset mset msetnx exec sort
286 #
287 # The default is:
288 #
289 # maxmemory-policy volatile-lru
290
291 # LRU and minimal TTL algorithms are not precise algorithms but approximated
292 # algorithms (in order to save memory), so you can select as well the sample
293 # size to check. For instance for default Redis will check three keys and
294 # pick the one that was used less recently, you can change the sample size
295 # using the following configuration directive.
296 #
297 # maxmemory-samples 3
298
299 ############################## APPEND ONLY MODE ###############################
300
301 # By default Redis asynchronously dumps the dataset on disk. This mode is
302 # good enough in many applications, but an issue with the Redis process or
303 # a power outage may result into a few minutes of writes lost (depending on
304 # the configured save points).
305 #
306 # The Append Only File is an alternative persistence mode that provides
307 # much better durability. For instance using the default data fsync policy
308 # (see later in the config file) Redis can lose just one second of writes in a
309 # dramatic event like a server power outage, or a single write if something
310 # wrong with the Redis process itself happens, but the operating system is
311 # still running correctly.
312 #
313 # AOF and RDB persistence can be enabled at the same time without problems.
314 # If the AOF is enabled on startup Redis will load the AOF, that is the file
315 # with the better durability guarantees.
316 #
317 # Please check http://redis.io/topics/persistence for more information.
318
319 appendonly no
320
321 # The name of the append only file (default: "appendonly.aof")
322 # appendfilename appendonly.aof
323
324 # The fsync() call tells the Operating System to actually write data on disk
325 # instead to wait for more data in the output buffer. Some OS will really flush
326 # data on disk, some other OS will just try to do it ASAP.
327 #
328 # Redis supports three different modes:
329 #
330 # no: don't fsync, just let the OS flush the data when it wants. Faster.
331 # always: fsync after every write to the append only log . Slow, Safest.
332 # everysec: fsync only one time every second. Compromise.
333 #
334 # The default is "everysec" that's usually the right compromise between
335 # speed and data safety. It's up to you to understand if you can relax this to
336 # "no" that will let the operating system flush the output buffer when
337 # it wants, for better performances (but if you can live with the idea of
338 # some data loss consider the default persistence mode that's snapshotting),
339 # or on the contrary, use "always" that's very slow but a bit safer than
340 # everysec.
341 #
342 # More details please check the following article:
343 # http://antirez.com/post/redis-persistence-demystified.html
344 #
345 # If unsure, use "everysec".
346
347 # appendfsync always
348 appendfsync everysec
349 # appendfsync no
350
351 # When the AOF fsync policy is set to always or everysec, and a background
352 # saving process (a background save or AOF log background rewriting) is
353 # performing a lot of I/O against the disk, in some Linux configurations
354 # Redis may block too long on the fsync() call. Note that there is no fix for
355 # this currently, as even performing fsync in a different thread will block
356 # our synchronous write(2) call.
357 #
358 # In order to mitigate this problem it's possible to use the following option
359 # that will prevent fsync() from being called in the main process while a
360 # BGSAVE or BGREWRITEAOF is in progress.
361 #
362 # This means that while another child is saving the durability of Redis is
363 # the same as "appendfsync none", that in practical terms means that it is
364 # possible to lost up to 30 seconds of log in the worst scenario (with the
365 # default Linux settings).
366 #
367 # If you have latency problems turn this to "yes". Otherwise leave it as
368 # "no" that is the safest pick from the point of view of durability.
369 no-appendfsync-on-rewrite no
370
371 # Automatic rewrite of the append only file.
372 # Redis is able to automatically rewrite the log file implicitly calling
373 # BGREWRITEAOF when the AOF log size will growth by the specified percentage.
374 #
375 # This is how it works: Redis remembers the size of the AOF file after the
376 # latest rewrite (or if no rewrite happened since the restart, the size of
377 # the AOF at startup is used).
378 #
379 # This base size is compared to the current size. If the current size is
380 # bigger than the specified percentage, the rewrite is triggered. Also
381 # you need to specify a minimal size for the AOF file to be rewritten, this
382 # is useful to avoid rewriting the AOF file even if the percentage increase
383 # is reached but it is still pretty small.
384 #
385 # Specify a percentage of zero in order to disable the automatic AOF
386 # rewrite feature.
387
388 auto-aof-rewrite-percentage 100
389 auto-aof-rewrite-min-size 64mb
390
391 ################################ LUA SCRIPTING ###############################
392
393 # Max execution time of a Lua script in milliseconds.
394 #
395 # If the maximum execution time is reached Redis will log that a script is
396 # still in execution after the maximum allowed time and will start to
397 # reply to queries with an error.
398 #
399 # When a long running script exceed the maximum execution time only the
400 # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
401 # used to stop a script that did not yet called write commands. The second
402 # is the only way to shut down the server in the case a write commands was
403 # already issue by the script but the user don't want to wait for the natural
404 # termination of the script.
405 #
406 # Set it to 0 or a negative value for unlimited execution without warnings.
407 lua-time-limit 5000
408
409 ################################## SLOW LOG ###################################
410
411 # The Redis Slow Log is a system to log queries that exceeded a specified
412 # execution time. The execution time does not include the I/O operations
413 # like talking with the client, sending the reply and so forth,
414 # but just the time needed to actually execute the command (this is the only
415 # stage of command execution where the thread is blocked and can not serve
416 # other requests in the meantime).
417 #
418 # You can configure the slow log with two parameters: one tells Redis
419 # what is the execution time, in microseconds, to exceed in order for the
420 # command to get logged, and the other parameter is the length of the
421 # slow log. When a new command is logged the oldest one is removed from the
422 # queue of logged commands.
423
424 # The following time is expressed in microseconds, so 1000000 is equivalent
425 # to one second. Note that a negative number disables the slow log, while
426 # a value of zero forces the logging of every command.
427 slowlog-log-slower-than 10000
428
429 # There is no limit to this length. Just be aware that it will consume memory.
430 # You can reclaim memory used by the slow log with SLOWLOG RESET.
431 slowlog-max-len 128
432
433 ############################### ADVANCED CONFIG ###############################
434
435 # Hashes are encoded using a memory efficient data structure when they have a
436 # small number of entries, and the biggest entry does not exceed a given
437 # threshold. These thresholds can be configured using the following directives.
438 hash-max-ziplist-entries 512
439 hash-max-ziplist-value 64
440
441 # Similarly to hashes, small lists are also encoded in a special way in order
442 # to save a lot of space. The special representation is only used when
443 # you are under the following limits:
444 list-max-ziplist-entries 512
445 list-max-ziplist-value 64
446
447 # Sets have a special encoding in just one case: when a set is composed
448 # of just strings that happens to be integers in radix 10 in the range
449 # of 64 bit signed integers.
450 # The following configuration setting sets the limit in the size of the
451 # set in order to use this special memory saving encoding.
452 set-max-intset-entries 512
453
454 # Similarly to hashes and lists, sorted sets are also specially encoded in
455 # order to save a lot of space. This encoding is only used when the length and
456 # elements of a sorted set are below the following limits:
457 zset-max-ziplist-entries 128
458 zset-max-ziplist-value 64
459
460 # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
461 # order to help rehashing the main Redis hash table (the one mapping top-level
462 # keys to values). The hash table implementation Redis uses (see dict.c)
463 # performs a lazy rehashing: the more operation you run into an hash table
464 # that is rehashing, the more rehashing "steps" are performed, so if the
465 # server is idle the rehashing is never complete and some more memory is used
466 # by the hash table.
467 #
468 # The default is to use this millisecond 10 times every second in order to
469 # active rehashing the main dictionaries, freeing memory when possible.
470 #
471 # If unsure:
472 # use "activerehashing no" if you have hard latency requirements and it is
473 # not a good thing in your environment that Redis can reply form time to time
474 # to queries with 2 milliseconds delay.
475 #
476 # use "activerehashing yes" if you don't have such hard requirements but
477 # want to free memory asap when possible.
478 activerehashing yes
479
480 # The client output buffer limits can be used to force disconnection of clients
481 # that are not reading data from the server fast enough for some reason (a
482 # common reason is that a Pub/Sub client can't consume messages as fast as the
483 # publisher can produce them).
484 #
485 # The limit can be set differently for the three different classes of clients:
486 #
487 # normal -> normal clients
488 # slave -> slave clients and MONITOR clients
489 # pubsub -> clients subcribed to at least one pubsub channel or pattern
490 #
491 # The syntax of every client-output-buffer-limit directive is the following:
492 #
493 # client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
494 #
495 # A client is immediately disconnected once the hard limit is reached, or if
496 # the soft limit is reached and remains reached for the specified number of
497 # seconds (continuously).
498 # So for instance if the hard limit is 32 megabytes and the soft limit is
499 # 16 megabytes / 10 seconds, the client will get disconnected immediately
500 # if the size of the output buffers reach 32 megabytes, but will also get
501 # disconnected if the client reaches 16 megabytes and continuously overcomes
502 # the limit for 10 seconds.
503 #
504 # By default normal clients are not limited because they don't receive data
505 # without asking (in a push way), but just after a request, so only
506 # asynchronous clients may create a scenario where data is requested faster
507 # than it can read.
508 #
509 # Instead there is a default limit for pubsub and slave clients, since
510 # subscribers and slaves receive data in a push fashion.
511 #
512 # Both the hard or the soft limit can be disabled just setting it to zero.
513 client-output-buffer-limit normal 0 0 0
514 client-output-buffer-limit slave 256mb 64mb 60
515 client-output-buffer-limit pubsub 32mb 8mb 60
516
517 ################################## INCLUDES ###################################
518
519 # Include one or more other config files here. This is useful if you
520 # have a standard template that goes to all Redis server but also need
521 # to customize a few per-server settings. Include files can include
522 # other files, so use this wisely.
523 #
524 # include /path/to/local.conf
525 # include /path/to/other.conf