]> git.saurik.com Git - redis.git/blame - redis.conf
redis-cli --bigkeys output modified to be simpler to read..
[redis.git] / redis.conf
CommitLineData
ed9b544e 1# Redis configuration file example
2
57c0cf8b 3# Note on units: when memory size is needed, it is possible to specify
72324005 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
ed9b544e 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.
17daemonize no
18
029245fe 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.
ed329fcf
LH
21pidfile /var/run/redis.pid
22
a5639e7d 23# Accept connections on the specified port, default is 6379.
68d6345d 24# If port 0 is specified Redis will not listen on a TCP socket.
ed9b544e 25port 6379
26
27# If you want you can bind a single interface, if the bind option is not
029245fe 28# specified all the interfaces will listen for incoming connections.
ed9b544e 29#
30# bind 127.0.0.1
31
5d10923f
PN
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.
a5639e7d 35#
5d10923f 36# unixsocket /tmp/redis.sock
85238765 37# unixsocketperm 755
a5639e7d 38
0150db36 39# Close the connection after a client is idle for N seconds (0 to disable)
aba4adb7 40timeout 0
ed9b544e 41
121f70cf 42# Set server verbosity to 'debug'
43# it can be one of:
44# debug (a lot of information, useful for development/testing)
38aba9a1 45# verbose (many rarely useful info, but not a mess like the debug level)
121f70cf 46# notice (moderately verbose, what you want in production probably)
47# warning (only very important / critical messages are logged)
c6f9ee88 48loglevel notice
121f70cf 49
50# Specify the log file name. Also 'stdout' can be used to force
029245fe 51# Redis to log on the standard output. Note that if you use standard
121f70cf 52# output for logging but daemonize, logs will be sent to /dev/null
53logfile stdout
54
e1a586ee
JH
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
121f70cf 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
68databases 16
69
70################################ SNAPSHOTTING #################################
71#
ed9b544e 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
e7546c63 83#
84# Note: you can disable saving at all commenting all the "save" lines.
4aac3ff2 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 ""
e7546c63 91
38aba9a1 92save 900 1
93save 300 10
94save 60 10000
ed9b544e 95
4d3bbf35 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.
109stop-writes-on-bgsave-error yes
110
121f70cf 111# Compress string objects using LZF when dump .rdb databases?
b0553789 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.
115rdbcompression yes
121f70cf 116
84bcd3aa 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.
124rdbchecksum yes
125
b8b553c8 126# The filename where to dump the DB
127dbfilename dump.rdb
128
029245fe 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.
ed9b544e 137dir ./
138
ed9b544e 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.
3f477979 145#
ed9b544e 146# slaveof <masterip> <masterport>
147
3f477979 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
4ebfc455 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
92a157ea 159# still reply to client requests, possibly with out of date data, or the
4ebfc455 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#
166slave-serve-stale-data yes
167
f3fd419f 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
ba864e09 171# may also cause problems if clients are writing to it because of a
172# misconfiguration.
f3fd419f 173#
174# Since Redis 2.6 by default slaves are read-only.
ba864e09 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.
f3fd419f 182slave-read-only yes
183
8996bf77 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#
f15e33a8 188# repl-ping-slave-period 10
8996bf77 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#
85ccd576 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#
f15e33a8 197# repl-timeout 60
8996bf77 198
f2aa84bd 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).
1b677732 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.
3f477979 211#
290deb8b 212# requirepass foobared
f2aa84bd 213
8d3e063a 214# Command renaming.
215#
57c0cf8b 216# It is possible to change the name of dangerous commands in a shared
8d3e063a 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#
57c0cf8b 225# It is also possible to completely kill a command renaming it into
8d3e063a 226# an empty string:
227#
228# rename-command CONFIG ""
229
285add55 230################################### LIMITS ####################################
231
58732c23 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#
285add55 238# Once the limit is reached Redis will close all the new connections sending
239# an error 'max number of clients reached'.
3f477979 240#
58732c23 241# maxclients 10000
285add55 242
3fd78bcd 243# Don't use more memory than the specified amount of bytes.
cebb7b92 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.
3f477979 261#
f9ef912c 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#
3fd78bcd 266# maxmemory <bytes>
267
165346ca 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
96e9f8d5 274# allkeys-random -> remove a random key, any key
165346ca 275# volatile-ttl -> remove the key with the nearest expire time (minor TTL)
5402c426 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:
165346ca 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#
a3687929 297# maxmemory-samples 3
165346ca 298
44b38ef4 299############################## APPEND ONLY MODE ###############################
300
301# By default Redis asynchronously dumps the dataset on disk. If you can live
302# with the idea that the latest records will be lost if something like a crash
303# happens this is the preferred way to run Redis. If instead you care a lot
304# about your data and don't want to that a single record can get lost you should
305# enable the append only mode: when this mode is enabled Redis will append
4005fef1 306# every write operation received in the file appendonly.aof. This file will
44b38ef4 307# be read on startup in order to rebuild the full dataset in memory.
308#
309# Note that you can have both the async dumps and the append only file if you
310# like (you have to comment the "save" statements above to disable the dumps).
311# Still if append only mode is enabled Redis will load the data from the
312# log file at startup ignoring the dump.rdb file.
0154acdc 313#
49b99ab4 314# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
315# log file in background when it gets too big.
44b38ef4 316
4e141d5a 317appendonly no
44b38ef4 318
f3b52411
PN
319# The name of the append only file (default: "appendonly.aof")
320# appendfilename appendonly.aof
321
4e141d5a 322# The fsync() call tells the Operating System to actually write data on disk
48f0308a 323# instead to wait for more data in the output buffer. Some OS will really flush
324# data on disk, some other OS will just try to do it ASAP.
325#
326# Redis supports three different modes:
327#
328# no: don't fsync, just let the OS flush the data when it wants. Faster.
329# always: fsync after every write to the append only log . Slow, Safest.
330# everysec: fsync only if one second passed since the last fsync. Compromise.
331#
6766f45e 332# The default is "everysec" that's usually the right compromise between
333# speed and data safety. It's up to you to understand if you can relax this to
ce6628da 334# "no" that will let the operating system flush the output buffer when
6766f45e 335# it wants, for better performances (but if you can live with the idea of
336# some data loss consider the default persistence mode that's snapshotting),
337# or on the contrary, use "always" that's very slow but a bit safer than
338# everysec.
339#
340# If unsure, use "everysec".
341
342# appendfsync always
343appendfsync everysec
4e141d5a 344# appendfsync no
48f0308a 345
d5d23dab 346# When the AOF fsync policy is set to always or everysec, and a background
347# saving process (a background save or AOF log background rewriting) is
348# performing a lot of I/O against the disk, in some Linux configurations
349# Redis may block too long on the fsync() call. Note that there is no fix for
350# this currently, as even performing fsync in a different thread will block
351# our synchronous write(2) call.
352#
353# In order to mitigate this problem it's possible to use the following option
354# that will prevent fsync() from being called in the main process while a
355# BGSAVE or BGREWRITEAOF is in progress.
356#
357# This means that while another child is saving the durability of Redis is
57c0cf8b 358# the same as "appendfsync none", that in practical terms means that it is
d5d23dab 359# possible to lost up to 30 seconds of log in the worst scenario (with the
360# default Linux settings).
361#
362# If you have latency problems turn this to "yes". Otherwise leave it as
363# "no" that is the safest pick from the point of view of durability.
364no-appendfsync-on-rewrite no
365
b333e239 366# Automatic rewrite of the append only file.
367# Redis is able to automatically rewrite the log file implicitly calling
368# BGREWRITEAOF when the AOF log size will growth by the specified percentage.
369#
370# This is how it works: Redis remembers the size of the AOF file after the
371# latest rewrite (or if no rewrite happened since the restart, the size of
372# the AOF at startup is used).
373#
374# This base size is compared to the current size. If the current size is
375# bigger than the specified percentage, the rewrite is triggered. Also
376# you need to specify a minimal size for the AOF file to be rewritten, this
377# is useful to avoid rewriting the AOF file even if the percentage increase
378# is reached but it is still pretty small.
379#
57c0cf8b 380# Specify a percentage of zero in order to disable the automatic AOF
b333e239 381# rewrite feature.
382
383auto-aof-rewrite-percentage 100
384auto-aof-rewrite-min-size 64mb
385
eeffcf38 386################################ LUA SCRIPTING ###############################
387
388# Max execution time of a Lua script in milliseconds.
115e3ff3 389#
390# If the maximum execution time is reached Redis will log that a script is
57c0cf8b 391# still in execution after the maximum allowed time and will start to
115e3ff3 392# reply to queries with an error.
393#
57c0cf8b 394# When a long running script exceed the maximum execution time only the
0b14e441 395# SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
396# used to stop a script that did not yet called write commands. The second
397# is the only way to shut down the server in the case a write commands was
398# already issue by the script but the user don't want to wait for the natural
399# termination of the script.
115e3ff3 400#
401# Set it to 0 or a negative value for unlimited execution without warnings.
402lua-time-limit 5000
eeffcf38 403
07c152a7 404################################ REDIS CLUSTER ###############################
405#
406# Normal Redis instances can't be part of a Redis Cluster, only nodes that are
407# started as cluster nodes can. In order to start a Redis instance as a
408# cluster node enable the cluster support uncommenting the following:
409#
410# cluster-enabled yes
411
412# Every cluster node has a cluster configuration file. This file is not
413# intended to be edited by hand. It is created and updated by Redis nodes.
414# Every Redis Cluster node requires a different cluster configuration file.
415# Make sure that instances running in the same system does not have
416# overlapping cluster configuration file names.
417#
418# cluster-config-file nodes-6379.conf
419
420# In order to setup your cluster make sure to read the documentation
421# available at http://redis.io web site.
422
35a60441 423################################## SLOW LOG ###################################
424
425# The Redis Slow Log is a system to log queries that exceeded a specified
426# execution time. The execution time does not include the I/O operations
427# like talking with the client, sending the reply and so forth,
428# but just the time needed to actually execute the command (this is the only
429# stage of command execution where the thread is blocked and can not serve
430# other requests in the meantime).
431#
432# You can configure the slow log with two parameters: one tells Redis
433# what is the execution time, in microseconds, to exceed in order for the
434# command to get logged, and the other parameter is the length of the
435# slow log. When a new command is logged the oldest one is removed from the
436# queue of logged commands.
437
de32c37c 438# The following time is expressed in microseconds, so 1000000 is equivalent
439# to one second. Note that a negative number disables the slow log, while
440# a value of zero forces the logging of every command.
35a60441 441slowlog-log-slower-than 10000
de32c37c 442
443# There is no limit to this length. Just be aware that it will consume memory.
444# You can reclaim memory used by the slow log with SLOWLOG RESET.
208092ad 445slowlog-max-len 1024
35a60441 446
ed9b544e 447############################### ADVANCED CONFIG ###############################
448
d3ea4c86
PN
449# Hashes are encoded using a memory efficient data structure when they have a
450# small number of entries, and the biggest entry does not exceed a given
451# threshold. These thresholds can be configured using the following directives.
452hash-max-ziplist-entries 512
453hash-max-ziplist-value 64
b3f83f12 454
6a246b1e 455# Similarly to hashes, small lists are also encoded in a special way in order
456# to save a lot of space. The special representation is only used when
457# you are under the following limits:
458list-max-ziplist-entries 512
459list-max-ziplist-value 64
460
461# Sets have a special encoding in just one case: when a set is composed
462# of just strings that happens to be integers in radix 10 in the range
463# of 64 bit signed integers.
464# The following configuration setting sets the limit in the size of the
465# set in order to use this special memory saving encoding.
466set-max-intset-entries 512
467
3ea204e1
PN
468# Similarly to hashes and lists, sorted sets are also specially encoded in
469# order to save a lot of space. This encoding is only used when the length and
470# elements of a sorted set are below the following limits:
471zset-max-ziplist-entries 128
472zset-max-ziplist-value 64
473
8ca3e9d1 474# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
475# order to help rehashing the main Redis hash table (the one mapping top-level
57c0cf8b 476# keys to values). The hash table implementation Redis uses (see dict.c)
8ca3e9d1 477# performs a lazy rehashing: the more operation you run into an hash table
57c0cf8b 478# that is rehashing, the more rehashing "steps" are performed, so if the
8ca3e9d1 479# server is idle the rehashing is never complete and some more memory is used
480# by the hash table.
481#
482# The default is to use this millisecond 10 times every second in order to
483# active rehashing the main dictionaries, freeing memory when possible.
484#
485# If unsure:
486# use "activerehashing no" if you have hard latency requirements and it is
487# not a good thing in your environment that Redis can reply form time to time
488# to queries with 2 milliseconds delay.
489#
490# use "activerehashing yes" if you don't have such hard requirements but
491# want to free memory asap when possible.
492activerehashing yes
493
c8a607f2 494# The client output buffer limits can be used to force disconnection of clients
495# that are not reading data from the server fast enough for some reason (a
496# common reason is that a Pub/Sub client can't consume messages as fast as the
497# publisher can produce them).
498#
499# The limit can be set differently for the three different classes of clients:
500#
501# normal -> normal clients
502# slave -> slave clients and MONITOR clients
503# pubsub -> clients subcribed to at least one pubsub channel or pattern
504#
505# The syntax of every client-output-buffer-limit directive is the following:
506#
3cbce4f4 507# client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
c8a607f2 508#
509# A client is immediately disconnected once the hard limit is reached, or if
510# the soft limit is reached and remains reached for the specified number of
511# seconds (continuously).
512# So for instance if the hard limit is 32 megabytes and the soft limit is
513# 16 megabytes / 10 seconds, the client will get disconnected immediately
514# if the size of the output buffers reach 32 megabytes, but will also get
515# disconnected if the client reaches 16 megabytes and continuously overcomes
516# the limit for 10 seconds.
517#
518# By default normal clients are not limited because they don't receive data
519# without asking (in a push way), but just after a request, so only
520# asynchronous clients may create a scenario where data is requested faster
521# than it can read.
522#
523# Instead there is a default limit for pubsub and slave clients, since
524# subscribers and slaves receive data in a push fashion.
525#
526# Both the hard or the soft limit can be disabled just setting it to zero.
527client-output-buffer-limit normal 0 0 0
528client-output-buffer-limit slave 256mb 64mb 60
529client-output-buffer-limit pubsub 32mb 8mb 60
530
b3f83f12
JZ
531################################## INCLUDES ###################################
532
533# Include one or more other config files here. This is useful if you
57c0cf8b 534# have a standard template that goes to all Redis server but also need
b3f83f12
JZ
535# to customize a few per-server settings. Include files can include
536# other files, so use this wisely.
537#
538# include /path/to/local.conf
539# include /path/to/other.conf